public final class CollectionCreateOptions extends Object
| Constructor and Description |
|---|
CollectionCreateOptions() |
public String getName()
public ReplicationFactor getReplicationFactor()
public CollectionCreateOptions replicationFactor(ReplicationFactor replicationFactor)
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.public CollectionCreateOptions replicationFactor(int replicationFactor)
public Integer getWriteConcern()
public CollectionCreateOptions writeConcern(Integer writeConcern)
writeConcern - write concern for this collection (default: 1).
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)public KeyOptions getKeyOptions()
public CollectionCreateOptions keyOptions(Boolean allowUserKeys, KeyType type, Integer increment, Integer offset)
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.type - specifies the type of the key generator. The currently available generators are
traditional and
autoincrement.increment - increment value for autoincrement key generator. Not used for other key generator types.offset - Initial offset value for autoincrement key generator. Not used for other key generator
types.public Boolean getWaitForSync()
public CollectionCreateOptions waitForSync(Boolean waitForSync)
waitForSync - If true then the data is synchronized to disk before returning from a document create,
update, replace
or removal operation. (default: false)public Collection<String> getShardKeys()
public CollectionCreateOptions shardKeys(String... shardKeys)
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.public CollectionCreateOptions smartJoinAttribute(String smartJoinAttribute)
smartJoinAttribute - public String getSmartJoinAttribute()
public CollectionCreateOptions shardingStrategy(String shardingStrategy)
shardingStrategy - public String getShardingStrategy()
public CollectionCreateOptions numberOfShards(Integer numberOfShards)
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.public Integer getNumberOfShards()
public Boolean getIsSystem()
public CollectionCreateOptions isSystem(Boolean isSystem)
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)public CollectionType getType()
public CollectionCreateOptions type(CollectionType type)
type - (The default is CollectionType.DOCUMENT): the type of the collection to create.public String getDistributeShardsLike()
public CollectionCreateOptions distributeShardsLike(String distributeShardsLike)
distributeShardsLike - (The default is ""): in an enterprise cluster, this attribute binds the specifics
of sharding for the
newly created collection to follow that of a specified existing collection. Note:
Using this parameter
has consequences for the prototype collection. It can no longer be dropped, before
sharding imitating
collections are dropped. Equally, backups and restores of imitating collections
alone will generate
warnings, which can be overridden, about missing sharding prototype.public CollectionSchema getSchema()
public CollectionCreateOptions schema(CollectionSchema schema)
schema - object that specifies the collection level schema for documentspublic CollectionCreateOptions computedValues(ComputedValue... computedValues)
computedValues - An optional list of computed values.public List<ComputedValue> getComputedValues()
Copyright © 2016–2023 ArangoDB GmbH. All rights reserved.