Struct ruarango::coll::output::Create

source ·

pub struct Create { /* private fields */ }

Expand description

Output when create is called for a collection

Implementations§

source §

impl Create

source

pub fn error(&self) -> &bool

Is this respone an error?

source

pub fn code(&self) -> &usize

The response code, i.e. 200, 404

source

pub fn name(&self) -> &String

The collection name

source

pub fn is_smart(&self) -> &Option<bool>

Whether the collection is used in a SmartGraph (Enterprise Edition only). (cluster only)

source

pub fn smart_join_attribute(&self) -> &Option<String>

Determines an attribute of the collection that must contain the shard key value of the referred-to SmartJoin collection (Enterprise Edition only). (cluster only)

source

pub fn number_of_shards(&self) -> &Option<usize>

The number of shards of the collection. (cluster only)

source

pub fn status_string(&self) -> &String

Any of: [“unloaded”, “loading”, “loaded”, “unloading”, “deleted”, “unknown”] Only relevant for the MMFiles storage engine

source

pub fn globally_unique_id(&self) -> &String

Unique identifier of the collection

source

pub fn id(&self) -> &String

unique identifier of the collection; deprecated

source

pub fn smart_graph_attribute(&self) -> &Option<String>

Attribute that is used in SmartGraphs (Enterprise Edition only). (cluster only)

source

pub fn replication_factor(&self) -> &Option<String>

Contains how many copies of each shard are kept on different DB-Servers. It is an integer number in the range of 1-10 or the string “satellite” for a SatelliteCollection (Enterprise Edition only). (cluster only)

source

pub fn do_compact(&self) -> &Option<bool>

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

source

pub fn kind(&self) -> &CollectionKind

The collection kind

source

pub fn index_buckets(&self) -> &Option<usize>

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

source

pub fn schema(&self) -> &Option<String>

The collection level schema for documents.

source

pub fn status(&self) -> &Status

The status

source

pub fn journal_size(&self) -> &Option<String>

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

source

pub fn wait_for_sync(&self) -> &bool

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

source

pub fn is_system(&self) -> &bool

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

source

pub fn sharding_strategy(&self) -> &Option<String>

the sharding strategy selected for the collection. One of ‘hash’ or ‘enterprise-hash-smart-edge’. (cluster only)

source

pub fn is_volatile(&self) -> &Option<bool>

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.

source

pub fn write_concern(&self) -> &usize

Determines how many copies of each shard are required to be in sync on the different DB-Servers. If there are less then these many copies in the cluster a shard will refuse to write. Writes to shards with enough up-to-date copies will succeed at the same time however. The value of writeConcern can not be larger than replicationFactor. (cluster only)

source