arangojs 7.8.0 → 8.0.0

package/indexes.d.ts

@@ -3,11 +3,10 @@
  * import type {
  *   FulltextIndex,
  *   GeoIndex,
- *   HashIndex,
  *   PersistentIndex,
  *   PrimaryIndex,
- *   SkiplistIndex,
  *   TtlIndex,
+ *   ZkdIndex,
  * } from "arangojs/indexes";
  * ```
  *
@@ -15,20 +14,16 @@
  *
  * @packageDocumentation
  */
+import { AnalyzerFeature } from "./analyzer";
+import { Compression, Direction, TierConsolidationPolicy } from "./view";
 /**
- * (MMFiles only.) Options for creating a hash index.
- *
- * When using the RocksDB storage engine, this index type behaves identically
- * to {@link EnsurePersistentIndexOptions}.
- *
- * @deprecated Hash indexes have been deprecated in ArangoDB 3.9 and should be
- * replaced with persistent indexes.
+ * Options for creating a persistent index.
  */
-export declare type EnsureHashIndexOptions = {
+export declare type EnsurePersistentIndexOptions = {
     /**
      * Type of this index.
      */
-    type: "hash";
+    type: "persistent";
     /**
      * An array of attribute paths.
      */
@@ -52,7 +47,8 @@ export declare type EnsureHashIndexOptions = {
      */
     sparse?: boolean;
     /**
-     * If set to `false`, array values will not be deduplicated.
+     * If set to `false`, inserting duplicate index values from the same
+     * document will lead to a unique constraint error if this is a unique index.
      *
      * Default: `true`
      */
@@ -71,108 +67,18 @@ export declare type EnsureHashIndexOptions = {
      * Default: `false`
      */
     inBackground?: boolean;
-};
-/**
- * (MMFiles only.) Options for creating a skiplist index.
- *
- * When using the RocksDB storage engine, this index type behaves identically
- * to {@link EnsurePersistentIndexOptions}.
- *
- * @deprecated Skiplist indexes have been deprecated in ArangoDB 3.9 and should
- * be replaced with persistent indexes.
- */
-export declare type EnsureSkiplistIndexOptions = {
-    /**
-     * Type of this index.
-     */
-    type: "skiplist";
     /**
-     * An array of attribute paths.
-     */
-    fields: string[];
-    /**
-     * A unique name for this index.
-     */
-    name?: string;
-    /**
-     * If set to `true`, a unique index will be created.
+     * If set to `true`, an in-memory hash cache will be put in front of the
+     * persistent index.
      *
      * Default: `false`
      */
-    unique?: boolean;
-    /**
-     * If set to `true`, the index will omit documents that do not contain at
-     * least one of the attribute paths in `fields` and these documents will be
-     * ignored for uniqueness checks.
-     *
-     * Default: `false`
-     */
-    sparse?: boolean;
-    /**
-     * If set to `false`, array values will not be deduplicated.
-     *
-     * Default: `true`
-     */
-    deduplicate?: boolean;
-    /**
-     * If set to `false`, index selectivity estimates will be disabled for this
-     * index.
-     *
-     * Default: `true`
-     */
-    estimates?: boolean;
+    cacheEnabled?: boolean;
     /**
-     * If set to `true`, the index will be created in the background to reduce
-     * the write-lock duration for the collection during index creation.
-     *
-     * Default: `false`
+     * An array of attribute paths that will be stored in the index but can not
+     * be used for index lookups or sorting but can avoid full document lookups.
      */
-    inBackground?: boolean;
-};
-/**
- * Options for creating a persistent index.
- */
-export declare type EnsurePersistentIndexOptions = {
-    /**
-     * Type of this index.
-     */
-    type: "persistent";
-    /**
-     * An array of attribute paths.
-     */
-    fields: string[];
-    /**
-     * A unique name for this index.
-     */
-    name?: string;
-    /**
-     * If set to `true`, a unique index will be created.
-     *
-     * Default: `false`
-     */
-    unique?: boolean;
-    /**
-     * If set to `true`, the index will omit documents that do not contain at
-     * least one of the attribute paths in `fields` and these documents will be
-     * ignored for uniqueness checks.
-     *
-     * Default: `false`
-     */
-    sparse?: boolean;
-    /**
-     * If set to `false`, index selectivity estimates will be disabled for this
-     * index.
-     *
-     * Default: `true`
-     */
-    estimates?: boolean;
-    /**
-     * If set to `true`, the index will be created in the background to reduce
-     * the write-lock duration for the collection during index creation.
-     *
-     * Default: `false`
-     */
-    inBackground?: boolean;
+    storedValues?: string[];
 };
 /**
  * Options for creating a geo index.
@@ -188,6 +94,12 @@ export declare type EnsureGeoIndexOptions = {
      * Default: `false`
      */
     geoJson?: false;
+    /**
+     * If set to `true`, the index will use pre-3.10 rules for parsing
+     * GeoJSON polygons. This option is always implicitly `true` when using
+     * ArangoDB 3.9 or lower.
+     */
+    legacyPolygons?: boolean;
     /**
      * Attribute paths for the document's latitude and longitude values.
      */
@@ -214,6 +126,12 @@ export declare type EnsureGeoIndexOptions = {
      * Default: `false`
      */
     geoJson?: boolean;
+    /**
+     * If set to `true`, the index will use pre-3.10 rules for parsing
+     * GeoJSON polygons. This option is always implicitly `true` when using
+     * ArangoDB 3.9 or lower.
+     */
+    legacyPolygons?: boolean;
     /**
      * An array containing the attribute path for an array containing two values,
      * the first of which will be interpreted as the latitude, the second as the
@@ -235,6 +153,9 @@ export declare type EnsureGeoIndexOptions = {
 };
 /**
  * Options for creating a fulltext index.
+ *
+ * @deprecated Fulltext indexes have been deprecated in ArangoDB 3.10 and
+ * should be replaced with ArangoSearch.
  */
 export declare type EnsureFulltextIndexOptions = {
     /**
@@ -310,6 +231,264 @@ export declare type EnsureZkdIndexOptions = {
      * A unique name for this index.
      */
     name?: string;
+    /**
+     * If set to `true`, a unique index will be created.
+     *
+     * Default: `false`
+     */
+    unique?: boolean;
+    /**
+     * If set to `true`, the index will be created in the background to reduce
+     * the write-lock duration for the collection during index creation.
+     *
+     * Default: `false`
+     */
+    inBackground?: boolean;
+};
+/**
+ * (Enterprise Edition only.) Options for a nested field in an inverted index.
+ */
+export declare type InvertedIndexNestedFieldOptions = {
+    /**
+     * An attribute path.
+     */
+    name: string;
+    /**
+     * Name of the Analyzer to apply to the values of this field.
+     *
+     * Defaults to the `analyzer` specified on the parent options or on the index
+     * itself.
+     */
+    analyzer?: string;
+    /**
+     * List of Analyzer features to enable for this field's Analyzer.
+     *
+     * Defaults to the features of the Analyzer.
+     */
+    features?: AnalyzerFeature[];
+    /**
+     * If set to `true` array values will be indexed using the same behavior as
+     * ArangoSearch Views. This option only applies when using the index in a
+     * SearchAlias View.
+     *
+     * Defaults to the value of `searchField` specified on the index itself.
+     */
+    searchField?: boolean;
+    /**
+     * Sub-objects to index to allow querying for co-occurring values.
+     */
+    nested?: (string | InvertedIndexNestedFieldOptions)[];
+};
+/**
+ * Options for an attribute path in an inverted index.
+ */
+export declare type InvertedIndexFieldOptions = {
+    /**
+     * An attribute path.
+     */
+    name: string;
+    /**
+     * Name of the Analyzer to apply to the values of this field.
+     *
+     * Defaults to the `analyzer` specified on the index itself.
+     */
+    analyzer?: string;
+    /**
+     * List of Analyzer features to enable for this field's Analyzer.
+     *
+     * Defaults to the features of the Analyzer.
+     */
+    features?: AnalyzerFeature[];
+    /**
+     * If set to `true`, all document attributes are indexed, excluding any
+     * sub-attributes configured in the `fields` array. The `analyzer` and
+     * `features` properties apply to the sub-attributes. This option only
+     * applies when using the index in a SearchAlias View.
+     *
+     * Defaults to the value of `includeAllFields` specified on the index itself.
+     */
+    includeAllFields?: boolean;
+    /**
+     * If set to `true` array values will be indexed using the same behavior as
+     * ArangoSearch Views. This option only applies when using the index in a
+     * SearchAlias View.
+     *
+     * Defaults to the value of `searchField` specified on the index itself.
+     */
+    searchField?: boolean;
+    /**
+     * If set to `true`, the position of values in array values are tracked and
+     * need to be specified in queries. Otherwise all values in an array are
+     * treated as equivalent. This option only applies when using the index in a
+     * SearchAlias View.
+     *
+     * Defaults to the value of `trackListPositions` specified on the index
+     * itself.
+     */
+    trackListPositions?: boolean;
+    /**
+     * (Enterprise Edition only.) Sub-objects to index to allow querying for
+     * co-occurring values.
+     */
+    nested?: (string | InvertedIndexNestedFieldOptions)[];
+};
+/**
+ * Options for defining a stored value on an inverted index.
+ */
+export declare type InvertedIndexStoredValueOptions = {
+    /**
+     * The attribute paths to store.
+     */
+    fields: string[];
+    /**
+     * How the attribute values should be compressed.
+     *
+     * Default: `"lz4"`
+     */
+    compression?: Compression;
+};
+/**
+ * Options for defining a primary sort field on an inverted index.
+ */
+export declare type InvertedIndexPrimarySortFieldOptions = {
+    /**
+     * The attribute path to sort by.
+     */
+    field: string;
+    /**
+     * The sorting direction.
+     */
+    direction: Direction;
+};
+/**
+ * Options for creating an inverted index.
+ */
+export declare type EnsureInvertedIndexOptions = {
+    /**
+     * Type of this index.
+     */
+    type: "inverted";
+    /**
+     * An array of attribute paths or objects specifying options for the fields.
+     */
+    fields: (string | InvertedIndexFieldOptions)[];
+    /**
+     * A unique name for this index.
+     */
+    name?: string;
+    /**
+     * If set to `true` array values will by default be indexed using the same
+     * behavior as ArangoSearch Views. This option only applies when using the
+     * index in a SearchAlias View.
+     *
+     * Default: `false`
+     */
+    searchField?: boolean;
+    /**
+     * An array of attribute paths that will be stored in the index but can not
+     * be used for index lookups or sorting but can avoid full document lookups.
+     */
+    storedValues?: InvertedIndexStoredValueOptions[];
+    /**
+     * Primary sort order to optimize AQL queries using a matching sort order.
+     */
+    primarySort?: {
+        /**
+         * An array of fields to sort the index by.
+         */
+        fields: InvertedIndexPrimarySortFieldOptions[];
+        /**
+         * How the primary sort data should be compressed.
+         *
+         * Default: `"lz4"`
+         */
+        compression?: Compression;
+    };
+    /**
+     * Name of the default Analyzer to apply to the values of indexed fields.
+     *
+     * Default: `"identity"`
+     */
+    analyzer?: string;
+    /**
+     * List of Analyzer features to enable for the default Analyzer.
+     *
+     * Defaults to the Analyzer's features.
+     */
+    features?: AnalyzerFeature[];
+    /**
+     * If set to `true`, all document attributes are indexed, excluding any
+     * sub-attributes configured in the `fields` array. The `analyzer` and
+     * `features` properties apply to the sub-attributes. This option only
+     * applies when using the index in a SearchAlias View.
+     *
+     * Default: `false`
+     */
+    includeAllFields?: boolean;
+    /**
+     * If set to `true`, the position of values in array values are tracked and
+     * need to be specified in queries. Otherwise all values in an array are
+     * treated as equivalent. This option only applies when using the index in a
+     * SearchAlias View.
+     *
+     * Default: `false`
+     */
+    trackListPositions?: boolean;
+    /**
+     * The number of threads to use for indexing the fields.
+     *
+     * Default: `2`
+     */
+    parallelism?: number;
+    /**
+     * Wait at least this many commits between removing unused files in the
+     * ArangoSearch data directory.
+     *
+     * Default: `2`
+     */
+    cleanupIntervalStep?: number;
+    /**
+     * Wait at least this many milliseconds between committing View data store
+     * changes and making documents visible to queries.
+     *
+     * Default: `1000`
+     */
+    commitIntervalMsec?: number;
+    /**
+     * Wait at least this many milliseconds between applying
+     * `consolidationPolicy` to consolidate View data store and possibly release
+     * space on the filesystem.
+     *
+     * Default: `1000`
+     */
+    consolidationIntervalMsec?: number;
+    /**
+     * The consolidation policy to apply for selecting which segments should be
+     * merged.
+     *
+     * Default: `{ type: "tier" }`
+     */
+    consolidationPolicy?: TierConsolidationPolicy;
+    /**
+     * Maximum number of writers (segments) cached in the pool.
+     *
+     * Default: `64`
+     */
+    writeBufferIdle?: number;
+    /**
+     * Maximum number of concurrent active writers (segments) that perform a
+     * transaction.
+     *
+     * Default: `0` (disabled)
+     */
+    writeBufferActive?: number;
+    /**
+     * Maximum memory byte size per writer (segment) before a writer (segment)
+     * flush is triggered.
+     *
+     * Default: `33554432` (32 MiB)
+     */
+    writeBufferSizeMax?: number;
     /**
      * If set to `true`, the index will be created in the background to reduce
      * the write-lock duration for the collection during index creation.
@@ -325,7 +504,7 @@ export declare type GenericIndex = {
     /**
      * A unique name for this index.
      */
-    name?: string;
+    name: string;
     /**
      * A unique identifier for this index.
      */
@@ -346,21 +525,10 @@ export declare type GenericIndex = {
 export declare type PersistentIndex = GenericIndex & {
     type: "persistent";
     fields: string[];
-};
-/**
- * An object representing a skiplist index.
- */
-export declare type SkiplistIndex = GenericIndex & {
-    type: "skiplist";
-    fields: string[];
-};
-/**
- * An object representing a hash index.
- */
-export declare type HashIndex = GenericIndex & {
-    type: "hash";
-    fields: string[];
-    selectivityEstimate: number;
+    cacheEnabled: boolean;
+    deduplicate: boolean;
+    estimates: boolean;
+    storedValues?: string[];
 };
 /**
  * An object representing a primary index.
@@ -372,6 +540,9 @@ export declare type PrimaryIndex = GenericIndex & {
 };
 /**
  * An object representing a fulltext index.
+ *
+ * @deprecated Fulltext indexes have been deprecated in ArangoDB 3.10 and
+ * should be replaced with ArangoSearch.
  */
 export declare type FulltextIndex = GenericIndex & {
     type: "fulltext";
@@ -385,6 +556,7 @@ export declare type GeoIndex = GenericIndex & {
     type: "geo";
     fields: [string] | [string, string];
     geoJson: boolean;
+    legacyPolygons: boolean;
     bestIndexedLevel: number;
     worstIndexedLevel: number;
     maxNumCoverCells: number;
@@ -399,17 +571,67 @@ export declare type TtlIndex = GenericIndex & {
     selectivityEstimate: number;
 };
 /**
- * An object representing a TTL index.
+ * An object representing a ZKD index.
  */
 export declare type ZkdIndex = GenericIndex & {
     type: "zkd";
     fields: string[];
     fieldValueTypes: "double";
 };
+/**
+ * (Enterprise Edition only.) An object representing a nested field in an
+ * inverted index.
+ */
+export declare type InvertedIndexNestedField = {
+    name: string;
+    analyzer?: string;
+    features?: AnalyzerFeature[];
+    searchField?: boolean;
+    nested?: InvertedIndexNestedField[];
+};
+/**
+ * An object representing an inverted index.
+ */
+export declare type InvertedIndex = GenericIndex & {
+    type: "inverted";
+    fields: {
+        name: string;
+        analyzer?: string;
+        features?: AnalyzerFeature[];
+        includeAllFields?: boolean;
+        searchField?: boolean;
+        trackListPositions?: boolean;
+        nested?: InvertedIndexNestedField[];
+    }[];
+    searchField: boolean;
+    storedValues: {
+        fields: string[];
+        compression: Compression;
+    }[];
+    primarySort: {
+        fields: {
+            field: string;
+            direction: Direction;
+        }[];
+        compression: Compression;
+    };
+    analyzer: string;
+    features: AnalyzerFeature[];
+    includeAllFields: boolean;
+    trackListPositions: boolean;
+    parallelism: number;
+    cleanupIntervalStep: number;
+    commitIntervalMsec: number;
+    consolidationIntervalMsec: number;
+    consolidationPolicy: Required<TierConsolidationPolicy>;
+    writeBufferIdle: number;
+    writeBufferActive: number;
+    writeBufferSizeMax: number;
+};
 /**
  * An object representing an index.
  */
-export declare type Index = GeoIndex | FulltextIndex | PersistentIndex | PrimaryIndex | HashIndex | SkiplistIndex | TtlIndex | ZkdIndex;
+export declare type Index = GeoIndex | FulltextIndex | PersistentIndex | PrimaryIndex | TtlIndex | ZkdIndex | InvertedIndex;
 export declare type ObjectWithId = {
     [key: string]: any;
     id: string;
@@ -424,7 +646,6 @@ export declare type ObjectWithName = {
 export declare type IndexSelector = ObjectWithId | ObjectWithName | string;
 /**
  * @internal
- * @hidden
  */
 export declare function _indexHandle(selector: IndexSelector, collectionName: string): string;
 //# sourceMappingURL=indexes.d.ts.map

package/indexes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"indexes.d.ts","sourceRoot":"","sources":["../src/indexes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH;;;;;;;;GAQG;AACH,oBAAY,sBAAsB,GAAG;IACnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;;;;;;;GAQG;AACH,oBAAY,0BAA0B,GAAG;IACvC;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,oBAAY,4BAA4B,GAAG;IACzC;;OAEG;IACH,IAAI,EAAE,YAAY,CAAC;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,oBAAY,qBAAqB,GAC7B;IACE,IAAI,EAAE,KAAK,CAAC;IACZ;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB;;OAEG;IACH,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,GACD;IACE,IAAI,EAAE,KAAK,CAAC;IACZ;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;;OAKG;IACH,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEN;;GAEG;AACH,oBAAY,0BAA0B,GAAG;IACvC;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,oBAAY,qBAAqB,GAAG;IAClC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IACZ;;OAEG;IACH,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,oBAAY,qBAAqB,GAAG;IAClC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IACZ;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB;;OAEG;IACH,eAAe,EAAE,QAAQ,CAAC;IAC1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,oBAAY,YAAY,GAAG;IACzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,oBAAY,eAAe,GAAG,YAAY,GAAG;IAC3C,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,oBAAY,aAAa,GAAG,YAAY,GAAG;IACzC,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,oBAAY,SAAS,GAAG,YAAY,GAAG;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,mBAAmB,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,oBAAY,YAAY,GAAG,YAAY,GAAG;IACxC,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,mBAAmB,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,oBAAY,aAAa,GAAG,YAAY,GAAG;IACzC,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,oBAAY,QAAQ,GAAG,YAAY,GAAG;IACpC,IAAI,EAAE,KAAK,CAAC;IACZ,MAAM,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,OAAO,EAAE,OAAO,CAAC;IACjB,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,oBAAY,QAAQ,GAAG,YAAY,GAAG;IACpC,IAAI,EAAE,KAAK,CAAC;IACZ,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,mBAAmB,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,oBAAY,QAAQ,GAAG,YAAY,GAAG;IACpC,IAAI,EAAE,KAAK,CAAC;IACZ,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,eAAe,EAAE,QAAQ,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,oBAAY,KAAK,GACb,QAAQ,GACR,aAAa,GACb,eAAe,GACf,YAAY,GACZ,SAAS,GACT,aAAa,GACb,QAAQ,GACR,QAAQ,CAAC;AAEb,oBAAY,YAAY,GAAG;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,oBAAY,cAAc,GAAG;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;GAEG;AACH,oBAAY,aAAa,GAAG,YAAY,GAAG,cAAc,GAAG,MAAM,CAAC;AAEnE;;;GAGG;AACH,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,aAAa,EACvB,cAAc,EAAE,MAAM,GACrB,MAAM,CAoBR"}
+{"version":3,"file":"indexes.d.ts","sourceRoot":"","sources":["../src/indexes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,uBAAuB,EAAE,MAAM,QAAQ,CAAC;AAEzE;;GAEG;AACH,oBAAY,4BAA4B,GAAG;IACzC;;OAEG;IACH,IAAI,EAAE,YAAY,CAAC;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,oBAAY,qBAAqB,GAC7B;IACE,IAAI,EAAE,KAAK,CAAC;IACZ;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,GACD;IACE,IAAI,EAAE,KAAK,CAAC;IACZ;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;;OAKG;IACH,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEN;;;;;GAKG;AACH,oBAAY,0BAA0B,GAAG;IACvC;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,oBAAY,qBAAqB,GAAG;IAClC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IACZ;;OAEG;IACH,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,oBAAY,qBAAqB,GAAG;IAClC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IACZ;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB;;OAEG;IACH,eAAe,EAAE,QAAQ,CAAC;IAC1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,oBAAY,+BAA+B,GAAG;IAC5C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;IAC7B;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,MAAM,GAAG,+BAA+B,CAAC,EAAE,CAAC;CACvD,CAAC;AAEF;;GAEG;AACH,oBAAY,yBAAyB,GAAG;IACtC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;IAC7B;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,MAAM,CAAC,EAAE,CAAC,MAAM,GAAG,+BAA+B,CAAC,EAAE,CAAC;CACvD,CAAC;AAEF;;GAEG;AACH,oBAAY,+BAA+B,GAAG;IAC5C;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB;;;;OAIG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,oBAAY,oCAAoC,GAAG;IACjD;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,oBAAY,0BAA0B,GAAG;IACvC;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,CAAC,MAAM,GAAG,yBAAyB,CAAC,EAAE,CAAC;IAC/C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,YAAY,CAAC,EAAE,+BAA+B,EAAE,CAAC;IACjD;;OAEG;IACH,WAAW,CAAC,EAAE;QACZ;;WAEG;QACH,MAAM,EAAE,oCAAoC,EAAE,CAAC;QAC/C;;;;WAIG;QACH,WAAW,CAAC,EAAE,WAAW,CAAC;KAC3B,CAAC;IACF;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;IAC7B;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;;;;;OAOG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;;;OAMG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,uBAAuB,CAAC;IAC9C;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,oBAAY,YAAY,GAAG;IACzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,oBAAY,eAAe,GAAG,YAAY,GAAG;IAC3C,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,YAAY,EAAE,OAAO,CAAC;IACtB,WAAW,EAAE,OAAO,CAAC;IACrB,SAAS,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,oBAAY,YAAY,GAAG,YAAY,GAAG;IACxC,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,mBAAmB,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF;;;;;GAKG;AACH,oBAAY,aAAa,GAAG,YAAY,GAAG;IACzC,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,oBAAY,QAAQ,GAAG,YAAY,GAAG;IACpC,IAAI,EAAE,KAAK,CAAC;IACZ,MAAM,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,OAAO,EAAE,OAAO,CAAC;IACjB,cAAc,EAAE,OAAO,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,oBAAY,QAAQ,GAAG,YAAY,GAAG;IACpC,IAAI,EAAE,KAAK,CAAC;IACZ,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,mBAAmB,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,oBAAY,QAAQ,GAAG,YAAY,GAAG;IACpC,IAAI,EAAE,KAAK,CAAC;IACZ,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,eAAe,EAAE,QAAQ,CAAC;CAC3B,CAAC;AAEF;;;GAGG;AACH,oBAAY,wBAAwB,GAAG;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;IAC7B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,MAAM,CAAC,EAAE,wBAAwB,EAAE,CAAC;CACrC,CAAC;AAEF;;GAEG;AACH,oBAAY,aAAa,GAAG,YAAY,GAAG;IACzC,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;QAC7B,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAC3B,WAAW,CAAC,EAAE,OAAO,CAAC;QACtB,kBAAkB,CAAC,EAAE,OAAO,CAAC;QAC7B,MAAM,CAAC,EAAE,wBAAwB,EAAE,CAAC;KACrC,EAAE,CAAC;IACJ,WAAW,EAAE,OAAO,CAAC;IACrB,YAAY,EAAE;QACZ,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,WAAW,EAAE,WAAW,CAAC;KAC1B,EAAE,CAAC;IACJ,WAAW,EAAE;QACX,MAAM,EAAE;YACN,KAAK,EAAE,MAAM,CAAC;YACd,SAAS,EAAE,SAAS,CAAC;SACtB,EAAE,CAAC;QACJ,WAAW,EAAE,WAAW,CAAC;KAC1B,CAAC;IACF,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,eAAe,EAAE,CAAC;IAC5B,gBAAgB,EAAE,OAAO,CAAC;IAC1B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,yBAAyB,EAAE,MAAM,CAAC;IAClC,mBAAmB,EAAE,QAAQ,CAAC,uBAAuB,CAAC,CAAC;IACvD,eAAe,EAAE,MAAM,CAAC;IACxB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,oBAAY,KAAK,GACb,QAAQ,GACR,aAAa,GACb,eAAe,GACf,YAAY,GACZ,QAAQ,GACR,QAAQ,GACR,aAAa,CAAC;AAElB,oBAAY,YAAY,GAAG;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,oBAAY,cAAc,GAAG;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;GAEG;AACH,oBAAY,aAAa,GAAG,YAAY,GAAG,cAAc,GAAG,MAAM,CAAC;AAEnE;;GAEG;AACH,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,aAAa,EACvB,cAAc,EAAE,MAAM,GACrB,MAAM,CAoBR"}

package/indexes.js

@@ -4,11 +4,10 @@
  * import type {
  *   FulltextIndex,
  *   GeoIndex,
- *   HashIndex,
  *   PersistentIndex,
  *   PrimaryIndex,
- *   SkiplistIndex,
  *   TtlIndex,
+ *   ZkdIndex,
  * } from "arangojs/indexes";
  * ```
  *
@@ -20,7 +19,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports._indexHandle = void 0;
 /**
  * @internal
- * @hidden
  */
 function _indexHandle(selector, collectionName) {
     if (typeof selector !== "string") {