API Reference Arangox v#0.8.0

Copy Markdown View Source

Modules

ArangoDB's Administration operations.

ArangoDB's Analyzers operations.

ArangoDB's Authentication operations.

ArangoDB's BatchRequests operations.

The adapter every Arangox.API.* operation calls.

ArangoDB's Cluster operations.

ArangoDB's Collections operations.

ArangoDB's Databases operations.

ArangoDB's Documents operations.

ArangoDB's Foxx operations.

ArangoDB's Graphs operations.

ArangoDB's HotBackups operations.

ArangoDB's Import operations.

ArangoDB's Indexes operations.

ArangoDB's Jobs operations.

ArangoDB's Monitoring operations.

ArangoDB's Queries operations.

ArangoDB's Replication operations.

ArangoDB's Security operations.

ArangoDB's Tasks operations.

ArangoDB's Transactions operations.

ArangoDB's Users operations.

ArangoDB's Views operations.

The shapes the :auth start option accepts.

Client behaviour for Arangox. Arangox uses client implementations to perform all its connection and execution operations.

Utilities for parsing ArangoDB endpoints.

ArangoDB's errorNum table as atoms.

The one error struct arangox produces.

An HTTP client implementation of the :gun library. Requires :gun to be added as a dependency.

An HTTP client implementation of the :mint library. Requires :mint to be added as a dependency.

An AQL query: the statement, and the options the server should run it under.

A response from ArangoDB.

A handle to an ArangoDB stream transaction, carried as a value.

The VelocyStream client, an explicit opt-in for ArangoDB 3.11 deployments (client: Arangox.VelocyClient) — the server removed the protocol in 3.12, and Arangox.MintClient over HTTP is the default.