CollectionProperties

Value parameters

`type`

The type of the collection: - 0: "unknown" - 2: regular document collection - 3: edge collection

doCompact

Whether or not the collection will be compacted. This option is only present for the MMFiles storage engine.

globallyUniqueId

Unique identifier of the collection

id

unique identifier of the collection; deprecated

indexBuckets

the number of index buckets Only relevant for the MMFiles storage engine

isSystem

true if this is a system collection; usually name will start with an underscore.

isVolatile

If true then the collection data will be kept in memory only and ArangoDB will not write or sync the data to disk. This option is only present for the MMFiles storage engine.

journalSize

The maximal size setting for journals / datafiles in bytes. This option is only present for the MMFiles storage engine.

minReplicationFactor

contains how many minimal copies of each shard need to be in sync on different DBServers. The shards will refuse to write, if we have less then these many copies in sync. Cluster specific attribute.

name

literal name of this collection

numberOfShards

The number of shards of the collection; Cluster specific attribute.

replicationFactor

contains how many copies of each shard are kept on different DBServers.; Cluster specific attribute.

shardKeys

contains the names of document attributes that are used to determine the target shard for documents; Cluster specific attribute.

shardingStrategy

the sharding strategy selected for the collection; Cluster specific attribute. One of 'hash' or 'enterprise-hash-smart-edge'

smartGraphAttribute

Attribute that is used in smart graphs, Cluster specific attribute.

status

corrosponds to statusString; Only relevant for the MMFiles storage engine - 0: "unknown" - may be corrupted - 1: (deprecated, maps to "unknown") - 2: "unloaded" - 3: "loaded" - 4: "unloading" - 5: "deleted" - 6: "loading"

statusString

any of: ["unloaded", "loading", "loaded", "unloading", "deleted", "unknown"] Only relevant for the MMFiles storage engine

waitForSync

If true then creating, changing or removing documents will wait until the data has been synchronized to disk.

Attributes

Companion

object

Graph

Reset zoomHide graphShow graph

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all