Arango v0.0.1 Arangoex.Collection

ArangoDB Collection methods

Summary

Functions

Return checksum for the collection

Return information about a collection

Reads all collections

Return number of documents in a collection

Create collection

Drops collection

Return statistics for a collection

Read properties of a collection

Return collection revision id

Rotate journal of a collection

Change properties of a collection

Truncate collection

Unload collection

Types

t()
t() :: %Arangoex.Collection{doCompact: nil | boolean, id: nil | pos_integer, indexBuckets: nil | pos_integer, isSystem: nil | boolean, isVolatile: nil | boolean, journalSize: nil | pos_integer, keyOptions: %{optional(:allowUserKeys) => boolean, optional(:type) => String.t, optional(:increment) => pos_integer, optional(:offset) => pos_integer}, name: String.t, numberOfShards: nil | pos_integer, replicationFactor: nil | pos_integer, shardKeys: [String.t], type: nil | 2 | 3, waitForSync: nil | boolean}

Functions

checksum(endpoint, coll)

Return checksum for the collection

GET /_api/collection/{collection-name}/checksum

collection(endpoint, coll)

Return information about a collection

GET /_api/collection/{collection-name}

collections(endpoint, db \\ nil)

Reads all collections

GET /_api/collection

count(endpoint, coll)

Return number of documents in a collection

GET /_api/collection/{collection-name}/count

create(endpoint, coll)

Create collection

POST /_api/collection

drop(endpoint, coll)

Drops collection

DELETE /_api/collection/{collection-name}

figures(endpoint, coll)

Return statistics for a collection

GET /_api/collection/{collection-name}/figures

load(endpoint, coll, count \\ true)

Load collection

PUT /_api/collection/{collection-name}/load

new(map_or_kwlist, opts \\ [])
new(ExConstructor.map_or_kwlist, Keyword.t) :: %Arangoex.Collection{doCompact: term, id: term, indexBuckets: term, isSystem: term, isVolatile: term, journalSize: term, keyOptions: term, name: term, numberOfShards: term, replicationFactor: term, shardKeys: term, type: term, waitForSync: term}
properties(endpoint, coll)
properties(Arangoex.Endpoint.t, t) :: Arangoex.ok_error(map)

Read properties of a collection

GET /_api/collection/{collection-name}/properties

rename(endpoint, coll, new_name)

Rename collection

PUT /_api/collection/{collection-name}/rename

revision(endpoint, coll)

Return collection revision id

GET /_api/collection/{collection-name}/revision

rotate(endpoint, coll)

Rotate journal of a collection

PUT /_api/collection/{collection-name}/rotate

set_properties(endpoint, coll, opts \\ [])
set_properties(Arangoex.Endpoint.t, t, keyword) :: Arangoex.ok_error(map)

Change properties of a collection

PUT /_api/collection/{collection-name}/properties

truncate(endpoint, coll)

Truncate collection

PUT /_api/collection/{collection-name}/truncate

unload(endpoint, coll)

Unload collection

PUT /_api/collection/{collection-name}/unload