com.arangodb.springframework.annotation

Annotation Type Edge

@Inherited
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface Edge

Annotation to identify a domain object to be persisted into a ArangoDB edge collection.

Author:

Mark Vollmary

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	allowUserKeys If set to true, then it is allowed to supply own key values in the _key attribute of a document.
String	collection The name of the edge collection
boolean	doCompact Whether or not the collection will be compacted (default is true)
int	indexBuckets The number of buckets into which indexes using a hash table are split.
boolean	isSystem If true, create a system collection.
boolean	isVolatile If true then the collection data is kept in-memory only and not made persistent.
long	journalSize The maximal size of a journal or datafile in bytes.
int	keyIncrement Increment value for autoincrement key generator.
int	keyOffset Initial offset value for autoincrement key generator.
com.arangodb.entity.KeyType	keyType Specifies the type of the key generator.
int	numberOfShards (The default is 1): in a cluster, this value determines the number of shards to create for the collection.
int	replicationFactor (The default is 1): in a cluster, this attribute determines how many copies of each shard are kept on different DBServers.
boolean	satellite If true the collection is created as a satellite collection.
String[]	shardKeys (The default is [ "_key" ]): in a cluster, this attribute determines which document attributes are used to determine the target shard for documents.
String	value Alias for collection().
boolean	waitForSync If true then the data is synchronized to disk before returning from a document create, update, replace or removal operation.

Element Detail

value

@AliasFor(value="collection")
public abstract String value

Alias for collection().

Intended to be used instead of collection() when no other attributes are needed — for example: @Document("collection") instead of @Document(collection = "collection").

Default:

""

collection

@AliasFor(value="value")
public abstract String collection

The name of the edge collection

Default:

""

journalSize

public abstract long journalSize

The maximal size of a journal or datafile in bytes. The value must be at least 1048576 (1 MiB).

Default:

-1L

replicationFactor

public abstract int 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 takes over, usually without an error being reported.

Default:

-1

satellite

public abstract boolean satellite

If true the collection is created as a satellite collection. In this case replicationFactor() is ignored.

Default:

false

waitForSync

public abstract boolean waitForSync

If true then the data is synchronized to disk before returning from a document create, update, replace or removal operation. (default: false)

Default:

false

doCompact

public abstract boolean doCompact

Whether or not the collection will be compacted (default is true)

Default:

true

isVolatile

public abstract boolean isVolatile

If true then the collection data is kept in-memory only and not made persistent. Unloading the collection will cause the collection data to be discarded. Stopping or re-starting the server will also cause full loss of data in the collection. Setting this option will make the resulting collection be slightly faster than regular collections because ArangoDB does not enforce any synchronization to disk and does not calculate any CRC checksums for datafiles (as there are no datafiles). This option should therefore be used for cache-type collections only, and not for data that cannot be re-created otherwise. (The default is false)

Default:

false

shardKeys

public abstract String[] shardKeys

(The default is [ "_key" ]): in a cluster, this attribute determines which document attributes are used to determine the target shard for documents. Documents are sent to shards based on the values of their shard key attributes. The values of all shard key attributes in a document are hashed, and the hash value is used to determine the target shard. Note: Values of shard key attributes cannot be changed once set. This option is meaningless in a single server setup.

Default:

{}

numberOfShards

public abstract int numberOfShards

(The default is 1): in a cluster, this value determines the number of shards to create for the collection. In a single server setup, this option is meaningless.

Default:

-1

isSystem

public abstract boolean isSystem

If true, create a system collection. In this case collection-name should start with an underscore. End users should normally create non-system collections only. API implementors may be required to create system collections in very special occasions, but normally a regular collection will do. (The default is false)

Default:

false

indexBuckets

public abstract int indexBuckets

The number of buckets into which indexes using a hash table are split. The default is 16 and this number has to be a power of 2 and less than or equal to 1024. For very large collections one should increase this to avoid long pauses when the hash table has to be initially built or resized, since buckets are resized individually and can be initially built in parallel. For example, 64 might be a sensible value for a collection with 100 000 000 documents. Currently, only the edge index respects this value, but other index types might follow in future ArangoDB versions. Changes (see below) are applied when the collection is loaded the next time.

Default:

-1

allowUserKeys

public abstract boolean allowUserKeys

If set to true, then it is allowed to supply own key values in the _key attribute of a document. If set to false, then the key generator will solely be responsible for generating keys and supplying own key values in the _key attribute of documents is considered an error.

Default:

false

keyType

public abstract com.arangodb.entity.KeyType keyType

Specifies the type of the key generator. The currently available generators are traditional and autoincrement.

Default:

com.arangodb.entity.KeyType.traditional

keyIncrement

public abstract int keyIncrement

Increment value for autoincrement key generator. Not used for other key generator types.

Default:

-1

keyOffset

public abstract int keyOffset

Initial offset value for autoincrement key generator. Not used for other key generator types.

Default:

-1