falkordb 6.9.2 → 6.9.3

package/dist/src/graph.d.ts

@@ -1,7 +1,8 @@
 import { RedisArgument } from "@redis/client";
 import { Client } from "./clients/client";
 import { ConstraintType, EntityType } from "./enums";
-import type { GraphReply, MemoryUsageOptions, QueryOptions, QueryReply } from "./types";
+import { ExecutionPlan } from "./execution-plan";
+import type { CallProcedureOptions, ConstraintInfo, GraphReply, IndexInfo, MemoryUsageOptions, PlanOptions, QueryOptions, QueryParam, VectorIndexOptions } from "./types";
 export { ConstraintType, EntityType };
 export type { GraphReply };
 /**
@@ -16,10 +17,14 @@ export interface GraphSchemaState {
 export interface GraphCacheOptions {
     schema?: GraphSchemaState;
     onDelete?: (graph: Graph) => void;
+    selectGraph?: (name: string) => Graph;
+    integers?: "number" | "bigint";
 }
 export default class Graph {
     #private;
     constructor(client: Client, name: string, cache?: GraphCacheOptions);
+    /** The graph's name (its Redis key) */
+    get name(): string;
     query<T>(query: RedisArgument, options?: QueryOptions): Promise<GraphReply<T>>;
     roQuery<T>(query: RedisArgument, options?: QueryOptions): Promise<GraphReply<T>>;
     delete(): Promise<void>;
@@ -31,26 +36,98 @@ export default class Graph {
      * on the next query, so this is rarely needed.
      */
     clearMetadataCache(): void;
-    explain(query: string): Promise<any>;
-    profile(query: string): Promise<any>;
+    /**
+     * Returns the query's execution plan as an operation tree, without running
+     * the query. The lines the server returned are kept in `steps`.
+     */
+    explain(query: string, options?: PlanOptions): Promise<ExecutionPlan>;
+    /**
+     * Runs the query and returns its execution plan as an operation tree, each
+     * operation annotated with its `recordsProduced` and `executionTime`. The
+     * lines the server returned are kept in `steps`.
+     */
+    profile(query: string, options?: PlanOptions): Promise<ExecutionPlan>;
     memoryUsage(options?: MemoryUsageOptions): Promise<import("./types").MemoryUsageReply>;
     slowLog(): Promise<import("./types").SlowLogReply>;
+    /** Clears the graph's slow log (`GRAPH.SLOWLOG <graph> RESET`) */
+    slowLogReset(): Promise<void>;
+    /**
+     * Calls a procedure, e.g. `callProcedure('db.idx.fulltext.queryNodes', ['Movie', 'Jungle'])`.
+     * The arguments are sent as query parameters, so they need no escaping.
+     * Runs as a read-only query unless `readOnly` is `false`.
+     */
+    callProcedure<T>(procedure: string, args?: QueryParam[], options?: CallProcedureOptions): Promise<GraphReply<T>>;
+    /** Lists the graph's indexes (`CALL db.indexes()`) */
+    listIndices(): Promise<IndexInfo[]>;
+    /** Lists the graph's constraints and their status (`CALL db.constraints()`) */
+    listConstraints(): Promise<ConstraintInfo[]>;
+    /**
+     * Creates a constraint (`GRAPH.CONSTRAINT CREATE`).
+     *
+     * A unique constraint requires a range index on each of its properties, so
+     * for `ConstraintType.UNIQUE` this first creates that index on every
+     * property that is not indexed yet (an existing index is reused). Mandatory
+     * constraints need no index and create none.
+     *
+     * The constraint is enforced asynchronously: the server accepts it before
+     * checking the existing data, so poll `listConstraints()` until its status
+     * is `OPERATIONAL` (or `FAILED` if existing entities violate it).
+     */
     constraintCreate(constraintType: ConstraintType, entityType: EntityType, label: string, ...properties: string[]): Promise<void>;
     constraintDrop(constraintType: ConstraintType, entityType: EntityType, label: string, ...properties: string[]): Promise<void>;
-    copy(destGraph: string): Promise<any>;
-    createTypedIndex(idxType: string, entityType: "NODE" | "EDGE", label: string, properties: string[], options?: Record<string, string | number | boolean>): Promise<QueryReply>;
-    createNodeRangeIndex(label: string, ...properties: string[]): Promise<QueryReply>;
-    createNodeFulltextIndex(label: string, ...properties: string[]): Promise<QueryReply>;
-    createNodeVectorIndex(label: string, dim?: number, similarityFunction?: string, ...properties: string[]): Promise<QueryReply>;
-    createEdgeRangeIndex(label: string, ...properties: string[]): Promise<QueryReply>;
-    createEdgeFulltextIndex(label: string, ...properties: string[]): Promise<QueryReply>;
-    createEdgeVectorIndex(label: string, dim?: number, similarityFunction?: string, ...properties: string[]): Promise<QueryReply>;
-    dropTypedIndex(idxType: string, entityType: "NODE" | "EDGE", label: string, attribute: string): Promise<QueryReply>;
-    dropNodeRangeIndex(label: string, attribute: string): Promise<QueryReply>;
-    dropNodeFulltextIndex(label: string, attribute: string): Promise<QueryReply>;
-    dropNodeVectorIndex(label: string, attribute: string): Promise<QueryReply>;
-    dropEdgeRangeIndex(label: string, attribute: string): Promise<QueryReply>;
-    dropEdgeFulltextIndex(label: string, attribute: string): Promise<QueryReply>;
-    dropEdgeVectorIndex(label: string, attribute: string): Promise<QueryReply>;
+    /**
+     * Creates a unique constraint on nodes, together with the range index it
+     * requires on each property. Enforced asynchronously, see `constraintCreate`.
+     */
+    createNodeUniqueConstraint(label: string, ...properties: string[]): Promise<void>;
+    /**
+     * Creates a unique constraint on relationships, together with the range
+     * index it requires on each property. Enforced asynchronously, see
+     * `constraintCreate`.
+     */
+    createEdgeUniqueConstraint(relation: string, ...properties: string[]): Promise<void>;
+    /**
+     * Creates a mandatory constraint on nodes. Enforced asynchronously, see
+     * `constraintCreate`.
+     */
+    createNodeMandatoryConstraint(label: string, ...properties: string[]): Promise<void>;
+    /**
+     * Creates a mandatory constraint on relationships. Enforced asynchronously,
+     * see `constraintCreate`.
+     */
+    createEdgeMandatoryConstraint(relation: string, ...properties: string[]): Promise<void>;
+    /** Drops a unique constraint on nodes; its supporting range index is kept */
+    dropNodeUniqueConstraint(label: string, ...properties: string[]): Promise<void>;
+    /** Drops a unique constraint on relationships; its supporting range index is kept */
+    dropEdgeUniqueConstraint(relation: string, ...properties: string[]): Promise<void>;
+    dropNodeMandatoryConstraint(label: string, ...properties: string[]): Promise<void>;
+    dropEdgeMandatoryConstraint(relation: string, ...properties: string[]): Promise<void>;
+    /**
+     * Copies the graph to `destGraph` (`GRAPH.COPY`) and returns the copy: for
+     * a graph from `selectGraph`, the instance `selectGraph(destGraph)` returns.
+     */
+    copy(destGraph: string): Promise<Graph>;
+    createTypedIndex(idxType: string, entityType: "NODE" | "EDGE", label: string, properties: string[], options?: Record<string, string | number | boolean>): Promise<GraphReply<never>>;
+    createNodeRangeIndex(label: string, ...properties: string[]): Promise<GraphReply<never>>;
+    createNodeFulltextIndex(label: string, ...properties: string[]): Promise<GraphReply<never>>;
+    /**
+     * Creates a vector index, e.g.
+     * `createNodeVectorIndex(label, { dimension: 768, similarityFunction: 'cosine' }, 'embedding')`.
+     */
+    createNodeVectorIndex(label: string, options: VectorIndexOptions, ...properties: string[]): Promise<GraphReply<never>>;
+    createEdgeRangeIndex(label: string, ...properties: string[]): Promise<GraphReply<never>>;
+    createEdgeFulltextIndex(label: string, ...properties: string[]): Promise<GraphReply<never>>;
+    /**
+     * Creates a vector index, e.g.
+     * `createEdgeVectorIndex(label, { dimension: 768, similarityFunction: 'cosine' }, 'embedding')`.
+     */
+    createEdgeVectorIndex(label: string, options: VectorIndexOptions, ...properties: string[]): Promise<GraphReply<never>>;
+    dropTypedIndex(idxType: string, entityType: "NODE" | "EDGE", label: string, attribute: string): Promise<GraphReply<never>>;
+    dropNodeRangeIndex(label: string, attribute: string): Promise<GraphReply<never>>;
+    dropNodeFulltextIndex(label: string, attribute: string): Promise<GraphReply<never>>;
+    dropNodeVectorIndex(label: string, attribute: string): Promise<GraphReply<never>>;
+    dropEdgeRangeIndex(label: string, attribute: string): Promise<GraphReply<never>>;
+    dropEdgeFulltextIndex(label: string, attribute: string): Promise<GraphReply<never>>;
+    dropEdgeVectorIndex(label: string, attribute: string): Promise<GraphReply<never>>;
 }
 export { Graph };