falkordb 6.9.2 → 6.9.3

package/dist/src/types/falkordb-options.d.ts

@@ -18,6 +18,14 @@ export interface FalkorDBOptions {
      * Ignored when `url` or `socket.port` is provided.
      */
     port?: number;
+    /**
+     * How integers in query results are returned. `'number'` rounds those
+     * beyond `Number.MAX_SAFE_INTEGER` (2^53 - 1); `'bigint'` returns every
+     * integer value exactly, as a `bigint`. Node and edge ids stay numbers.
+     * Note that `JSON.stringify` throws on a `bigint`.
+     * @default 'number'
+     */
+    integers?: 'number' | 'bigint';
     /**
      * Sentinel only. Resend write commands to the new master when the
      * connection is lost while waiting for their reply, e.g. during a master

package/dist/src/types/graph-value.d.ts

@@ -1,5 +1,5 @@
 import type { Temporal } from '@js-temporal/polyfill';
-import type { QueryReply } from './query-reply';
+import type { QueryStatistics } from './query-statistics';
 export type GraphEntityProperties = Record<string, GraphValue>;
 export interface GraphEdge {
     id: number;
@@ -20,10 +20,16 @@ export interface GraphPath {
 export type GraphMap = {
     [key: string]: GraphValue;
 };
-export type GraphValue = null | string | number | boolean | Array<GraphValue> | GraphEdge | GraphNode | GraphPath | GraphMap | {
-    latitude: string;
-    longitude: string;
+export type GraphValue = null | string | number | bigint | boolean | Array<GraphValue> | GraphEdge | GraphNode | GraphPath | GraphMap | {
+    latitude: number;
+    longitude: number;
 } | number[] | Temporal.PlainDateTime | Temporal.PlainDate | Temporal.PlainTime | Temporal.Duration;
-export type GraphReply<T> = Omit<QueryReply, "headers" | "data"> & {
+/**
+ * The reply to a graph query: the returned columns and rows, if any, and the
+ * statistics the server reported for it.
+ */
+export type GraphReply<T> = {
+    headers?: Array<string>;
     data?: Array<T>;
+    stats: QueryStatistics;
 };

package/dist/src/types/index.d.ts

@@ -8,9 +8,11 @@ export * from './memory-usage';
 export * from './net-socket-options';
 export * from './query-options';
 export * from './query-reply';
+export * from './query-statistics';
 export * from './single-graph-connection';
 export * from './slow-log';
 export * from './socket-options';
 export * from './tls-socket-options';
 export * from './typed-redis-client-options';
 export * from './udf-list';
+export * from './procedures';

package/dist/src/types/index.js

@@ -24,9 +24,11 @@ __exportStar(require("./memory-usage"), exports);
 __exportStar(require("./net-socket-options"), exports);
 __exportStar(require("./query-options"), exports);
 __exportStar(require("./query-reply"), exports);
+__exportStar(require("./query-statistics"), exports);
 __exportStar(require("./single-graph-connection"), exports);
 __exportStar(require("./slow-log"), exports);
 __exportStar(require("./socket-options"), exports);
 __exportStar(require("./tls-socket-options"), exports);
 __exportStar(require("./typed-redis-client-options"), exports);
 __exportStar(require("./udf-list"), exports);
+__exportStar(require("./procedures"), exports);

package/dist/src/types/procedures.d.ts

@@ -0,0 +1,47 @@
+import type { GraphMap } from './graph-value';
+/** A row of `CALL db.indexes()`, one per indexed label or relationship type */
+export interface IndexInfo {
+    label: string;
+    properties: string[];
+    /** Index types of each property, e.g. `{ name: ['RANGE', 'FULLTEXT'] }` */
+    types: Record<string, string[]>;
+    /** Options of each property's index, e.g. a vector index's `dimension` */
+    options: Record<string, GraphMap>;
+    language: string;
+    stopwords: string[];
+    /** `'NODE'` or `'RELATIONSHIP'` (the server's `entitytype` column) */
+    entityType: string;
+    /** `'OPERATIONAL'` once built, otherwise a progress message ending in `UNDER CONSTRUCTION` */
+    status: string;
+    info: GraphMap;
+}
+/** A row of `CALL db.constraints()` */
+export interface ConstraintInfo {
+    type: 'UNIQUE' | 'MANDATORY';
+    label: string;
+    properties: string[];
+    /** The server's `entitytype` column */
+    entityType: 'NODE' | 'RELATIONSHIP';
+    /** `'UNDER CONSTRUCTION'` while existing data is validated, then `'OPERATIONAL'` or `'FAILED'` */
+    status: 'UNDER CONSTRUCTION' | 'OPERATIONAL' | 'FAILED';
+}
+/** Options of a vector index, see https://docs.falkordb.com/cypher/indexing/vector-index */
+export interface VectorIndexOptions {
+    /** Length of the indexed vectors */
+    dimension: number;
+    /** Defaults to `'euclidean'` */
+    similarityFunction?: 'euclidean' | 'cosine';
+    /** Maximum number of outgoing edges per node in the HNSW graph (server default 16) */
+    M?: number;
+    /** Number of candidates considered while building the index (server default 200) */
+    efConstruction?: number;
+    /** Number of candidates considered while searching (server default 10) */
+    efRuntime?: number;
+}
+export interface CallProcedureOptions {
+    /** Columns to `YIELD`; all of the procedure's columns when omitted */
+    yields?: string[];
+    /** Run with `GRAPH.RO_QUERY` (default) instead of `GRAPH.QUERY` */
+    readOnly?: boolean;
+    timeout?: number;
+}

package/dist/src/types/procedures.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/query-options.d.ts

@@ -1,4 +1,5 @@
-export type QueryParam = null | string | number | boolean | QueryParams | Array<QueryParam>;
+export type QueryParamTypedArray = Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array | BigInt64Array | BigUint64Array;
+export type QueryParam = null | string | number | bigint | boolean | QueryParams | Array<QueryParam> | QueryParamTypedArray;
 export type QueryParams = {
     [key: string]: QueryParam;
 };
@@ -7,3 +8,7 @@ export interface QueryOptions {
     TIMEOUT?: number;
 }
 export type QueryOptionsBackwardCompatible = QueryOptions | number;
+/** Options for `GRAPH.EXPLAIN` and `GRAPH.PROFILE` */
+export interface PlanOptions {
+    params?: QueryParams;
+}

package/dist/src/types/query-statistics.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Statistics the server reports for a query, parsed from the statistic lines
+ * it sends with every reply. A counter the server did not report is 0.
+ */
+export interface QueryStatistics {
+    labelsAdded: number;
+    labelsRemoved: number;
+    nodesCreated: number;
+    nodesDeleted: number;
+    propertiesSet: number;
+    propertiesRemoved: number;
+    relationshipsCreated: number;
+    relationshipsDeleted: number;
+    indicesCreated: number;
+    indicesDeleted: number;
+    constraintsCreated: number;
+    constraintsDeleted: number;
+    cachedExecution: boolean;
+    queryInternalExecutionTime: number;
+}

package/dist/src/types/query-statistics.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "falkordb",
-  "version": "6.9.2",
+  "version": "6.9.3",
   "description": "A FalkorDB javascript library",
   "license": "MIT",
   "main": "./dist/index.js",