# Arangox v0.8.0 - API Reference

## Modules

- [Arangox](Arangox.md): [![Hex.pm](https://img.shields.io/hexpm/v/arangox.svg)](https://hex.pm/packages/arangox)
[![Documentation](https://img.shields.io/badge/hex-docs-blue.svg)](https://hexdocs.pm/arangox)
[![CI](https://github.com/ArangoDB-Community/arangox/actions/workflows/elixir.yml/badge.svg?branch=main&event=push)](https://github.com/ArangoDB-Community/arangox/actions/workflows/elixir.yml)
- [Arangox.API.Administration](Arangox.API.Administration.md): ArangoDB's Administration operations.
- [Arangox.API.Analyzers](Arangox.API.Analyzers.md): ArangoDB's Analyzers operations.
- [Arangox.API.Authentication](Arangox.API.Authentication.md): ArangoDB's Authentication operations.
- [Arangox.API.BatchRequests](Arangox.API.BatchRequests.md): ArangoDB's BatchRequests operations.
- [Arangox.API.Client](Arangox.API.Client.md): The adapter every `Arangox.API.*` operation calls.
- [Arangox.API.Cluster](Arangox.API.Cluster.md): ArangoDB's Cluster operations.
- [Arangox.API.Collections](Arangox.API.Collections.md): ArangoDB's Collections operations.
- [Arangox.API.Databases](Arangox.API.Databases.md): ArangoDB's Databases operations.
- [Arangox.API.Documents](Arangox.API.Documents.md): ArangoDB's Documents operations.
- [Arangox.API.Foxx](Arangox.API.Foxx.md): ArangoDB's Foxx operations.
- [Arangox.API.Graphs](Arangox.API.Graphs.md): ArangoDB's Graphs operations.
- [Arangox.API.HotBackups](Arangox.API.HotBackups.md): ArangoDB's HotBackups operations.
- [Arangox.API.Import](Arangox.API.Import.md): ArangoDB's Import operations.
- [Arangox.API.Indexes](Arangox.API.Indexes.md): ArangoDB's Indexes operations.
- [Arangox.API.Jobs](Arangox.API.Jobs.md): ArangoDB's Jobs operations.
- [Arangox.API.Monitoring](Arangox.API.Monitoring.md): ArangoDB's Monitoring operations.
- [Arangox.API.Queries](Arangox.API.Queries.md): ArangoDB's Queries operations.
- [Arangox.API.Replication](Arangox.API.Replication.md): ArangoDB's Replication operations.
- [Arangox.API.Security](Arangox.API.Security.md): ArangoDB's Security operations.
- [Arangox.API.Tasks](Arangox.API.Tasks.md): ArangoDB's Tasks operations.
- [Arangox.API.Transactions](Arangox.API.Transactions.md): ArangoDB's Transactions operations.
- [Arangox.API.Users](Arangox.API.Users.md): ArangoDB's Users operations.
- [Arangox.API.Views](Arangox.API.Views.md): ArangoDB's Views operations.
- [Arangox.Auth](Arangox.Auth.md): The shapes the `:auth` start option accepts.
- [Arangox.Client](Arangox.Client.md): Client behaviour for `Arangox`. Arangox uses client implementations to
perform all its connection and execution operations.
- [Arangox.Connection](Arangox.Connection.md): `DBConnection` implementation for `Arangox`.
- [Arangox.Endpoint](Arangox.Endpoint.md): Utilities for parsing _ArangoDB_ endpoints.
- [Arangox.Errno](Arangox.Errno.md): ArangoDB's `errorNum` table as atoms.
- [Arangox.GunClient](Arangox.GunClient.md): An HTTP client implementation of the [`:gun`](https://ninenines.eu/docs/en/gun/2.1/guide "documentation") library. Requires [`:gun`](https://hex.pm/packages/gun "hex.pm") to be added
as a dependency.
- [Arangox.MintClient](Arangox.MintClient.md): An HTTP client implementation of the [`:mint`](https://hexdocs.pm/mint/Mint.HTTP.html "documentation") library. Requires [`:mint`](https://hex.pm/packages/mint "hex.pm") to be
added as a dependency.
- [Arangox.Query](Arangox.Query.md): An AQL query: the statement, and the options the server should run it under.
- [Arangox.Request](Arangox.Request.md)
- [Arangox.Response](Arangox.Response.md): A response from _ArangoDB_.
- [Arangox.Transaction](Arangox.Transaction.md): A handle to an ArangoDB stream transaction, carried as a value.
- [Arangox.VelocyClient](Arangox.VelocyClient.md): The [VelocyStream](https://github.com/arangodb/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.

- Exceptions
  - [Arangox.Error](Arangox.Error.md): The one error struct arangox produces.