C# Class Arango.Client.ACollection

Exibir arquivo Open project: yojimbo87/ArangoDB-NET

Public Methods

Method	Description
AllowUserKeys ( bool value ) : ACollection	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 ) : ACollection	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 ) : ACollection	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 ) : ACollection	Determines whether the collection is a system collection. Default value: false.
IsVolatile ( bool value ) : ACollection	Determines whether the collection data is kept in-memory only and not made persistent. Default value: false.
JournalSize ( long value ) : ACollection	Determines maximum size of a journal or datafile in bytes. Default value: server configured.
KeyGeneratorType ( AKeyGeneratorType value ) : ACollection	Determines the type of the key generator. Default value: Traditional.
KeyIncrement ( long value ) : ACollection	Determines increment value for autoincrement key generator.
KeyOffset ( long value ) : ACollection	Determines initial offset value for autoincrement key generator.
Load ( string collectionName ) : object>>.AResult	Loads specified collection into memory.
NumberOfShards ( int value ) : ACollection	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 ) : ACollection	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 value ) : ACollection	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 ) : ACollection	Determines type of the collection. Default value: Document.
Unload ( string collectionName ) : object>>.AResult	Unloads specified collection from memory.
WaitForSync ( bool value ) : ACollection	Determines whether or not to wait until data are synchronised to disk. Default value: false.
WithData ( bool value ) : ACollection	Determines whether to include document body data in the checksum calculation. Default value: false.
WithRevisions ( bool value ) : ACollection	Determines whether to include document revision ids in the checksum calculation. Default value: false.

Private Methods

Method	Description
ACollection ( Connection connection ) : System.Collections.Generic

Method Details

AllowUserKeys() public method

Determines whether it is allowed to supply custom key values in the _key attribute of a document. Default value: true.

public AllowUserKeys ( bool value ) : ACollection
value	bool
return	ACollection

ChangeProperties() public method

Changes properties of specified collection.

public ChangeProperties ( string collectionName ) : object>>.AResult
collectionName	string
return	object>>.AResult

Count() public method

Determines whether the return value should include the number of documents in collection. Default value: true.

public Count ( bool value ) : ACollection
value	bool
return	ACollection

Create() public method

Creates new collection in current database context.

public Create ( string collectionName ) : object>>.AResult
collectionName	string
return	object>>.AResult

Delete() public method

Deletes specified collection.

public Delete ( string collectionName ) : object>>.AResult
collectionName	string
return	object>>.AResult

DoCompact() public method

Determines whether the collection will be compacted. Default value: true.

public DoCompact ( bool value ) : ACollection
value	bool
return	ACollection

Get() public method

Retrieves basic information about specified collection.

public Get ( string collectionName ) : object>>.AResult
collectionName	string
return	object>>.AResult

GetAllIndexes() public method

Retrieves list of indexes in specified collection.

public GetAllIndexes ( string collectionName ) : object>>.AResult
collectionName	string
return	object>>.AResult

GetChecksum() public method

Retrieves basic information, revision ID and checksum of specified collection.

public GetChecksum ( string collectionName ) : object>>.AResult
collectionName	string
return	object>>.AResult

GetCount() public method

Retrieves basic information with additional properties and document count in specified collection.

public GetCount ( string collectionName ) : object>>.AResult
collectionName	string
return	object>>.AResult

GetFigures() public method

Retrieves basic information with additional properties, document count and figures in specified collection.

public GetFigures ( string collectionName ) : object>>.AResult
collectionName	string
return	object>>.AResult

GetProperties() public method

Retrieves basic information with additional properties about specified collection.

public GetProperties ( string collectionName ) : object>>.AResult
collectionName	string
return	object>>.AResult

GetRevision() public method

Retrieves basic information and revision ID of specified collection.

public GetRevision ( string collectionName ) : object>>.AResult
collectionName	string
return	object>>.AResult

IsSystem() public method

Determines whether the collection is a system collection. Default value: false.

public IsSystem ( bool value ) : ACollection
value	bool
return	ACollection

IsVolatile() public method

Determines whether the collection data is kept in-memory only and not made persistent. Default value: false.

public IsVolatile ( bool value ) : ACollection
value	bool
return	ACollection

JournalSize() public method

Determines maximum size of a journal or datafile in bytes. Default value: server configured.

public JournalSize ( long value ) : ACollection
value	long
return	ACollection

KeyGeneratorType() public method

Determines the type of the key generator. Default value: Traditional.

public KeyGeneratorType ( AKeyGeneratorType value ) : ACollection
value	AKeyGeneratorType
return	ACollection

KeyIncrement() public method

Determines increment value for autoincrement key generator.

public KeyIncrement ( long value ) : ACollection
value	long
return	ACollection

KeyOffset() public method

Determines initial offset value for autoincrement key generator.

public KeyOffset ( long value ) : ACollection
value	long
return	ACollection

Load() public method

Loads specified collection into memory.

public Load ( string collectionName ) : object>>.AResult
collectionName	string
return	object>>.AResult

NumberOfShards() public method

Determines the number of shards to create for the collection in cluster environment. Default value: 1.

public NumberOfShards ( int value ) : ACollection
value	int
return	ACollection

Rename() public method

Renames specified collection.

public Rename ( string collectionName, string newCollectionName ) : object>>.AResult
collectionName	string
newCollectionName	string
return	object>>.AResult

ReturnListType() public method

Determines which attribute will be retuned in the list. Default value: Path.

public ReturnListType ( AReturnListType value ) : ACollection
value	AReturnListType
return	ACollection

RotateJournal() public method

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.

public RotateJournal ( string collectionName ) : AResult
collectionName	string
return	AResult

ShardKeys() public method

Determines which document attributes are used to specify the target shard for documents in cluster environment. Default value: ["_key"].

public ShardKeys ( List value ) : ACollection
value	List
return	ACollection

Truncate() public method

Removes all documents from specified collection.

public Truncate ( string collectionName ) : object>>.AResult
collectionName	string
return	object>>.AResult

Type() public method

Determines type of the collection. Default value: Document.

public Type ( ACollectionType value ) : ACollection
value	ACollectionType
return	ACollection

Unload() public method

Unloads specified collection from memory.

public Unload ( string collectionName ) : object>>.AResult
collectionName	string
return	object>>.AResult

WaitForSync() public method

Determines whether or not to wait until data are synchronised to disk. Default value: false.

public WaitForSync ( bool value ) : ACollection
value	bool
return	ACollection

WithData() public method

Determines whether to include document body data in the checksum calculation. Default value: false.

public WithData ( bool value ) : ACollection
value	bool
return	ACollection

WithRevisions() public method

Determines whether to include document revision ids in the checksum calculation. Default value: false.

public WithRevisions ( bool value ) : ACollection
value	bool
return	ACollection