CollectionRoute uses ConstantsTrait
URI suffixes appended to `/_api/collection/{name}` for the various sub-resources of a collection on the ArangoDB server.
Lot 5.2 exposes the suffixes consumed by the current
Collection surface (count,
truncate, properties, rename). Future lots will add /figures,
/revision, /checksum, …
Each constant starts with a / so it can be concatenated directly
to a built /_api/collection/{name} base.
Tags
Table of Contents
Constants
- COUNT : string = '/count'
- Sub-route returning the document count of a collection (`GET /_api/collection/{name}/count`).
- PROPERTIES : string = '/properties'
- Sub-route returning the full metadata of a collection (`GET /_api/collection/{name}/properties`).
- RENAME : string = '/rename'
- Sub-route renaming a collection (`PUT /_api/collection/{name}/rename`, body `{ name: <newName> }`).
- TRUNCATE : string = '/truncate'
- Sub-route truncating a collection (`PUT /_api/collection/{name}/truncate`).
Constants
COUNT
Sub-route returning the document count of a collection (`GET /_api/collection/{name}/count`).
public
string
COUNT
= '/count'
PROPERTIES
Sub-route returning the full metadata of a collection (`GET /_api/collection/{name}/properties`).
public
string
PROPERTIES
= '/properties'
RENAME
Sub-route renaming a collection (`PUT /_api/collection/{name}/rename`, body `{ name: <newName> }`).
public
string
RENAME
= '/rename'
TRUNCATE
Sub-route truncating a collection (`PUT /_api/collection/{name}/truncate`).
public
string
TRUNCATE
= '/truncate'