Method | Description | |
---|---|---|
AllowUserKeys ( bool value ) : |
Determines whether it is allowed to supply custom key values in the _key attribute of a document. Default value: true.
|
|
ChangeProperties ( string collectionName ) : object>>.AResult |
Changes properties of specified collection.
|
|
Count ( bool value ) : |
Determines whether the return value should include the number of documents in collection. Default value: true.
|
|
Create ( string collectionName ) : object>>.AResult |
Creates new collection in current database context.
|
|
Delete ( string collectionName ) : object>>.AResult |
Deletes specified collection.
|
|
DoCompact ( bool value ) : |
Determines whether the collection will be compacted. Default value: true.
|
|
Get ( string collectionName ) : object>>.AResult |
Retrieves basic information about specified collection.
|
|
GetAllIndexes ( string collectionName ) : object>>.AResult |
Retrieves list of indexes in specified collection.
|
|
GetChecksum ( string collectionName ) : object>>.AResult |
Retrieves basic information, revision ID and checksum of specified collection.
|
|
GetCount ( string collectionName ) : object>>.AResult |
Retrieves basic information with additional properties and document count in specified collection.
|
|
GetFigures ( string collectionName ) : object>>.AResult |
Retrieves basic information with additional properties, document count and figures in specified collection.
|
|
GetProperties ( string collectionName ) : object>>.AResult |
Retrieves basic information with additional properties about specified collection.
|
|
GetRevision ( string collectionName ) : object>>.AResult |
Retrieves basic information and revision ID of specified collection.
|
|
IsSystem ( bool value ) : |
Determines whether the collection is a system collection. Default value: false.
|
|
IsVolatile ( bool value ) : |
Determines whether the collection data is kept in-memory only and not made persistent. Default value: false.
|
|
JournalSize ( long value ) : |
Determines maximum size of a journal or datafile in bytes. Default value: server configured.
|
|
KeyGeneratorType ( AKeyGeneratorType value ) : |
Determines the type of the key generator. Default value: Traditional.
|
|
KeyIncrement ( long value ) : |
Determines increment value for autoincrement key generator.
|
|
KeyOffset ( long value ) : |
Determines initial offset value for autoincrement key generator.
|
|
Load ( string collectionName ) : object>>.AResult |
Loads specified collection into memory.
|
|
NumberOfShards ( int value ) : |
Determines the number of shards to create for the collection in cluster environment. Default value: 1.
|
|
Rename ( string collectionName, string newCollectionName ) : object>>.AResult |
Renames specified collection.
|
|
ReturnListType ( AReturnListType value ) : |
Determines which attribute will be retuned in the list. Default value: Path.
|
|
RotateJournal ( string collectionName ) : AResult |
Rotates the journal of specified collection to make the data in the file available for compaction. Current journal of the collection will be closed and turned into read-only datafile. This operation is not available in cluster environment.
|
|
ShardKeys ( List |
Determines which document attributes are used to specify the target shard for documents in cluster environment. Default value: ["_key"].
|
|
Truncate ( string collectionName ) : object>>.AResult |
Removes all documents from specified collection.
|
|
Type ( ACollectionType value ) : |
Determines type of the collection. Default value: Document.
|
|
Unload ( string collectionName ) : object>>.AResult |
Unloads specified collection from memory.
|
|
WaitForSync ( bool value ) : |
Determines whether or not to wait until data are synchronised to disk. Default value: false.
|
|
WithData ( bool value ) : |
Determines whether to include document body data in the checksum calculation. Default value: false.
|
|
WithRevisions ( bool value ) : |
Determines whether to include document revision ids in the checksum calculation. Default value: false.
|
Method | Description | |
---|---|---|
ACollection ( |
public AllowUserKeys ( bool value ) : |
||
value | bool | |
return |
public ChangeProperties ( string collectionName ) : object>>.AResult |
||
collectionName | string | |
return | object>>.AResult |
public Create ( string collectionName ) : object>>.AResult |
||
collectionName | string | |
return | object>>.AResult |
public Delete ( string collectionName ) : object>>.AResult |
||
collectionName | string | |
return | object>>.AResult |
public DoCompact ( bool value ) : |
||
value | bool | |
return |
public Get ( string collectionName ) : object>>.AResult |
||
collectionName | string | |
return | object>>.AResult |
public GetAllIndexes ( string collectionName ) : object>>.AResult |
||
collectionName | string | |
return | object>>.AResult |
public GetChecksum ( string collectionName ) : object>>.AResult |
||
collectionName | string | |
return | object>>.AResult |
public GetCount ( string collectionName ) : object>>.AResult |
||
collectionName | string | |
return | object>>.AResult |
public GetFigures ( string collectionName ) : object>>.AResult |
||
collectionName | string | |
return | object>>.AResult |
public GetProperties ( string collectionName ) : object>>.AResult |
||
collectionName | string | |
return | object>>.AResult |
public GetRevision ( string collectionName ) : object>>.AResult |
||
collectionName | string | |
return | object>>.AResult |
public IsVolatile ( bool value ) : |
||
value | bool | |
return |
public JournalSize ( long value ) : |
||
value | long | |
return |
public KeyGeneratorType ( AKeyGeneratorType value ) : |
||
value | AKeyGeneratorType | |
return |
public KeyIncrement ( long value ) : |
||
value | long | |
return |
public KeyOffset ( long value ) : |
||
value | long | |
return |
public Load ( string collectionName ) : object>>.AResult |
||
collectionName | string | |
return | object>>.AResult |
public NumberOfShards ( int value ) : |
||
value | int | |
return |
public Rename ( string collectionName, string newCollectionName ) : object>>.AResult |
||
collectionName | string | |
newCollectionName | string | |
return | object>>.AResult |
public ReturnListType ( AReturnListType value ) : |
||
value | AReturnListType | |
return |
public RotateJournal ( string collectionName ) : AResult |
||
collectionName | string | |
return | AResult |
public ShardKeys ( List |
||
value | List |
|
return |
public Truncate ( string collectionName ) : object>>.AResult |
||
collectionName | string | |
return | object>>.AResult |
public Type ( ACollectionType value ) : |
||
value | ACollectionType | |
return |
public Unload ( string collectionName ) : object>>.AResult |
||
collectionName | string | |
return | object>>.AResult |
public WaitForSync ( bool value ) : |
||
value | bool | |
return |
public WithRevisions ( bool value ) : |
||
value | bool | |
return |