com.arangodb.model

Class GraphCreateOptions

java.lang.Object

com.arangodb.model.GraphCreateOptions

public class GraphCreateOptions
extends Object

Author:

Mark Vollmary

See Also:

API Documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphCreateOptions.SmartOptions

Constructor Summary

Constructors

Constructor and Description
GraphCreateOptions()

Method Summary

Modifier and Type	Method and Description
protected GraphCreateOptions	edgeDefinitions(Collection<EdgeDefinition> edgeDefinitions)
Collection<EdgeDefinition>	getEdgeDefinitions()
Boolean	getIsSmart()
Integer	getMinReplicationFactor()
protected String	getName()
Integer	getNumberOfShards()
Collection<String>	getOrphanCollections()
Integer	getReplicationFactor()
String	getSmartGraphAttribute()
GraphCreateOptions	isSmart(Boolean isSmart)
GraphCreateOptions	minReplicationFactor(Integer minReplicationFactor)
protected GraphCreateOptions	name(String name)
GraphCreateOptions	numberOfShards(Integer numberOfShards)
GraphCreateOptions	orphanCollections(String... orphanCollections)
GraphCreateOptions	replicationFactor(Integer replicationFactor)
GraphCreateOptions	smartGraphAttribute(String smartGraphAttribute)

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphCreateOptions

public GraphCreateOptions()

Method Detail

getName

protected String getName()

name

protected GraphCreateOptions name(String name)

Parameters:

name - Name of the graph

Returns:

options

getEdgeDefinitions

public Collection<EdgeDefinition> getEdgeDefinitions()

edgeDefinitions

protected GraphCreateOptions edgeDefinitions(Collection<EdgeDefinition> edgeDefinitions)

Parameters:

edgeDefinitions - An array of definitions for the edge

Returns:

options

getOrphanCollections

public Collection<String> getOrphanCollections()

orphanCollections

public GraphCreateOptions orphanCollections(String... orphanCollections)

Parameters:

orphanCollections - Additional vertex collections

Returns:

options

getIsSmart

public Boolean getIsSmart()

isSmart

public GraphCreateOptions isSmart(Boolean isSmart)

Parameters:

isSmart - Define if the created graph should be smart. This only has effect in Enterprise version.

Returns:

options

getReplicationFactor

public Integer getReplicationFactor()

replicationFactor

public GraphCreateOptions replicationFactor(Integer replicationFactor)

Parameters:

replicationFactor - (The default is 1): in a cluster, this attribute determines how many copies of each shard are kept on different DBServers. The value 1 means that only one copy (no synchronous replication) is kept. A value of k means that k-1 replicas are kept. Any two copies reside on different DBServers. Replication between them is synchronous, that is, every write operation to the "leader" copy will be replicated to all "follower" replicas, before the write operation is reported successful. If a server fails, this is detected automatically and one of the servers holding copies take over, usually without an error being reported.

Returns:

options

getMinReplicationFactor

public Integer getMinReplicationFactor()

minReplicationFactor

public GraphCreateOptions minReplicationFactor(Integer minReplicationFactor)

Parameters:

minReplicationFactor - (optional, default is 1): in a cluster, this attribute determines how many desired copies of each shard are kept on different DBServers. The value 1 means that only one copy (no synchronous replication) is kept. A value of k means that desired k-1 replicas are kept. If in a failover scenario a shard of a collection has less than minReplicationFactor many insync followers it will go into "read-only" mode and will reject writes until enough followers are insync again. In more detail: Having `minReplicationFactor == 1` means as soon as a "master-copy" is available of the data writes are allowed. Having `minReplicationFactor > 1` requires additional insync copies on follower servers to allow writes.

Returns:

options

getNumberOfShards

public Integer getNumberOfShards()

numberOfShards

public GraphCreateOptions numberOfShards(Integer numberOfShards)

Parameters:

numberOfShards - The number of shards that is used for every collection within this graph. Cannot be modified later.

Returns:

options

getSmartGraphAttribute

public String getSmartGraphAttribute()

smartGraphAttribute

public GraphCreateOptions smartGraphAttribute(String smartGraphAttribute)

Parameters:

smartGraphAttribute - The attribute name that is used to smartly shard the vertices of a graph. Every vertex in this Graph has to have this attribute. Cannot be modified later.

Returns:

options