GraphCreateOptions (arangodb-java-driver 6.23.0 API)

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

Nested Classes
Modifier and Type	Class and Description
`static class`	`GraphCreateOptions.SmartOptions`

Constructor Summary

Constructors
Constructor and Description

GraphCreateOptions()

Constructors
Constructor and Description
`GraphCreateOptions()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected GraphCreateOptions`	`edgeDefinitions(Collection<EdgeDefinition> edgeDefinitions)`
`Collection<EdgeDefinition>`	`getEdgeDefinitions()`
`Boolean`	`getIsDisjoint()`
`Boolean`	`getIsSmart()`
`Integer`	`getMinReplicationFactor()` Deprecated. use `getWriteConcern()` instead
`protected String`	`getName()`
`Integer`	`getNumberOfShards()`
`Collection<String>`	`getOrphanCollections()`
`Integer`	`getReplicationFactor()`
`Boolean`	`getSatellite()`
`Collection<String>`	`getSatellites()`
`String`	`getSmartGraphAttribute()`
`Integer`	`getWriteConcern()`
`GraphCreateOptions`	`isDisjoint(Boolean isDisjoint)`
`GraphCreateOptions`	`isSmart(Boolean isSmart)`
`GraphCreateOptions`	`minReplicationFactor(Integer minReplicationFactor)` Deprecated. use `writeConcern(Integer)` instead
`protected GraphCreateOptions`	`name(String name)`
`GraphCreateOptions`	`numberOfShards(Integer numberOfShards)`
`GraphCreateOptions`	`orphanCollections(String... orphanCollections)`
`GraphCreateOptions`	`replicationFactor(Integer replicationFactor)`
`GraphCreateOptions`	`satellite(Boolean satellite)`
`GraphCreateOptions`	`satellites(String... satellites)`
`GraphCreateOptions`	`smartGraphAttribute(String smartGraphAttribute)`
`GraphCreateOptions`	`writeConcern(Integer writeConcern)`

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
  - getIsDisjoint
```
public Boolean getIsDisjoint()
```
  - isDisjoint
```
public GraphCreateOptions isDisjoint(Boolean isDisjoint)
```
    Parameters:
    
    isDisjoint - If set to true, a Disjoint SmartGraph will be created. This flag is not editable after creation. Default: false.
    
    Returns:
    
    options
    
    Since:
    
    ArangoDB 3.7
  - 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
  - getSatellite
```
public Boolean getSatellite()
```
  - satellite
```
public GraphCreateOptions satellite(Boolean satellite)
```
    Parameters:
    
    satellite - If the true the graph is created as a satellite graph. In this case replicationFactor(Integer) is ignored.
    
    Returns:
    
    options
    
    Since:
    
    ArangoDB 3.7
  - getMinReplicationFactor
```
@Deprecated
public Integer getMinReplicationFactor()
```
    Deprecated. use getWriteConcern() instead
  - minReplicationFactor
```
@Deprecated
public GraphCreateOptions minReplicationFactor(Integer minReplicationFactor)
```
    Deprecated. use writeConcern(Integer) instead
    
    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
  - getWriteConcern
```
public Integer getWriteConcern()
```
  - writeConcern
```
public GraphCreateOptions writeConcern(Integer writeConcern)
```
    Parameters:
    
    writeConcern - Write concern for new collections in the graph. It 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)
    
    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
  - getSatellites
```
public Collection<String> getSatellites()
```
  - satellites
```
public GraphCreateOptions satellites(String... satellites)
```
    Parameters:
    
    satellites - collection names that will be used to create SatelliteCollections for a Hybrid (Disjoint) SmartGraph (Enterprise Edition only). Each array element must be a valid collection name. The collection type cannot be modified later.
    
    Returns:
    
    options
    
    Since:
    
    ArangoDB 3.9.0

Class GraphCreateOptions

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GraphCreateOptions

Method Detail

getName

name

getEdgeDefinitions

edgeDefinitions

getOrphanCollections

orphanCollections

getIsSmart

isSmart

getIsDisjoint

isDisjoint

getReplicationFactor

replicationFactor

getSatellite

satellite

getMinReplicationFactor

minReplicationFactor

getWriteConcern

writeConcern

getNumberOfShards

numberOfShards

getSmartGraphAttribute

smartGraphAttribute

getSatellites

satellites