Access level for an ArangoDB user's access to a collection or database.
Definition of an AQL User Function.
Implementation of the AQL User Function.
Whether the function is deterministic.
Name of the AQL User Function.
Properties of an ArangoDB user object.
Whether the ArangoDB user account is enabled and can authenticate.
Additional information to store about this user.
ArangoDB username of the user.
Node in an AQL abstract syntax tree (AST).
Options for creating a database.
(Cluster only.) Default write concern for new collections created in this database.
(Cluster only.) Default replication factor for new collections in this database.
Setting this to 1 disables replication. Setting this to "satellite"
will replicate to every DBServer.
(Cluster only.) The sharding method to use for new collections in the database.
Database users to create with the database.
(Cluster only.) Default write concern for new collections created in this database.
Database user to create with a database.
Whether the user is active.
Default: true
Additional data to store with the user object.
Password of the user to create.
Default: ""
Username of the user to create.
Options for creating an ArangoDB user.
Whether the ArangoDB user account is enabled and can authenticate.
Default: true
Additional information to store about this user.
Default: {}
Password the ArangoDB user will use for authentication.
ArangoDB username of the user.
Object describing a database.
See Database.get.
Unique identifier of the database.
Whether the database is the system database.
(Cluster only.) Default write concern for new collections created in this database.
Name of the database.
File system path of the database.
(Cluster only.) Default replication factor for new collections in this database.
(Cluster only.) The sharding method to use for new collections in the database.
(Cluster only.) Default write concern for new collections created in this database.
Options for explaining a query.
See Database.explain.
If set to true, all possible execution plans will be returned as the
plans property. Otherwise only the optimal execution plan will be
returned as the plan property.
Default: false
Maximum number of plans that the optimizer is allowed to generate. Setting this to a low value limits the amount of work the optimizer does.
An object with a rules property specifying a list of optimizer rules to
be included or excluded by the optimizer for this query. Prefix a rule
name with + to include it, or - to exclude it. The name all acts as
an alias matching all optimizer rules.
Plan explaining query execution.
Information about collections involved in the query.
Total estimated cost of the plan.
Estimated number of items returned by the query.
Whether the query is a data modification query.
Execution nodes in this plan.
Rules applied by the optimizer.
Variables used in the query.
Options for installing the service.
An object mapping configuration option names to values.
See also Database.getServiceConfiguration.
An object mapping dependency aliases to mount points.
See also Database.getServiceDependencies.
Whether the service should be installed in development mode.
See also Database.setServiceDevelopmentMode.
Default: false
Whether the service should be installed in legacy compatibility mode
This overrides the engines option in the service manifest (if any).
Default: false
Whether the "setup" script should be executed.
Default: true
Result of explaining a query with multiple plans.
Whether it would be possible to cache the query.
Query plans.
Statistical information about the query plan generation.
Total number of plans created.
Total number of rules executed for this query.
Number of rules skipped for this query.
Warnings encountered while planning the query execution.
Object describing a multi-service dependency defined by a Foxx service.
Current mount points the dependency is resolved to.
Human-readable description of the dependency.
Whether this is a multi-service dependency.
Name of the service the dependency expects to match.
Whether the dependency must be matched in order for the service to be operational.
Formatted name of the dependency.
Version of the service the dependency expects to match.
Result of parsing a query.
Abstract syntax tree (AST) of the query.
Names of all bind parameters used in the query.
Names of all collections involved in the query.
Whether the query was parsed.
Object describing a query.
Bind parameters used in the query.
Unique identifier for this query.
Query string (potentially truncated).
Query's running time in seconds.
Date and time the query was started.
Query's current execution state.
Whether the query uses a streaming cursor.
Options for executing a query.
See Database.query.
If set to true, the query will be executed with support for dirty reads
enabled, permitting ArangoDB to return a potentially dirty or stale result
and arangojs will load balance the request without distinguishing between
leaders and followers.
Note that dirty reads are only supported for read-only queries, not data
modification queries (e.g. using INSERT, UPDATE, REPLACE or
REMOVE) and only when using ArangoDB 3.4 or later.
Default: false
Number of result values to be transferred by the server in each network roundtrip (or "batch").
Must be greater than zero.
If set to false, the AQL query results cache lookup will be skipped for
this query.
Default: true
Unless set to false, the number of result values in the result set will
be returned in the count attribute. This may be disabled by default in
a future version of ArangoDB if calculating this value has a performance
impact for some queries.
Default: true.
If set to true, the query will throw an exception and abort if it would
otherwise produce a warning.
If set to false, the query data will not be stored in the RocksDB block
cache. This can be used to avoid thrashing he block cache when reading a
lot of data.
If set to true and the query has a LIMIT clause, the total number of
values matched before the last top-level LIMIT in the query was applied
will be returned in the extra.stats.fullCount attribute.
(RocksDB only.) Maximum number of operations after which an intermediate commit is automatically performed.
(RocksDB only.) Maximum total size of operations in bytes after which an intermediate commit is automatically performed.
Controls after how many execution nodes in a query a stack split should be performed.
Default: 250 (200 on macOS)
Limits the maximum number of plans that will be created by the AQL query optimizer.
Maximum allowed execution time before the query will be killed in seconds.
If set to 0, the query will be allowed to run indefinitely.
Default: 0
(RocksDB only.) Maximum size of transactions in bytes.
Limits the maximum number of warnings a query will return.
Maximum memory size in bytes that the query is allowed to use. Exceeding this value will result in the query failing with an error.
If set to 0, the memory limit is disabled.
Default: 0
An object with a rules property specifying a list of optimizer rules to
be included or excluded by the optimizer for this query. Prefix a rule
name with + to include it, or - to exclude it. The name all acts as
an alias matching all optimizer rules.
If set to 1 or true, additional query profiling information will be
returned in the extra.profile attribute if the query is not served from
the result cache.
If set to 2, the query will return execution stats per query plan node
in the extra.stats.nodes attribute. Additionally the query plan is
returned in extra.plan.
(Enterprise Edition cluster only.) Limits the maximum time in seconds a DBServer will wait to bring satellite collections involved in the query into sync. Exceeding this value will result in the query being stopped.
Default: 60
(Enterprise Edition cluster only.) If set to true, collections
inaccessible to current user will result in an access error instead
of being treated as empty.
If set to true, the query will be executed as a streaming query.
Maximum time in milliseconds arangojs will wait for a server response. Exceeding this value will result in the request being cancelled.
Note: Setting a timeout for the client does not guarantee the query
will be killed by ArangoDB if it is already being executed. See the
maxRuntime option for limiting the execution time within ArangoDB.
Time-to-live for the cursor in seconds. The cursor results may be garbage collected by ArangoDB after this much time has passed.
Default: 30
Information about query tracking.
Whether query tracking is enabled.
Maximum query string length in bytes that is kept in the list.
Maximum number of slow queries that is kept in the list.
Threshold execution time in seconds for when a query is considered slow.
Whether bind parameters are being tracked along with queries.
Whether slow queries are being tracked.
Options for query tracking.
If set to false, neither queries nor slow queries will be tracked.
Maximum query string length in bytes that will be kept in the list.
Maximum number of slow queries to be kept in the list.
Threshold execution time in seconds for when a query will be considered slow.
If set to true, bind parameters will be tracked along with queries.
If set to true and enabled is also set to true, slow queries will be
tracked if their execution time exceeds slowQueryThreshold.
An object providing methods for accessing queue time metrics of the most recently received server responses if the server supports this feature.
Returns the average queue time of the most recently received responses in seconds.
Returns the queue time of the most recently received response in seconds.
Returns a list of the most recently received queue time values as tuples of the timestamp of the response being processed in milliseconds and the queue time in seconds.
Options for replacing a service.
An object mapping configuration option names to values.
See also Database.getServiceConfiguration.
An object mapping dependency aliases to mount points.
See also Database.getServiceDependencies.
Whether the service should be installed in development mode.
See also Database.setServiceDevelopmentMode.
Default: false
If set to true, replacing a service that does not already exist will
fall back to installing the new service.
Default: false
Whether the service should be installed in legacy compatibility mode
This overrides the engines option in the service manifest (if any).
Default: false
Whether the "setup" script should be executed.
Default: true
Whether the existing service's "teardown" script should be executed prior to removing that service.
Default: true
Object describing a configuration option of a Foxx service.
Processed current value of the configuration option as exposed in the service code.
Current value of the configuration option as stored internally.
Default value of the configuration option.
Human-readable description of the configuration option.
Whether the configuration option must be set in order for the service to be operational.
Formatted name of the configuration option.
Data type of the configuration value.
Note: "int" and "bool" are historical synonyms for "integer" and
"boolean". The "password" type is synonymous with "string" but can
be used to distinguish values which should not be displayed in plain text
by software when managing the service.
Object describing a Foxx service in detail.
Internal checksum of the service's initial source bundle.
Whether development mode is enabled for this service.
Whether the service is running in legacy compatibility mode.
Content of the service manifest of this service.
Service mount point, relative to the database.
Name defined in the service manifest.
Options for this service.
File system path of the service.
Version defined in the service manifest.
Object briefly describing a Foxx service.
Whether development mode is enabled for this service.
Whether the service is running in legacy compatibility mode.
Service mount point, relative to the database.
Name defined in the service manifest.
Service dependencies the service expects to be able to match as a mapping from dependency names to versions the service is compatible with.
Version defined in the service manifest.
Test results for a Foxx service's tests using the default reporter.
Test results for a single test case using the default reporter.
Test stats for a Foxx service's tests.
Total test duration in milliseconds.
Number of tests that failed.
Number of tests that ran successfully.
Number of tests skipped or not executed.
Total number of tests found.
Test results for a Foxx service's tests using the stream reporter.
Test results for a single test case using the stream reporter.
Test results for a single test suite using the suite reporter.
Test results for a Foxx service's tests using the suite reporter.
Test results for a single test case using the suite reporter.
Test results for a Foxx service's tests in TAP format.
Test results for a Foxx service's tests in XUnit format using the JSONML representation.
Test results for a single test case in XUnit format using the JSONML representation.
Result of explaining a query with a single plan.
Whether it would be possible to cache the query.
Query plan.
Statistical information about the query plan generation.
Total number of plans created.
Total number of rules executed for this query.
Number of rules skipped for this query.
Warnings encountered while planning the query execution.
Object describing a single-service dependency defined by a Foxx service.
Current mount point the dependency is resolved to.
Human-readable description of the dependency.
Whether this is a multi-service dependency.
Name of the service the dependency expects to match.
Whether the dependency must be matched in order for the service to be operational.
Formatted name of the dependency.
Version of the service the dependency expects to match.
OpenAPI 2.0 description of a Foxx service.
Collections involved in a transaction.
An array of collections or a single collection that will be read from or written to during the transaction with no other writes being able to run in parallel.
An array of collections or a single collection that will be read from during the transaction.
An array of collections or a single collection that will be read from or written to during the transaction.
If ArangoDB is using the MMFiles storage engine, this option behaves
exactly like exclusive, i.e. no other writes will run in parallel.
Details for a transaction.
See also TransactionStatus.
Unique identifier of the transaction.
Status (or "state") of the transaction.
Options for how the transaction should be performed.
Whether the transaction may read from collections not specified for this
transaction. If set to false, accessing any collections not specified
will result in the transaction being aborted to avoid potential deadlocks.
Default: true.
(RocksDB only.) Determines the maximum number of operations after which an intermediate commit is performed automatically.
(RocksDB only.) Determine the maximum total size of operations after which an intermediate commit is performed automatically.
Determines how long the database will wait while attempting to gain locks on collections used by the transaction before timing out.
(RocksDB only.) Determines the transaction size limit in bytes.
Determines whether to force the transaction to write all data to disk before returning.
Options for uninstalling a service.
If set to true, uninstalling a service that does not already exist
will be considered successful.
Default: false
Whether the service's "teardown" script should be executed prior to removing that service.
Default: true
Options for upgrading a service.
An object mapping configuration option names to values.
See also Database.getServiceConfiguration.
An object mapping dependency aliases to mount points.
See also Database.getServiceDependencies.
Whether the service should be installed in development mode.
See also Database.setServiceDevelopmentMode.
Default: false
Unless set to true, upgrading a service that does not already exist will
fall back to installing the new service.
Default: false
Whether the service should be installed in legacy compatibility mode
This overrides the engines option in the service manifest (if any).
Default: false
Whether the "setup" script should be executed.
Default: true
Whether the existing service's "teardown" script should be executed prior to upgrading that service.
Default: false
Options for accessing or manipulating access levels.
The collection to access or manipulate the access level of.
The database to access or manipulate the access level of.
If collection is an ArangoCollection, this option defaults to the
database the collection is contained in. Otherwise this option defaults to
the current database.
Options for modifying an ArangoDB user.
Whether the ArangoDB user account is enabled and can authenticate.
Default: true
Additional information to store about this user.
Default: {}
Password the ArangoDB user will use for authentication.
Result of retrieving database version information.
Additional information about the ArangoDB server.
ArangoDB license type or "edition".
Value identifying the server type, i.e. "arango".
ArangoDB server version.
Generated using TypeDoc
The "database" module provides the Database class and associated types and interfaces for TypeScript.
The Database class is also re-exported by the "index" module.