arangojs 9.2.0 → 10.0.0-alpha.1

package/cjs/logs.d.ts

@@ -0,0 +1,92 @@
+/**
+ * ```ts
+ * import type { LogLevel } from "arangojs/logs";
+ * ```
+ *
+ * The "logs" module provides types for ArangoDB logs.
+ *
+ * @packageDocumentation
+ */
+/**
+ * Numeric representation of the logging level of a log entry.
+ */
+export declare enum LogLevel {
+    FATAL = 0,
+    ERROR = 1,
+    WARNING = 2,
+    INFO = 3,
+    DEBUG = 4
+}
+/**
+ * String representation of the logging level of a log entry.
+ */
+export type LogLevelLabel = keyof typeof LogLevel;
+/**
+ * Logging level setting.
+ */
+export type LogLevelSetting = LogLevelLabel | "DEFAULT";
+/**
+ * Log sorting direction, ascending or descending.
+ */
+export type LogSortDirection = "asc" | "desc";
+/**
+ * Options for retrieving log entries.
+ */
+export type LogEntriesOptions = {
+    /**
+     * Maximum log level of the entries to retrieve.
+     *
+     * Default: `INFO`.
+     */
+    upto?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>;
+    /**
+     * If set, only log entries with this log level will be returned.
+     */
+    level?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>;
+    /**
+     * If set, only log entries with an `lid` greater than or equal to this value
+     * will be returned.
+     */
+    start?: number;
+    /**
+     * If set, only this many entries will be returned.
+     */
+    size?: number;
+    /**
+     * If set, this many log entries will be skipped.
+     */
+    offset?: number;
+    /**
+     * If set, only log entries containing the specified text will be returned.
+     */
+    search?: string;
+    /**
+     * If set to `"desc"`, log entries will be returned in reverse chronological
+     * order.
+     *
+     * Default: `"asc"`.
+     */
+    sort?: LogSortDirection;
+};
+/**
+ * An object representing a single log entry.
+ */
+export type LogMessage = {
+    id: number;
+    topic: string;
+    level: LogLevelLabel;
+    date: string;
+    message: string;
+};
+/**
+ * An object representing a list of log entries.
+ */
+export type LogEntries = {
+    totalAmount: number;
+    lid: number[];
+    topic: string[];
+    level: LogLevel[];
+    timestamp: number[];
+    text: string[];
+};
+//# sourceMappingURL=logs.d.ts.map

package/cjs/logs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logs.d.ts","sourceRoot":"","sources":["../../src/logs.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAGH;;GAEG;AACH,oBAAY,QAAQ;IAClB,KAAK,IAAA;IACL,KAAK,IAAA;IACL,OAAO,IAAA;IACP,IAAI,IAAA;IACJ,KAAK,IAAA;CACN;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,OAAO,QAAQ,CAAC;AAElD;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,aAAa,GAAG,SAAS,CAAC;AAExD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,KAAK,GAAG,MAAM,CAAC;AAI9C;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;;OAIG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,aAAa,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;IAC3D;;OAEG;IACH,KAAK,CAAC,EAAE,QAAQ,GAAG,aAAa,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;IAC5D;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,gBAAgB,CAAC;CACzB,CAAC;AAIF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,aAAa,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,GAAG,EAAE,MAAM,EAAE,CAAC;IACd,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB,CAAC"}

package/cjs/logs.js

@@ -0,0 +1,26 @@
+"use strict";
+/**
+ * ```ts
+ * import type { LogLevel } from "arangojs/logs";
+ * ```
+ *
+ * The "logs" module provides types for ArangoDB logs.
+ *
+ * @packageDocumentation
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogLevel = void 0;
+//#region Shared types
+/**
+ * Numeric representation of the logging level of a log entry.
+ */
+var LogLevel;
+(function (LogLevel) {
+    LogLevel[LogLevel["FATAL"] = 0] = "FATAL";
+    LogLevel[LogLevel["ERROR"] = 1] = "ERROR";
+    LogLevel[LogLevel["WARNING"] = 2] = "WARNING";
+    LogLevel[LogLevel["INFO"] = 3] = "INFO";
+    LogLevel[LogLevel["DEBUG"] = 4] = "DEBUG";
+})(LogLevel || (exports.LogLevel = LogLevel = {}));
+//#endregion
+//# sourceMappingURL=logs.js.map

package/cjs/logs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logs.js","sourceRoot":"","sources":["../../src/logs.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;AAEH,sBAAsB;AACtB;;GAEG;AACH,IAAY,QAMX;AAND,WAAY,QAAQ;IAClB,yCAAK,CAAA;IACL,yCAAK,CAAA;IACL,6CAAO,CAAA;IACP,uCAAI,CAAA;IACJ,yCAAK,CAAA;AACP,CAAC,EANW,QAAQ,wBAAR,QAAQ,QAMnB;AAmFD,YAAY","sourcesContent":["/**\n * ```ts\n * import type { LogLevel } from \"arangojs/logs\";\n * ```\n *\n * The \"logs\" module provides types for ArangoDB logs.\n *\n * @packageDocumentation\n */\n\n//#region Shared types\n/**\n * Numeric representation of the logging level of a log entry.\n */\nexport enum LogLevel {\n  FATAL,\n  ERROR,\n  WARNING,\n  INFO,\n  DEBUG,\n}\n\n/**\n * String representation of the logging level of a log entry.\n */\nexport type LogLevelLabel = keyof typeof LogLevel;\n\n/**\n * Logging level setting.\n */\nexport type LogLevelSetting = LogLevelLabel | \"DEFAULT\";\n\n/**\n * Log sorting direction, ascending or descending.\n */\nexport type LogSortDirection = \"asc\" | \"desc\";\n//#endregion\n\n//#region Log operation options\n/**\n * Options for retrieving log entries.\n */\nexport type LogEntriesOptions = {\n  /**\n   * Maximum log level of the entries to retrieve.\n   *\n   * Default: `INFO`.\n   */\n  upto?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>;\n  /**\n   * If set, only log entries with this log level will be returned.\n   */\n  level?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>;\n  /**\n   * If set, only log entries with an `lid` greater than or equal to this value\n   * will be returned.\n   */\n  start?: number;\n  /**\n   * If set, only this many entries will be returned.\n   */\n  size?: number;\n  /**\n   * If set, this many log entries will be skipped.\n   */\n  offset?: number;\n  /**\n   * If set, only log entries containing the specified text will be returned.\n   */\n  search?: string;\n  /**\n   * If set to `\"desc\"`, log entries will be returned in reverse chronological\n   * order.\n   *\n   * Default: `\"asc\"`.\n   */\n  sort?: LogSortDirection;\n};\n//#endregion\n\n//#region Log operation results\n/**\n * An object representing a single log entry.\n */\nexport type LogMessage = {\n  id: number;\n  topic: string;\n  level: LogLevelLabel;\n  date: string;\n  message: string;\n};\n\n/**\n * An object representing a list of log entries.\n */\nexport type LogEntries = {\n  totalAmount: number;\n  lid: number[];\n  topic: string[];\n  level: LogLevel[];\n  timestamp: number[];\n  text: string[];\n};\n//#endregion"]}

package/cjs/queries.d.ts

@@ -0,0 +1,502 @@
+/**
+ * ```ts
+ * import type { QueryOptions } from "arangojs/queries";
+ * ```
+ *
+ * The "query" module provides query related types for TypeScript.
+ *
+ * @packageDocumentation
+ */
+/**
+ * Options for executing a query.
+ *
+ * See {@link databases.Database#query}.
+ */
+export type QueryOptions = {
+    /**
+     * 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`
+     */
+    allowDirtyRead?: boolean;
+    /**
+     * If set to `true`, cursor results will be stored by ArangoDB in such a way
+     * that batch reads can be retried in the case of a communication error.
+     *
+     * Default: `false`
+     */
+    allowRetry?: boolean;
+    /**
+     * 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.
+     */
+    timeout?: number;
+    /**
+     * If set to a positive number, the query will automatically be retried at
+     * most this many times if it results in a write-write conflict.
+     *
+     * Default: `0`
+     */
+    retryOnConflict?: number;
+    /**
+     * 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`.
+     */
+    count?: boolean;
+    /**
+     * Number of result values to be transferred by the server in each
+     * network roundtrip (or "batch").
+     *
+     * Must be greater than zero.
+     */
+    batchSize?: number;
+    /**
+     * If set to `false`, the AQL query results cache lookup will be skipped for
+     * this query.
+     *
+     * Default: `true`
+     */
+    cache?: boolean;
+    /**
+     * 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`
+     */
+    memoryLimit?: number;
+    /**
+     * 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`
+     */
+    maxRuntime?: number;
+    /**
+     * 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`
+     */
+    ttl?: number;
+    /**
+     * If set to `true`, the query will throw an exception and abort if it would
+      otherwise produce a warning.
+     */
+    failOnWarning?: boolean;
+    /**
+     * 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`.
+     */
+    profile?: boolean | number;
+    /**
+     * If set to `true`, the query will be executed as a streaming query.
+     */
+    stream?: boolean;
+    /**
+     * Limits the maximum number of warnings a query will return.
+     */
+    maxWarningsCount?: number;
+    /**
+     * 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.
+     */
+    fullCount?: boolean;
+    /**
+     * 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.
+     */
+    fillBlockCache?: boolean;
+    /**
+     * 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.
+     */
+    optimizer?: {
+        rules: string[];
+    };
+    /**
+     * Limits the maximum number of plans that will be created by the AQL query
+     * optimizer.
+     */
+    maxPlans?: number;
+    /**
+     * Controls after how many execution nodes in a query a stack split should be
+     * performed.
+     *
+     * Default: `250` (`200` on macOS)
+     */
+    maxNodesPerCallstack?: number;
+    /**
+     * Maximum size of transactions in bytes.
+     */
+    maxTransactionSize?: number;
+    /**
+     * Maximum number of operations after which an intermediate commit is
+     * automatically performed.
+     */
+    intermediateCommitCount?: number;
+    /**
+     * Maximum total size of operations in bytes after which an intermediate
+     * commit is automatically performed.
+     */
+    intermediateCommitSize?: number;
+    /**
+     * (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.
+     */
+    skipInaccessibleCollections?: boolean;
+    /**
+     * (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`
+     */
+    satelliteSyncWait?: number;
+};
+/**
+ * Options for explaining a query.
+ *
+ * See {@link Database#explain}.
+ */
+export type ExplainOptions = {
+    /**
+     * 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.
+     */
+    optimizer?: {
+        rules: string[];
+    };
+    /**
+     * 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.
+     */
+    maxNumberOfPlans?: number;
+    /**
+     * 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`
+     */
+    allPlans?: boolean;
+};
+/**
+ * Options for query tracking.
+ *
+ * See {@link Database#queryTracking}.
+ */
+export type QueryTrackingOptions = {
+    /**
+     * If set to `false`, neither queries nor slow queries will be tracked.
+     */
+    enabled?: boolean;
+    /**
+     * Maximum query string length in bytes that will be kept in the list.
+     */
+    maxQueryStringLength?: number;
+    /**
+     * Maximum number of slow queries to be kept in the list.
+     */
+    maxSlowQueries?: number;
+    /**
+     * Threshold execution time in seconds for when a query will be
+     * considered slow.
+     */
+    slowQueryThreshold?: number;
+    /**
+     * If set to `true`, bind parameters will be tracked along with queries.
+     */
+    trackBindVars?: boolean;
+    /**
+     * If set to `true` and `enabled` is also set to `true`, slow queries will be
+     * tracked if their execution time exceeds `slowQueryThreshold`.
+     */
+    trackSlowQueries?: boolean;
+};
+/**
+ * Result of explaining a query with a single plan.
+ */
+export type SingleExplainResult = {
+    /**
+     * Query plan.
+     */
+    plan: ExplainPlan;
+    /**
+     * Whether it would be possible to cache the query.
+     */
+    cacheable: boolean;
+    /**
+     * Warnings encountered while planning the query execution.
+     */
+    warnings: {
+        code: number;
+        message: string;
+    }[];
+    /**
+     * Optimizer statistics for the explained query.
+     */
+    stats: ExplainStats;
+};
+/**
+ * Result of explaining a query with multiple plans.
+ */
+export type MultiExplainResult = {
+    /**
+     * Query plans.
+     */
+    plans: ExplainPlan[];
+    /**
+     * Whether it would be possible to cache the query.
+     */
+    cacheable: boolean;
+    /**
+     * Warnings encountered while planning the query execution.
+     */
+    warnings: {
+        code: number;
+        message: string;
+    }[];
+    /**
+     * Optimizer statistics for the explained query.
+     */
+    stats: ExplainStats;
+};
+/**
+ * Plan explaining query execution.
+ */
+export type ExplainPlan = {
+    /**
+     * Execution nodes in this plan.
+     */
+    nodes: {
+        [key: string]: any;
+        type: string;
+        id: number;
+        dependencies: number[];
+        estimatedCost: number;
+        estimatedNrItems: number;
+    }[];
+    /**
+     * Rules applied by the optimizer.
+     */
+    rules: string[];
+    /**
+     * Information about collections involved in the query.
+     */
+    collections: {
+        name: string;
+        type: "read" | "write";
+    }[];
+    /**
+     * Variables used in the query.
+     */
+    variables: {
+        id: number;
+        name: string;
+    }[];
+    /**
+     * Total estimated cost of the plan.
+     */
+    estimatedCost: number;
+    /**
+     * Estimated number of items returned by the query.
+     */
+    estimatedNrItems: number;
+    /**
+     * Whether the query is a data modification query.
+     */
+    isModificationQuery: boolean;
+};
+/**
+ * Optimizer statistics for an explained query.
+ */
+export type ExplainStats = {
+    /**
+     * Total number of rules executed for this query.
+     */
+    rulesExecuted: number;
+    /**
+     * Number of rules skipped for this query.
+     */
+    rulesSkipped: number;
+    /**
+     * Total number of plans created.
+     */
+    plansCreated: number;
+    /**
+     * Maximum memory usage in bytes of the query during explain.
+     */
+    peakMemoryUsage: number;
+    /**
+     * Time in seconds needed to explain the query.
+     */
+    executionTime: number;
+};
+/**
+ * Result of parsing a query.
+ */
+export type ParseResult = {
+    /**
+     * Whether the query was parsed.
+     */
+    parsed: boolean;
+    /**
+     * Names of all collections involved in the query.
+     */
+    collections: string[];
+    /**
+     * Names of all bind parameters used in the query.
+     */
+    bindVars: string[];
+    /**
+     * Abstract syntax tree (AST) of the query.
+     */
+    ast: AstNode[];
+};
+/**
+ * Node in an AQL abstract syntax tree (AST).
+ */
+export type AstNode = {
+    [key: string]: any;
+    type: string;
+    subNodes: AstNode[];
+};
+/**
+ * Optimizer rule for AQL queries.
+ */
+export type QueryOptimizerRule = {
+    name: string;
+    flags: {
+        hidden: boolean;
+        clusterOnly: boolean;
+        canBeDisabled: boolean;
+        canCreateAdditionalPlans: boolean;
+        disabledByDefault: boolean;
+        enterpriseOnly: boolean;
+    };
+};
+/**
+ * Information about query tracking.
+ */
+export type QueryTrackingInfo = {
+    /**
+     * Whether query tracking is enabled.
+     */
+    enabled: boolean;
+    /**
+     * Maximum query string length in bytes that is kept in the list.
+     */
+    maxQueryStringLength: number;
+    /**
+     * Maximum number of slow queries that is kept in the list.
+     */
+    maxSlowQueries: number;
+    /**
+     * Threshold execution time in seconds for when a query is
+     * considered slow.
+     */
+    slowQueryThreshold: number;
+    /**
+     * Whether bind parameters are being tracked along with queries.
+     */
+    trackBindVars: boolean;
+    /**
+     * Whether slow queries are being tracked.
+     */
+    trackSlowQueries: boolean;
+};
+/**
+ * Object describing a query.
+ */
+export type QueryDescription = {
+    /**
+     * Unique identifier for this query.
+     */
+    id: string;
+    /**
+     * Name of the database the query runs in.
+     */
+    database: string;
+    /**
+     * Name of the user that started the query.
+     */
+    user: string;
+    /**
+     * Query string (potentially truncated).
+     */
+    query: string;
+    /**
+     * Bind parameters used in the query.
+     */
+    bindVars: Record<string, any>;
+    /**
+     * Date and time the query was started.
+     */
+    started: string;
+    /**
+     * Query's running time in seconds.
+     */
+    runTime: number;
+    /**
+     * Maximum memory usage in bytes of the query.
+     */
+    peakMemoryUsage: number;
+    /**
+     * Query's current execution state.
+     */
+    state: "executing" | "finished" | "killed";
+    /**
+     * Whether the query uses a streaming cursor.
+     */
+    stream: boolean;
+};
+/**
+ * Definition of an AQL User Function.
+ */
+export type UserFunctionDescription = {
+    /**
+     * Name of the AQL User Function.
+     */
+    name: string;
+    /**
+     * Implementation of the AQL User Function.
+     */
+    code: string;
+    /**
+     * Whether the function is deterministic.
+     *
+     * See {@link Database#createFunction}.
+     */
+    isDeterministic: boolean;
+};
+//# sourceMappingURL=queries.d.ts.map

package/cjs/queries.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../src/queries.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAGH;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;;OAKG;IACH,SAAS,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IAChC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;;;OAKG;IACH,SAAS,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IAChC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC;AAKF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC9C;;OAEG;IACH,KAAK,EAAE,YAAY,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC9C;;OAEG;IACH,KAAK,EAAE,YAAY,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,KAAK,EAAE;QACL,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;QACnB,IAAI,EAAE,MAAM,CAAC;QACb,EAAE,EAAE,MAAM,CAAC;QACX,YAAY,EAAE,MAAM,EAAE,CAAC;QACvB,aAAa,EAAE,MAAM,CAAC;QACtB,gBAAgB,EAAE,MAAM,CAAC;KAC1B,EAAE,CAAC;IACJ;;OAEG;IACH,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB;;OAEG;IACH,WAAW,EAAE;QACX,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,EAAE,CAAC;IACJ;;OAEG;IACH,SAAS,EAAE;QACT,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;KACd,EAAE,CAAC;IACJ;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB;;OAEG;IACH,GAAG,EAAE,OAAO,EAAE,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE;QACL,MAAM,EAAE,OAAO,CAAC;QAChB,WAAW,EAAE,OAAO,CAAC;QACrB,aAAa,EAAE,OAAO,CAAC;QACvB,wBAAwB,EAAE,OAAO,CAAC;QAClC,iBAAiB,EAAE,OAAO,CAAC;QAC3B,cAAc,EAAE,OAAO,CAAC;KACzB,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;CAC3B,CAAC;AAIF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,KAAK,EAAE,WAAW,GAAG,UAAU,GAAG,QAAQ,CAAC;IAC3C;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAIF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,eAAe,EAAE,OAAO,CAAC;CAC1B,CAAC"}

package/cjs/queries.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * ```ts
+ * import type { QueryOptions } from "arangojs/queries";
+ * ```
+ *
+ * The "query" module provides query related types for TypeScript.
+ *
+ * @packageDocumentation
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//#endregion
+//# sourceMappingURL=queries.js.map

package/cjs/queries.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queries.js","sourceRoot":"","sources":["../../src/queries.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;AAwfH,YAAY","sourcesContent":["/**\n * ```ts\n * import type { QueryOptions } from \"arangojs/queries\";\n * ```\n *\n * The \"query\" module provides query related types for TypeScript.\n *\n * @packageDocumentation\n */\n\n//#region Query operation options\n/**\n * Options for executing a query.\n *\n * See {@link databases.Database#query}.\n */\nexport type QueryOptions = {\n  /**\n   * If set to `true`, the query will be executed with support for dirty reads\n   * enabled, permitting ArangoDB to return a potentially dirty or stale result\n   * and arangojs will load balance the request without distinguishing between\n   * leaders and followers.\n   *\n   * Note that dirty reads are only supported for read-only queries, not data\n   * modification queries (e.g. using `INSERT`, `UPDATE`, `REPLACE` or\n   * `REMOVE`) and only when using ArangoDB 3.4 or later.\n   *\n   * Default: `false`\n   */\n  allowDirtyRead?: boolean;\n  /**\n   * If set to `true`, cursor results will be stored by ArangoDB in such a way\n   * that batch reads can be retried in the case of a communication error.\n   *\n   * Default: `false`\n   */\n  allowRetry?: boolean;\n  /**\n   * Maximum time in milliseconds arangojs will wait for a server response.\n   * Exceeding this value will result in the request being cancelled.\n   *\n   * **Note**: Setting a timeout for the client does not guarantee the query\n   * will be killed by ArangoDB if it is already being executed. See the\n   * `maxRuntime` option for limiting the execution time within ArangoDB.\n   */\n  timeout?: number;\n  /**\n   * If set to a positive number, the query will automatically be retried at\n   * most this many times if it results in a write-write conflict.\n   *\n   * Default: `0`\n   */\n  retryOnConflict?: number;\n  /**\n   * Unless set to `false`, the number of result values in the result set will\n   * be returned in the `count` attribute. This may be disabled by default in\n   * a future version of ArangoDB if calculating this value has a performance\n   * impact for some queries.\n   *\n   * Default: `true`.\n   */\n  count?: boolean;\n  /**\n   * Number of result values to be transferred by the server in each\n   * network roundtrip (or \"batch\").\n   *\n   * Must be greater than zero.\n   */\n  batchSize?: number;\n  /**\n   * If set to `false`, the AQL query results cache lookup will be skipped for\n   * this query.\n   *\n   * Default: `true`\n   */\n  cache?: boolean;\n  /**\n   * Maximum memory size in bytes that the query is allowed to use.\n   * Exceeding this value will result in the query failing with an error.\n   *\n   * If set to `0`, the memory limit is disabled.\n   *\n   * Default: `0`\n   */\n  memoryLimit?: number;\n  /**\n   * Maximum allowed execution time before the query will be killed in seconds.\n   *\n   * If set to `0`, the query will be allowed to run indefinitely.\n   *\n   * Default: `0`\n   */\n  maxRuntime?: number;\n  /**\n   * Time-to-live for the cursor in seconds. The cursor results may be\n   * garbage collected by ArangoDB after this much time has passed.\n   *\n   * Default: `30`\n   */\n  ttl?: number;\n  /**\n   * If set to `true`, the query will throw an exception and abort if it would\n    otherwise produce a warning.\n   */\n  failOnWarning?: boolean;\n  /**\n   * If set to `1` or `true`, additional query profiling information will be\n   * returned in the `extra.profile` attribute if the query is not served from\n   * the result cache.\n   *\n   * If set to `2`, the query will return execution stats per query plan node\n   * in the `extra.stats.nodes` attribute. Additionally the query plan is\n   * returned in `extra.plan`.\n   */\n  profile?: boolean | number;\n  /**\n   * If set to `true`, the query will be executed as a streaming query.\n   */\n  stream?: boolean;\n  /**\n   * Limits the maximum number of warnings a query will return.\n   */\n  maxWarningsCount?: number;\n  /**\n   * If set to `true` and the query has a `LIMIT` clause, the total number of\n   * values matched before the last top-level `LIMIT` in the query was applied\n   * will be returned in the `extra.stats.fullCount` attribute.\n   */\n  fullCount?: boolean;\n  /**\n   * If set to `false`, the query data will not be stored in the RocksDB block\n   * cache. This can be used to avoid thrashing he block cache when reading a\n   * lot of data.\n   */\n  fillBlockCache?: boolean;\n  /**\n   * An object with a `rules` property specifying a list of optimizer rules to\n   * be included or excluded by the optimizer for this query. Prefix a rule\n   * name with `+` to include it, or `-` to exclude it. The name `all` acts as\n   * an alias matching all optimizer rules.\n   */\n  optimizer?: { rules: string[] };\n  /**\n   * Limits the maximum number of plans that will be created by the AQL query\n   * optimizer.\n   */\n  maxPlans?: number;\n  /**\n   * Controls after how many execution nodes in a query a stack split should be\n   * performed.\n   *\n   * Default: `250` (`200` on macOS)\n   */\n  maxNodesPerCallstack?: number;\n  /**\n   * Maximum size of transactions in bytes.\n   */\n  maxTransactionSize?: number;\n  /**\n   * Maximum number of operations after which an intermediate commit is\n   * automatically performed.\n   */\n  intermediateCommitCount?: number;\n  /**\n   * Maximum total size of operations in bytes after which an intermediate\n   * commit is automatically performed.\n   */\n  intermediateCommitSize?: number;\n  /**\n   * (Enterprise Edition cluster only.) If set to `true`, collections\n   * inaccessible to current user will result in an access error instead\n   * of being treated as empty.\n   */\n  skipInaccessibleCollections?: boolean;\n  /**\n   * (Enterprise Edition cluster only.) Limits the maximum time in seconds a\n   * DBServer will wait to bring satellite collections involved in the query\n   * into sync. Exceeding this value will result in the query being stopped.\n   *\n   * Default: `60`\n   */\n  satelliteSyncWait?: number;\n};\n\n/**\n * Options for explaining a query.\n *\n * See {@link Database#explain}.\n */\nexport type ExplainOptions = {\n  /**\n   * An object with a `rules` property specifying a list of optimizer rules to\n   * be included or excluded by the optimizer for this query. Prefix a rule\n   * name with `+` to include it, or `-` to exclude it. The name `all` acts as\n   * an alias matching all optimizer rules.\n   */\n  optimizer?: { rules: string[] };\n  /**\n   * Maximum number of plans that the optimizer is allowed to generate.\n   * Setting this to a low value limits the amount of work the optimizer does.\n   */\n  maxNumberOfPlans?: number;\n  /**\n   * If set to true, all possible execution plans will be returned as the\n   * `plans` property. Otherwise only the optimal execution plan will be\n   * returned as the `plan` property.\n   *\n   * Default: `false`\n   */\n  allPlans?: boolean;\n};\n\n/**\n * Options for query tracking.\n *\n * See {@link Database#queryTracking}.\n */\nexport type QueryTrackingOptions = {\n  /**\n   * If set to `false`, neither queries nor slow queries will be tracked.\n   */\n  enabled?: boolean;\n  /**\n   * Maximum query string length in bytes that will be kept in the list.\n   */\n  maxQueryStringLength?: number;\n  /**\n   * Maximum number of slow queries to be kept in the list.\n   */\n  maxSlowQueries?: number;\n  /**\n   * Threshold execution time in seconds for when a query will be\n   * considered slow.\n   */\n  slowQueryThreshold?: number;\n  /**\n   * If set to `true`, bind parameters will be tracked along with queries.\n   */\n  trackBindVars?: boolean;\n  /**\n   * If set to `true` and `enabled` is also set to `true`, slow queries will be\n   * tracked if their execution time exceeds `slowQueryThreshold`.\n   */\n  trackSlowQueries?: boolean;\n};\n\n//#endregion\n\n//#region Query operation results\n/**\n * Result of explaining a query with a single plan.\n */\nexport type SingleExplainResult = {\n  /**\n   * Query plan.\n   */\n  plan: ExplainPlan;\n  /**\n   * Whether it would be possible to cache the query.\n   */\n  cacheable: boolean;\n  /**\n   * Warnings encountered while planning the query execution.\n   */\n  warnings: { code: number; message: string }[];\n  /**\n   * Optimizer statistics for the explained query.\n   */\n  stats: ExplainStats;\n};\n\n/**\n * Result of explaining a query with multiple plans.\n */\nexport type MultiExplainResult = {\n  /**\n   * Query plans.\n   */\n  plans: ExplainPlan[];\n  /**\n   * Whether it would be possible to cache the query.\n   */\n  cacheable: boolean;\n  /**\n   * Warnings encountered while planning the query execution.\n   */\n  warnings: { code: number; message: string }[];\n  /**\n   * Optimizer statistics for the explained query.\n   */\n  stats: ExplainStats;\n};\n\n/**\n * Plan explaining query execution.\n */\nexport type ExplainPlan = {\n  /**\n   * Execution nodes in this plan.\n   */\n  nodes: {\n    [key: string]: any;\n    type: string;\n    id: number;\n    dependencies: number[];\n    estimatedCost: number;\n    estimatedNrItems: number;\n  }[];\n  /**\n   * Rules applied by the optimizer.\n   */\n  rules: string[];\n  /**\n   * Information about collections involved in the query.\n   */\n  collections: {\n    name: string;\n    type: \"read\" | \"write\";\n  }[];\n  /**\n   * Variables used in the query.\n   */\n  variables: {\n    id: number;\n    name: string;\n  }[];\n  /**\n   * Total estimated cost of the plan.\n   */\n  estimatedCost: number;\n  /**\n   * Estimated number of items returned by the query.\n   */\n  estimatedNrItems: number;\n  /**\n   * Whether the query is a data modification query.\n   */\n  isModificationQuery: boolean;\n};\n\n/**\n * Optimizer statistics for an explained query.\n */\nexport type ExplainStats = {\n  /**\n   * Total number of rules executed for this query.\n   */\n  rulesExecuted: number;\n  /**\n   * Number of rules skipped for this query.\n   */\n  rulesSkipped: number;\n  /**\n   * Total number of plans created.\n   */\n  plansCreated: number;\n  /**\n   * Maximum memory usage in bytes of the query during explain.\n   */\n  peakMemoryUsage: number;\n  /**\n   * Time in seconds needed to explain the query.\n   */\n  executionTime: number;\n};\n\n/**\n * Result of parsing a query.\n */\nexport type ParseResult = {\n  /**\n   * Whether the query was parsed.\n   */\n  parsed: boolean;\n  /**\n   * Names of all collections involved in the query.\n   */\n  collections: string[];\n  /**\n   * Names of all bind parameters used in the query.\n   */\n  bindVars: string[];\n  /**\n   * Abstract syntax tree (AST) of the query.\n   */\n  ast: AstNode[];\n};\n\n/**\n * Node in an AQL abstract syntax tree (AST).\n */\nexport type AstNode = {\n  [key: string]: any;\n  type: string;\n  subNodes: AstNode[];\n};\n\n/**\n * Optimizer rule for AQL queries.\n */\nexport type QueryOptimizerRule = {\n  name: string;\n  flags: {\n    hidden: boolean;\n    clusterOnly: boolean;\n    canBeDisabled: boolean;\n    canCreateAdditionalPlans: boolean;\n    disabledByDefault: boolean;\n    enterpriseOnly: boolean;\n  };\n};\n\n/**\n * Information about query tracking.\n */\nexport type QueryTrackingInfo = {\n  /**\n   * Whether query tracking is enabled.\n   */\n  enabled: boolean;\n  /**\n   * Maximum query string length in bytes that is kept in the list.\n   */\n  maxQueryStringLength: number;\n  /**\n   * Maximum number of slow queries that is kept in the list.\n   */\n  maxSlowQueries: number;\n  /**\n   * Threshold execution time in seconds for when a query is\n   * considered slow.\n   */\n  slowQueryThreshold: number;\n  /**\n   * Whether bind parameters are being tracked along with queries.\n   */\n  trackBindVars: boolean;\n  /**\n   * Whether slow queries are being tracked.\n   */\n  trackSlowQueries: boolean;\n};\n//#endregion\n\n//#region QueryDescription\n/**\n * Object describing a query.\n */\nexport type QueryDescription = {\n  /**\n   * Unique identifier for this query.\n   */\n  id: string;\n  /**\n   * Name of the database the query runs in.\n   */\n  database: string;\n  /**\n   * Name of the user that started the query.\n   */\n  user: string;\n  /**\n   * Query string (potentially truncated).\n   */\n  query: string;\n  /**\n   * Bind parameters used in the query.\n   */\n  bindVars: Record<string, any>;\n  /**\n   * Date and time the query was started.\n   */\n  started: string;\n  /**\n   * Query's running time in seconds.\n   */\n  runTime: number;\n  /**\n   * Maximum memory usage in bytes of the query.\n   */\n  peakMemoryUsage: number;\n  /**\n   * Query's current execution state.\n   */\n  state: \"executing\" | \"finished\" | \"killed\";\n  /**\n   * Whether the query uses a streaming cursor.\n   */\n  stream: boolean;\n};\n//#endregion\n\n//#region UserFunctionDescription\n/**\n * Definition of an AQL User Function.\n */\nexport type UserFunctionDescription = {\n  /**\n   * Name of the AQL User Function.\n   */\n  name: string;\n  /**\n   * Implementation of the AQL User Function.\n   */\n  code: string;\n  /**\n   * Whether the function is deterministic.\n   *\n   * See {@link Database#createFunction}.\n   */\n  isDeterministic: boolean;\n};\n//#endregion"]}