com.arangodb.model

Class DatabaseOptions

java.lang.Object

com.arangodb.model.DatabaseOptions

public class DatabaseOptions
extends Object

Since:

ArangoDB 3.6.0

Author:

Michele Rastelli

Constructor Summary

Constructors

Constructor and Description
DatabaseOptions()

Method Summary

Modifier and Type	Method and Description
Integer	getReplicationFactor()
Boolean	getSatellite()
String	getSharding()
Integer	getWriteConcern()
DatabaseOptions	replicationFactor(Integer replicationFactor)
DatabaseOptions	satellite(Boolean satellite)
DatabaseOptions	sharding(String sharding)
DatabaseOptions	writeConcern(Integer writeConcern) 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

DatabaseOptions

public DatabaseOptions()

Method Detail

getReplicationFactor

public Integer getReplicationFactor()

getWriteConcern

public Integer getWriteConcern()

getSatellite

public Boolean getSatellite()

getSharding

public String getSharding()

replicationFactor

public DatabaseOptions replicationFactor(Integer replicationFactor)

Parameters:

replicationFactor - the default replication factor for collections in this database

Returns:

options

Since:

ArangoDB 3.6.0

writeConcern

public DatabaseOptions writeConcern(Integer writeConcern)

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)

Returns:

options

Since:

ArangoDB 3.6.0

satellite

public DatabaseOptions satellite(Boolean satellite)

Parameters:

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

Returns:

options

Since:

ArangoDB 3.6.0

sharding

public DatabaseOptions sharding(String sharding)

Parameters:

sharding - The sharding method to use for new collections in this database. Valid values are: “”, “flexible”, or “single”. The first two are equivalent.

Returns:

options

Since:

ArangoDB 3.6.0