ArangoDB JavaScript Driver Files

Added

• Added missing AQL query tracking attributes to match HTTP API documentation (DE-1139)

The query tracking types now include all attributes supported by the ArangoDB query tracking endpoints:

• slowStreamingQueryThreshold: Added to QueryTrackingOptions (optional) and QueryTrackingInfo (required)
  • Threshold in seconds for treating a streaming query as slow (when stream option is true)
• modificationQuery: Added to QueryDescription (required)
  • Boolean indicating whether the query writes data (true) or only reads (false)

• exitCode: Added to QueryDescription (optional)

  • Error code (errorNum) indicating why the query failed, or 0 on success
  • Only present in slow queries (finished queries), not in running queries

• Added missing options to ExplainOptions type for Database.explain() method (DE-1009)

The ExplainOptions type now includes all options supported by the ArangoDB explain endpoint:

• fullCount: Calculate total documents as if LIMIT wasn't applied
• profile: Include query profiling information (0, 1, or 2)
• maxNodesPerCallstack: Control stack splitting threshold
• maxWarningCount: Limit the number of warnings returned

• failOnWarning: Throw exception on warnings instead of returning them

• Added trainingState, errorMessage, and sparse for vector indexes (DE-1147)

VectorIndexDescription now reflects ArangoDB 3.12.9+ index responses: optional trainingState (unusable, training, ingesting, or ready) and optional errorMessage when training or usability fails (for example, insufficient training data). The VectorIndexTrainingState type alias documents the allowed trainingState values.

EnsureVectorIndexOptions now includes optional sparse, aligned with the vector index HTTP API so documents without the indexed vector field can be omitted when sparse is true.

Fixed

• Fixed incorrect handling of maxPlans in QueryOptions. The driver now supports maxNumberOfPlans and maps legacy maxPlans to maxNumberOfPlans when the latter is not provided. The driver always sends options.maxNumberOfPlans to the server. If both are provided, maxNumberOfPlans takes precedence. maxPlans is deprecated and will be removed in a future major release. (#845)