final case class CollectionProperties(doCompact: Option[Boolean] = None, globallyUniqueId: Option[String], id: Option[String], indexBuckets: Option[Int] = None, isSystem: Boolean, isVolatile: Option[Boolean] = None, journalSize: Option[Int] = None, keyOptions: KeyOptions, name: CollectionName, status: Option[CollectionStatus] = None, statusString: Option[String] = None, type: Option[CollectionType], waitForSync: Boolean, minReplicationFactor: Option[Int] = None, numberOfShards: Option[Int] = None, replicationFactor: Option[Int] = None, shardKeys: Option[List[String]] = None, shardingStrategy: Option[String] = None, smartGraphAttribute: Option[String] = None, schema: Option[CollectionSchema] = None) extends Product with Serializable
- 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.
- name
literal name of this collection
- 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.
- 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.*
- 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.*
- Alphabetic
- By Inheritance
- CollectionProperties
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
CollectionProperties(doCompact: Option[Boolean] = None, globallyUniqueId: Option[String], id: Option[String], indexBuckets: Option[Int] = None, isSystem: Boolean, isVolatile: Option[Boolean] = None, journalSize: Option[Int] = None, keyOptions: KeyOptions, name: CollectionName, status: Option[CollectionStatus] = None, statusString: Option[String] = None, type: Option[CollectionType], waitForSync: Boolean, minReplicationFactor: Option[Int] = None, numberOfShards: Option[Int] = None, replicationFactor: Option[Int] = None, shardKeys: Option[List[String]] = None, shardingStrategy: Option[String] = None, smartGraphAttribute: Option[String] = None, schema: Option[CollectionSchema] = None)
- 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.
- name
literal name of this collection
- 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.
- 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.*
- 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.*
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- val doCompact: Option[Boolean]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val globallyUniqueId: Option[String]
- val id: Option[String]
- val indexBuckets: Option[Int]
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val isSystem: Boolean
- val isVolatile: Option[Boolean]
- val journalSize: Option[Int]
- val keyOptions: KeyOptions
- val minReplicationFactor: Option[Int]
- val name: CollectionName
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val numberOfShards: Option[Int]
- val replicationFactor: Option[Int]
- val schema: Option[CollectionSchema]
- val shardKeys: Option[List[String]]
- val shardingStrategy: Option[String]
- val smartGraphAttribute: Option[String]
- val status: Option[CollectionStatus]
- val statusString: Option[String]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- val type: Option[CollectionType]
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- val waitForSync: Boolean