ArangoDB collection API
Type parameters
- F
-
effect
Attributes
- See also
- Companion
- object
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
Members list
Value members
Abstract methods
Query all documents in collection
Query all documents in collection
Attributes
- Returns
-
query
Will calculate a checksum of the meta-data (keys and optionally revision ids) and optionally the document data in the collection.
Will calculate a checksum of the meta-data (keys and optionally revision ids) and optionally the document data in the collection.
The checksum can be used to compare if two collections on different ArangoDB instances contain the same contents. The current revision of the collection is returned too so one can make sure the checksums are calculated for the same state of data.
By default, the checksum will only be calculated on the _key system attribute of the documents contained in the collection. For edge collections, the system attributes _from and _to will also be included in the calculation.
Value parameters
- withData
-
include document body data in the checksum calculation
- withRevisions
-
include document revision ids in the checksum calculation
Attributes
Create the collection
Create the collection
Value parameters
- setup
-
modify creation options
Attributes
- Returns
-
collection information
existing document api
existing document api
Attributes
documents api
documents api
Attributes
Drop collection
Drop collection
Value parameters
- isSystem
-
Whether or not the collection to drop is a system collection. This parameter must be set to true in order to drop a system collection.
Attributes
- Returns
-
identifier of the dropped collection
existing index api
existing index api
Attributes
indexes api
indexes api
Attributes
Return information about collection
Return information about collection
Attributes
- Returns
-
collection information
collection name
collection name
Attributes
Read properties of collection
Read properties of collection
Attributes
- Returns
-
collection properties
Rename collection
Rename collection
Attributes
Return collection revision id
Return collection revision id
The revision is a server-generated string that clients can use to check whether data in a collection has changed since the last revision check.
Attributes
- Returns
-
collection revision
Truncate collection
Truncate collection
Value parameters
- compact
-
If true then the storage engine is told to start a compaction in order to free up disk space. This can be resource intensive. If the only intention is to start over with an empty collection, specify false.
- waitForSync
-
If true then the data is synchronized to disk before returning from the truncate operation
Attributes
- Returns
-
collection information
Update properties of collection
Update properties of collection
Value parameters
- schema
-
Object that specifies the collection level schema for documents. The attribute keys rule, level and message must follow the rules documented in Document Schema Validation
- waitForSync
-
If true then creating or changing a document will wait until the data has been synchronized to disk
Attributes
- Returns
-
collection properties