C# 클래스 Arango.Client.ACollection

공개 메소드들

메소드	설명
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.

비공개 메소드들

메소드	설명
ACollection ( Connection connection ) : System.Collections.Generic

메소드 상세

AllowUserKeys() 공개 메소드

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
리턴	ACollection

ChangeProperties() 공개 메소드

Changes properties of specified collection.

public ChangeProperties ( string collectionName ) : object>>.AResult
collectionName	string
리턴	object>>.AResult

Count() 공개 메소드

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

public Count ( bool value ) : ACollection
value	bool
리턴	ACollection

Create() 공개 메소드

Creates new collection in current database context.

public Create ( string collectionName ) : object>>.AResult
collectionName	string
리턴	object>>.AResult

Delete() 공개 메소드

Deletes specified collection.

public Delete ( string collectionName ) : object>>.AResult
collectionName	string
리턴	object>>.AResult

DoCompact() 공개 메소드

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

public DoCompact ( bool value ) : ACollection
value	bool
리턴	ACollection

Get() 공개 메소드

Retrieves basic information about specified collection.

public Get ( string collectionName ) : object>>.AResult
collectionName	string
리턴	object>>.AResult

GetAllIndexes() 공개 메소드

Retrieves list of indexes in specified collection.

public GetAllIndexes ( string collectionName ) : object>>.AResult
collectionName	string
리턴	object>>.AResult

GetChecksum() 공개 메소드

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

public GetChecksum ( string collectionName ) : object>>.AResult
collectionName	string
리턴	object>>.AResult

GetCount() 공개 메소드

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

public GetCount ( string collectionName ) : object>>.AResult
collectionName	string
리턴	object>>.AResult

GetFigures() 공개 메소드

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

public GetFigures ( string collectionName ) : object>>.AResult
collectionName	string
리턴	object>>.AResult

GetProperties() 공개 메소드

Retrieves basic information with additional properties about specified collection.

public GetProperties ( string collectionName ) : object>>.AResult
collectionName	string
리턴	object>>.AResult

GetRevision() 공개 메소드

Retrieves basic information and revision ID of specified collection.

public GetRevision ( string collectionName ) : object>>.AResult
collectionName	string
리턴	object>>.AResult

IsSystem() 공개 메소드

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

public IsSystem ( bool value ) : ACollection
value	bool
리턴	ACollection

IsVolatile() 공개 메소드

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

public IsVolatile ( bool value ) : ACollection
value	bool
리턴	ACollection

JournalSize() 공개 메소드

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

public JournalSize ( long value ) : ACollection
value	long
리턴	ACollection

KeyGeneratorType() 공개 메소드

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

public KeyGeneratorType ( AKeyGeneratorType value ) : ACollection
value	AKeyGeneratorType
리턴	ACollection

KeyIncrement() 공개 메소드

Determines increment value for autoincrement key generator.

public KeyIncrement ( long value ) : ACollection
value	long
리턴	ACollection

KeyOffset() 공개 메소드

Determines initial offset value for autoincrement key generator.

public KeyOffset ( long value ) : ACollection
value	long
리턴	ACollection

Load() 공개 메소드

Loads specified collection into memory.

public Load ( string collectionName ) : object>>.AResult
collectionName	string
리턴	object>>.AResult

NumberOfShards() 공개 메소드

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

public NumberOfShards ( int value ) : ACollection
value	int
리턴	ACollection

Rename() 공개 메소드

Renames specified collection.

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

ReturnListType() 공개 메소드

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

public ReturnListType ( AReturnListType value ) : ACollection
value	AReturnListType
리턴	ACollection

RotateJournal() 공개 메소드

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
리턴	AResult

ShardKeys() 공개 메소드

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
리턴	ACollection

Truncate() 공개 메소드

Removes all documents from specified collection.

public Truncate ( string collectionName ) : object>>.AResult
collectionName	string
리턴	object>>.AResult

Type() 공개 메소드

Determines type of the collection. Default value: Document.

public Type ( ACollectionType value ) : ACollection
value	ACollectionType
리턴	ACollection

Unload() 공개 메소드

Unloads specified collection from memory.

public Unload ( string collectionName ) : object>>.AResult
collectionName	string
리턴	object>>.AResult

WaitForSync() 공개 메소드

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

public WaitForSync ( bool value ) : ACollection
value	bool
리턴	ACollection

WithData() 공개 메소드

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

public WithData ( bool value ) : ACollection
value	bool
리턴	ACollection

WithRevisions() 공개 메소드

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

public WithRevisions ( bool value ) : ACollection
value	bool
리턴	ACollection