CollectionField uses ConstantsTrait
Field names exchanged with the ArangoDB server through the collection management API (`/_api/collection`), both on the request side (e.g.
the body of POST /_api/collection) and on the response side (e.g.
the entries of GET /_api/collection).
Lot 5.1 only declared the count field; Lot 5.2 rounds it out with
the metadata fields needed by the lifecycle methods (name,
isSystem, type) and the list payload field (result). Future
lots will add status, globallyUniqueId, keyOptions, …
Tags
Table of Contents
Constants
- COUNT : string = 'count'
- Field carrying the document count of a collection (response of `GET /_api/collection/{name}/count`).
- IS_SYSTEM : string = 'isSystem'
- Flag indicating that a collection is a server-managed system collection (name starting with `_`). Present in every entry of `GET /_api/collection`.
- NAME : string = 'name'
- Collection name. Used in the request body of `POST /_api/collection` and `PUT /_api/collection/{name}/rename`, and on the response side in `GET /_api/collection` entries.
- RESULT : string = 'result'
- Payload array carrying the listing of collections in the response of `GET /_api/collection`.
- TYPE : string = 'type'
- Collection type marker — one of {@see CollectionType}. Present in the request body of `POST /_api/collection` and on the response side in `GET /_api/collection` entries.
Constants
COUNT
Field carrying the document count of a collection (response of `GET /_api/collection/{name}/count`).
public
string
COUNT
= 'count'
IS_SYSTEM
Flag indicating that a collection is a server-managed system collection (name starting with `_`). Present in every entry of `GET /_api/collection`.
public
string
IS_SYSTEM
= 'isSystem'
NAME
Collection name. Used in the request body of `POST /_api/collection` and `PUT /_api/collection/{name}/rename`, and on the response side in `GET /_api/collection` entries.
public
string
NAME
= 'name'
RESULT
Payload array carrying the listing of collections in the response of `GET /_api/collection`.
public
string
RESULT
= 'result'
TYPE
Collection type marker — one of {@see CollectionType}. Present in the request body of `POST /_api/collection` and on the response side in `GET /_api/collection` entries.
public
string
TYPE
= 'type'