DatabaseCollection (PretronicDatabaseQuery 1.1.0.24 API)

All Known Subinterfaces:

AliasDatabaseCollection

All Known Implementing Classes:

AbstractDatabaseCollection, MongoDBDatabaseCollection, SQLDatabaseCollection
```
public interface DatabaseCollection
```
The DatabaseCollection

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`CollectionField`	`addField(String name)`	Adds a new field to this `DatabaseCollection` with the name `name`.
`AliasDatabaseCollection`	`as(String alias)`	Gets this `DatabaseCollection` with an alias name.
`void`	`clear()`	Clear all data in this `DatabaseCollection`.
`CompletableFuture<Void>`	`clearAsync()`	Clear all data in this `DatabaseCollection` async.
`DeleteQuery`	`delete()`	Returns a `DeleteQuery` to delete data in this `DatabaseCollection`.
`void`	`drop()`	Drops this `DatabaseCollection`.
`CompletableFuture<Void>`	`dropAsync()`	Drops this `DatabaseCollection` async.
`FindQuery`	`find()`	Returns a `FindQuery` to specify conditions to find data on this `DatabaseCollection`
`Database`	`getDatabase()`	Returns the `Database` on which this `DatabaseCollection` is hold.
`CollectionField`	`getField(String name)`	Get a specific field by `name`.
`CompletableFuture<CollectionField>`	`getFieldAsync(String name)`	Returns `getField(String)` async.
`Collection<CollectionField>`	`getFields()`	Returns all database collection fields with his information.
`CompletableFuture<Collection<CollectionField>>`	`getFieldsAsync()`	Returns `getFields()` async.
`String`	`getName()`	Returns the name of this database collection.
`long`	`getSize()`	Returns the size of data in this `DatabaseCollection`.
`CompletableFuture<Long>`	`getSizeAsync()`	Returns the size of the `DatabaseCollection` async.
`DatabaseCollectionType`	`getType()`	Returns the `DatabaseCollectionType` of this database collection type.
`QueryGroup`	`group()`	Returns a new `QueryGroup`.
`boolean`	`hasField(String name)`	Check if a field with the name `name` exists in this `DatabaseCollection`.
`CompletableFuture<Boolean>`	`hasFieldAsync(String name)`	Returns `hasField(String)` async.
`InsertQuery`	`insert()`	Returns a `InsertQuery` to insert new data in this `DatabaseCollection`.
`ReplaceQuery`	`replace()`	Returns a `ReplaceQuery` to replace a data in this `DatabaseCollection`.
`QueryTransaction`	`transact()`	Creates a new `QueryTransaction` on this database collection.
`UpdateQuery`	`update()`	Returns a `UpdateQuery` to update data in this `DatabaseCollection` with a specified conditions.

- Method Detail
  - getName
```
String getName()
```
    Returns the name of this database collection.
    
    Returns:
    
    name
  - getDatabase
```
Database getDatabase()
```
    Returns the Database on which this DatabaseCollection is hold.
    
    Returns:
    
    database
  - getType
```
DatabaseCollectionType getType()
```
    Returns the DatabaseCollectionType of this database collection type. The type may be incorrect when retrieving and not creating this DatabaseCollection and then it's DatabaseCollectionType.NORMAL.
    
    Returns:
    
    type of collection
  - getSize
```
long getSize()
```
    Returns the size of data in this DatabaseCollection.
    
    Returns:
    
    size of database collection
  - getSizeAsync
```
CompletableFuture<Long> getSizeAsync()
```
    Returns the size of the DatabaseCollection async.
    
    Returns:
    
    completable future of size
  - insert
```
InsertQuery insert()
```
    Returns a InsertQuery to insert new data in this DatabaseCollection.
    
    Returns:
    
    insert query
  - find
```
FindQuery find()
```
    Returns a FindQuery to specify conditions to find data on this DatabaseCollection
    
    Returns:
    
    find query
  - update
```
UpdateQuery update()
```
    Returns a UpdateQuery to update data in this DatabaseCollection with a specified conditions.
    
    Returns:
    
    update query
  - replace
```
ReplaceQuery replace()
```
    Returns a ReplaceQuery to replace a data in this DatabaseCollection.
    
    Returns:
    
    replace query
  - delete
```
DeleteQuery delete()
```
    Returns a DeleteQuery to delete data in this DatabaseCollection.
    
    Returns:
    
    delete query
  - drop
```
void drop()
```
    Drops this DatabaseCollection.
  - dropAsync
```
CompletableFuture<Void> dropAsync()
```
    Drops this DatabaseCollection async.
    
    Returns:
    
    completable future if dropped
  - clear
```
void clear()
```
    Clear all data in this DatabaseCollection.
  - clearAsync
```
CompletableFuture<Void> clearAsync()
```
    Clear all data in this DatabaseCollection async.
    
    Returns:
    
    completable future if cleared
  - transact
```
QueryTransaction transact()
```
    Creates a new QueryTransaction on this database collection. For more information, see QueryTransaction.
    
    Returns:
    
    a new query transaction
  - group
```
QueryGroup group()
```
    Returns a new QueryGroup.
    
    Returns:
    
    query group
  - getFields
```
Collection<CollectionField> getFields()
```
    Returns all database collection fields with his information. In some implementations, it may not work, for example on NoSQL based databases.
    
    Returns:
    
    collection of all database collection fields
  - getFieldsAsync
```
CompletableFuture<Collection<CollectionField>> getFieldsAsync()
```
    Returns getFields() async.
    
    Returns:
    
    future of fields
  - getField
```
CollectionField getField(String name)
```
    Get a specific field by name.
    
    Parameters:
    
    name - of field
    
    Returns:
    
    the field in the database collection
  - getFieldAsync
```
CompletableFuture<CollectionField> getFieldAsync(String name)
```
    Returns getField(String) async.
    
    Parameters:
    
    name - of field
    
    Returns:
    
    the field in the database collection async
  - hasField
```
boolean hasField(String name)
```
    Check if a field with the name name exists in this DatabaseCollection.
    
    Parameters:
    
    name - of field
    
    Returns:
    
    if field exist or not
  - hasFieldAsync
```
CompletableFuture<Boolean> hasFieldAsync(String name)
```
    Returns hasField(String) async.
    
    Parameters:
    
    name - of field
    
    Returns:
    
    if field exist or not
  - addField
```
CollectionField addField(String name)
```
    Adds a new field to this DatabaseCollection with the name name.
    
    Parameters:
    
    name - of field
    
    Returns:
    
    new created collection field
  - as
```
AliasDatabaseCollection as(String alias)
```
    Gets this DatabaseCollection with an alias name. For more information, see AliasDatabaseCollection.
    
    Parameters:
    
    alias - of this collection
    
    Returns:
    
    a aliases database collection

Interface DatabaseCollection

Method Summary

Method Detail

getName

getDatabase

getType

getSize

getSizeAsync

insert

find

update

replace

delete

drop

dropAsync

clear

clearAsync

transact

group

getFields

getFieldsAsync

getField

getFieldAsync

hasField

hasFieldAsync

addField

as