enums
Table of Contents
Namespaces
- functions
- options
- traits
Classes
- AQL
- ArangoConfig
- ArrayComparator
- In AQL, most comparison operators also exist as an array variant.
- Clause
- Comparator
- ConditionOptimization
- The values of the `conditionOptimization` option of the AQL `SEARCH` operation,
controlling how the search criteria are optimized — used as the
{@see \oihana\arango\db\options\SearchOptions::$conditionOptimization} value.
- CountApproximate
- The values of the `countApproximate` option of the AQL `SEARCH` operation,
controlling how the total row count is calculated when the `fullCount` query
option is enabled or a `COLLECT WITH COUNT` clause is executed — used as the
{@see \oihana\arango\db\options\SearchOptions::$countApproximate} value.
- DateFormat
- DateUnit
- DiffKind
- The kind of server object a {@see \oihana\arango\db\results\DiffReport}
is about — set by the structure-diff primitives so a mixed report list
(the `doctor` action) can label each line unambiguously.
- DiffStatus
- The status of a declaration ↔ server comparison, as reported by
{@see \oihana\arango\db\results\DiffReport::$status} — the answer to
"is the server object still what the model declares?", for a collection,
the indexes of a collection or an ArangoSearch View ({@see DiffKind}).
- EmptyObject
- The empty AQL object literal, in its compact and spaced renderings.
- ExplainField
- Keys of the `POST /_api/explain` response (and of the nested execution plan).
- Extra
- Statistics and extra Information attributes.
- FaithParam
- The enumeration of the Faiss Library params to use in the "params" option in the vector index definitions.
- IndexType
- The enumeration of the ArangoDB index types.
- Logic
- Node
- Represents the attributes of a runtime statistics per query execution node.
- Operation
- Operator
- OverwriteMode
- PercentileMethod
- SearchScorer
- The ArangoSearch scoring algorithms, used to select the scorer function in
{@see \oihana\arango\db\operations\aqlScoredSearch()}. Both scorers rank
better matches with **higher** values, so relevance sorting is always
descending.
- Statistic
- Represents the possible statistics attributes.
- Traversal
- Represents the possible traversal directions for graph edges in ArangoDB.
- UpsertType
- Defines the type of operation performed during an UPSERT in ArangoDB.
- VectorMetric
- The vector similarity metrics, used both as the `metric` value of a
{@see \oihana\arango\clients\collection\indexes\VectorIndex} and to select the
approximate-nearest-neighbour function in {@see \oihana\arango\db\operations\aqlVectorSearch()}.
- VectorSearchOption
- The query-time options accepted by the AQL vector similarity functions
(`APPROX_NEAR_COSINE`, `APPROX_NEAR_L2`) as their trailing options object.
- WeekDay
