TODO
TODO
TODO
TODO
TODO
TODO
The number of documents in this collection.
Options for dropping collections.
Whether the collection is a system collection. If the collection is a
system collection, this option must be set to true
or ArangoDB will
refuse to drop the collection.
Default: false
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
If set to true
, the import will abort if any error occurs.
Whether the response should contain additional details about documents that could not be imported.
(Edge collections only.) Prefix to prepend to _from
attribute values.
Controls behavior when a unique constraint is violated.
"error"
: the document will not be imported."update
: the document will be merged into the existing document."replace"
: the document will replace the existing document."ignore"
: the document will not be imported and the unique constraint
error will be ignored.Default: "error"
If set to true
, the collection is truncated before the data is imported.
Default: false
(Edge collections only.) Prefix to prepend to _to
attribute values.
Whether to wait for the documents to have been synced to disk.
The result of a collection bulk import.
The number of new documents imported.
Additional details about any errors encountered during the import.
The number of empty documents.
Whether the import failed.
The number of documents that failed with an error.
The number of documents that failed with an error that is ignored.
The number of documents updated.
TODO
TODO
TODO
TODO
An object defining the collection's key generation.
Unless set to false
, documents can be created with a user-specified
_key
attribute.
Default: true
(Autoincrement only.) How many steps to increment the key each time.
(Autoincrement only.) The initial offset for the key.
Type of key generator to use.
An object defining the collection's key generation.
Whether documents can be created with a user-specified _key
attribute.
(Autoincrement only.) How many steps to increment the key each time.
The most recent key that has been generated.
(Autoincrement only.) The initial offset for the key.
Type of key generator to use.
General information about a collection.
A globally unique identifier for this collection.
The collection name.
An integer indicating the collection loading status.
An integer indicating the collection type.
An object defining the properties of a collection.
Options for setting a collection's properties.
(MMFiles only.) The maximum size for each journal or datafile in bytes.
Must be a number greater than or equal to 1048576
(1 MiB).
TODO
Whether data should be synchronized to disk before returning from a document create, update, replace or removal operation.
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
Options for creating a collection.
See Database.createCollection, Database.createEdgeCollection and Collection.create.
(Enterprise Edition cluster only.) If set to a collection name, sharding of the new collection will follow the rules for that collection. As long as the new collection exists, the indicated collection can not be dropped.
(MMFiles only.) Whether the collection will be compacted.
Default: true
(Cluster only.) Unless set to false
, the server will check whether
enough replicas are available at creation time and bail out otherwise.
Default: true
(MMFiles only.) Number of buckets into which indexes using hash tables are split.
Must be a power of 2 and less than or equal to 1024
.
Default: 16
(MMFiles only.) If set to true
, the collection will only be kept
in-memory and discarded when unloaded, resulting in full data loss.
Default: false
(MMFiles only.) The maximum size for each journal or datafile in bytes.
Must be a number greater than or equal to 1048576
(1 MiB).
An object defining the collection's key generation.
(Cluster only.) Write concern for this collection.
(Cluster only.) Number of shards to distribute the collection across.
Default: 1
(Cluster only.) How many copies of each document should be kept in the cluster.
Default: 1
(Cluster only.) Document attributes to use to determine the target shard for each document.
Default: ["_key"]
(Cluster only.) Sharding strategy to use.
(Enterprise Edition cluster only.) Attribute containing the shard key value of the referred-to smart join collection.
TODO
If set to true
, data will be synchronized to disk before returning from
a document create, update, replace or removal operation.
Default: false
(Cluster only.) Unless set to false
, the server will wait for all
replicas to create the collection before returning.
Default: true
(Cluster only.) Write concern for this collection.
The type of key generator.
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
Indicates whether the given value represents an ArangoCollection.
A value that might be a collection.
Generated using TypeDoc
import type { DocumentCollection, EdgeCollection } from "arangojs/collection";
TODO