ImportField uses ConstantsTrait
Field names carried by the response body of the ArangoDB bulk import endpoint (`POST /_api/import?collection={name}`).
The server replies with a JSON object summarising the outcome of the import; these constants give it a typed surface so callers never have to read it through magic strings.
Tags
Table of Contents
Constants
- CREATED : string = 'created'
- Number of documents successfully created.
- DETAILS : string = 'details'
- Optional list of per-row error details, populated when the request was issued with the `details: true` option.
- EMPTY : string = 'empty'
- Number of empty (or otherwise skipped) source rows.
- ERRORS : string = 'errors'
- Number of documents that failed to be imported.
- IGNORED : string = 'ignored'
- Number of duplicate documents that were silently ignored — only meaningful when `onDuplicate` is set to {@see OnDuplicate::IGNORE}.
- UPDATED : string = 'updated'
- Number of existing documents updated — only meaningful when `onDuplicate` is set to {@see OnDuplicate::UPDATE} or {@see OnDuplicate::REPLACE}.
Constants
CREATED
Number of documents successfully created.
public
string
CREATED
= 'created'
DETAILS
Optional list of per-row error details, populated when the request was issued with the `details: true` option.
public
string
DETAILS
= 'details'
EMPTY
Number of empty (or otherwise skipped) source rows.
public
string
EMPTY
= 'empty'
ERRORS
Number of documents that failed to be imported.
public
string
ERRORS
= 'errors'
IGNORED
Number of duplicate documents that were silently ignored — only meaningful when `onDuplicate` is set to {@see OnDuplicate::IGNORE}.
public
string
IGNORED
= 'ignored'
UPDATED
Number of existing documents updated — only meaningful when `onDuplicate` is set to {@see OnDuplicate::UPDATE} or {@see OnDuplicate::REPLACE}.
public
string
UPDATED
= 'updated'