com.arangodb.entity

Class DatabaseEntity

java.lang.Object

com.arangodb.entity.DatabaseEntity

All Implemented Interfaces:

Entity

public class DatabaseEntity
extends Object
implements Entity

Author:

Mark Vollmary

See Also:

API Documentation

Constructor Summary

Constructors

Constructor and Description
DatabaseEntity()

Method Summary

Modifier and Type	Method and Description
String	getId()
Boolean	getIsSystem()
String	getName()
String	getPath()
Integer	getReplicationFactor()
Boolean	getSatellite()
String	getSharding()
Integer	getWriteConcern() Default write concern for new collections created in this database.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DatabaseEntity

public DatabaseEntity()

Method Detail

getId

public String getId()

Returns:

the id of the database

getName

public String getName()

Returns:

the name of the database

getPath

public String getPath()

Returns:

the filesystem path of the database

getIsSystem

public Boolean getIsSystem()

Returns:

whether or not the database is the _system database

getReplicationFactor

public Integer getReplicationFactor()

Returns:

the default replication factor for collections in this database

Since:

ArangoDB 3.6.0

getWriteConcern

public Integer getWriteConcern()

Default write concern for new collections created in this database. It determines how many copies of each shard are required to be in sync on the different DBServers. 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)

Since:

ArangoDB 3.6.0

getSatellite

public Boolean getSatellite()

Returns:

whether the collection is a satellite collection. Only in an enterprise cluster setup (else returning null).

Since:

ArangoDB 3.6.0

getSharding

public String getSharding()

Returns:

information about the default sharding method for collections created in this database

Since:

ArangoDB 3.6.0