ArangoRoute uses ConstantsTrait
Single source of truth for the ArangoDB HTTP route prefixes consumed by the {@see \oihana\arango\clients} surface.
Each constant carries the path of an upstream endpoint, without the
/_db/{name} database scope that the transport prepends — that scope
is the transport's responsibility, not the call-site's.
Three families coexist:
/_api/*— the bulk of CRUD-style routes (collections, documents, indexes, cursor, …),/_admin/*— server diagnostics & management endpoints (auth-protected),/_open/*— unauthenticated routes (today only/_open/auth).
The database scope prefix (/_db/) is intentionally not exposed here
because it is not a route — it is an URL-assembly artefact handled
by HttpTransport::buildUrl().
Tags
Table of Contents
Constants
- ADMIN_AVAILABILITY : string = '/_admin/server/availability'
- Server availability probe — `GET /_admin/server/availability`. Returns the server mode (`default` / `readonly`) on a 2xx response, or a 503 status code when the server is shutting down or in maintenance mode.
- ADMIN_TIME : string = '/_admin/time'
- Server wall-clock endpoint — `GET /_admin/time`.
- ANALYZER : string = '/_api/analyzer'
- ArangoSearch analyzer endpoint — `POST/GET /_api/analyzer` for the analyzer collection itself, `GET/DELETE /_api/analyzer/{name}` for a specific analyzer.
- COLLECTION : string = '/_api/collection'
- Collection management endpoint — `POST/GET/PUT/DELETE /_api/collection`.
- CURSOR : string = '/_api/cursor'
- Cursor lifecycle endpoint — `POST/PUT/DELETE /_api/cursor`. Used by {@see \oihana\arango\clients\Database::query()} (POST to open) and by {@see \oihana\arango\clients\cursor\Cursor} (PUT to fetch the next batch, DELETE to dispose).
- DATABASE : string = '/_api/database'
- Database management endpoint — `GET/POST/DELETE /_api/database`.
- DOCUMENT : string = '/_api/document'
- Document CRUD endpoint — `POST/GET/PATCH/PUT/DELETE /_api/document`.
- EXPLAIN : string = '/_api/explain'
- AQL query plan endpoint — `POST /_api/explain`. Returns the execution plan the optimizer would use without running the query.
- GHARIAL : string = '/_api/gharial'
- Named graphs (gharial) endpoint — `POST/GET /_api/gharial` for the graph collection itself, `GET/PUT/DELETE /_api/gharial/{name}` for a specific graph, and `.../vertex` / `.../edge` sub-routes for vertex collections and edge definitions management.
- IMPORT : string = '/_api/import'
- Bulk import fast path — `POST /_api/import`. Streams JSON Lines (or CSV) into the storage engine, ~100× faster than the per-document route for large batches.
- INDEX : string = '/_api/index'
- Secondary index management endpoint — `POST/GET/DELETE /_api/index`.
- OPEN_AUTH : string = '/_open/auth'
- Unauthenticated authentication endpoint — `POST /_open/auth`. Trades a `{username, password}` payload for a JWT.
- QUERY : string = '/_api/query'
- AQL parser endpoint — `POST /_api/query`. Validates the query string and returns its AST + the list of collections it references, without executing it.
- TRANSACTION : string = '/_api/transaction'
- Streaming-transaction lifecycle endpoint — `POST /_api/transaction/begin` to start, `GET|PUT|DELETE /_api/transaction/{id}` to status / commit / abort, and `GET /_api/transaction` to list active transactions.
- VERSION : string = '/_api/version'
- Server version endpoint — `GET /_api/version`.
- VIEW : string = '/_api/view'
- ArangoSearch view endpoint — `POST/GET /_api/view` for the view collection itself, `GET/DELETE /_api/view/{name}` for a specific view, `GET/PATCH/PUT /_api/view/{name}/properties` for the per-view configuration.
Constants
ADMIN_AVAILABILITY
Server availability probe — `GET /_admin/server/availability`. Returns the server mode (`default` / `readonly`) on a 2xx response, or a 503 status code when the server is shutting down or in maintenance mode.
public
string
ADMIN_AVAILABILITY
= '/_admin/server/availability'
ADMIN_TIME
Server wall-clock endpoint — `GET /_admin/time`.
public
string
ADMIN_TIME
= '/_admin/time'
ANALYZER
ArangoSearch analyzer endpoint — `POST/GET /_api/analyzer` for the analyzer collection itself, `GET/DELETE /_api/analyzer/{name}` for a specific analyzer.
public
string
ANALYZER
= '/_api/analyzer'
COLLECTION
Collection management endpoint — `POST/GET/PUT/DELETE /_api/collection`.
public
string
COLLECTION
= '/_api/collection'
Sub-routes (/count, /properties, /rename, /truncate) are
exposed by CollectionRoute.
CURSOR
Cursor lifecycle endpoint — `POST/PUT/DELETE /_api/cursor`. Used by {@see \oihana\arango\clients\Database::query()} (POST to open) and by {@see \oihana\arango\clients\cursor\Cursor} (PUT to fetch the next batch, DELETE to dispose).
public
string
CURSOR
= '/_api/cursor'
DATABASE
Database management endpoint — `GET/POST/DELETE /_api/database`.
public
string
DATABASE
= '/_api/database'
DOCUMENT
Document CRUD endpoint — `POST/GET/PATCH/PUT/DELETE /_api/document`.
public
string
DOCUMENT
= '/_api/document'
Bulk variants of the write operations operate on the same path with an array body.
EXPLAIN
AQL query plan endpoint — `POST /_api/explain`. Returns the execution plan the optimizer would use without running the query.
public
string
EXPLAIN
= '/_api/explain'
GHARIAL
Named graphs (gharial) endpoint — `POST/GET /_api/gharial` for the graph collection itself, `GET/PUT/DELETE /_api/gharial/{name}` for a specific graph, and `.../vertex` / `.../edge` sub-routes for vertex collections and edge definitions management.
public
string
GHARIAL
= '/_api/gharial'
IMPORT
Bulk import fast path — `POST /_api/import`. Streams JSON Lines (or CSV) into the storage engine, ~100× faster than the per-document route for large batches.
public
string
IMPORT
= '/_api/import'
INDEX
Secondary index management endpoint — `POST/GET/DELETE /_api/index`.
public
string
INDEX
= '/_api/index'
OPEN_AUTH
Unauthenticated authentication endpoint — `POST /_open/auth`. Trades a `{username, password}` payload for a JWT.
public
string
OPEN_AUTH
= '/_open/auth'
QUERY
AQL parser endpoint — `POST /_api/query`. Validates the query string and returns its AST + the list of collections it references, without executing it.
public
string
QUERY
= '/_api/query'
TRANSACTION
Streaming-transaction lifecycle endpoint — `POST /_api/transaction/begin` to start, `GET|PUT|DELETE /_api/transaction/{id}` to status / commit / abort, and `GET /_api/transaction` to list active transactions.
public
string
TRANSACTION
= '/_api/transaction'
VERSION
Server version endpoint — `GET /_api/version`.
public
string
VERSION
= '/_api/version'
VIEW
ArangoSearch view endpoint — `POST/GET /_api/view` for the view collection itself, `GET/DELETE /_api/view/{name}` for a specific view, `GET/PATCH/PUT /_api/view/{name}/properties` for the per-view configuration.
public
string
VIEW
= '/_api/view'