Arango v0.0.1 Arangoex.Document

ArangoDB Document methods

Summary

Types

t()
t() :: %Arangoex.Document.Docref{_id: String.t, _key: String.t, _oldRev: String.t, _rev: String.t}

Functions

create(endpoint, coll, doc, opts \\ [])

Create document

POST /_api/document/{collection}

delete(endpoint, doc, opts \\ [])
delete(Arangoex.Endpoint.t, t, keyword) :: Arangoex.ok_error(t | [t])

Removes a document

DELETE /_api/document/{document-handle}

delete_multi(endpoint, coll, docs, opts \\ [])
delete_multi(Arangoex.Endpoint.t, Arangoex.Collection.t, [map], keyword) :: Arangoex.ok_error(t | [t])

Removes multiple documents

DELETE /_api/document/{collection}

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

Read document

GET /_api/document/{document-handle}

documents(endpoint, coll, opts \\ [])

Read all documents

PUT /_api/simple/all-keys

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

Read document header

HEAD /_api/document/{document-handle}

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

Replace document

PUT /_api/document/{document-handle}

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

Update document

PATCH /_api/document/{document-handle}