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
Load collection
Read properties of a collection
Rename collection
Return collection revision id
Rotate journal of a collection
Change properties of a collection
Truncate collection
Unload collection
Types
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
Return checksum for the collection
GET /_api/collection/{collection-name}/checksum
Return information about a collection
GET /_api/collection/{collection-name}
collections(Arangoex.Endpoint.t, String.t | nil) :: Arangoex.ok_error(t)
Reads all collections
GET /_api/collection
Return number of documents in a collection
GET /_api/collection/{collection-name}/count
Create collection
POST /_api/collection
Drops collection
DELETE /_api/collection/{collection-name}
Return statistics for a collection
GET /_api/collection/{collection-name}/figures
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}
Read properties of a collection
GET /_api/collection/{collection-name}/properties
Rename collection
PUT /_api/collection/{collection-name}/rename
Return collection revision id
GET /_api/collection/{collection-name}/revision
Rotate journal of a collection
PUT /_api/collection/{collection-name}/rotate
set_properties(Arangoex.Endpoint.t, t, keyword) :: Arangoex.ok_error(map)
Change properties of a collection
PUT /_api/collection/{collection-name}/properties
Truncate collection
PUT /_api/collection/{collection-name}/truncate
Unload collection
PUT /_api/collection/{collection-name}/unload