@ultipa-graph/ultipa-driver 6.2.1 → 6.2.3

package/dist/client.d.ts

@@ -3,7 +3,7 @@
  */
 import { EventEmitter } from 'events';
 import { GqldbConfig } from './config';
-import { Response, InsertNodesResult, InsertEdgesResult, DeleteResult, ExportNodesResult, ExportEdgesResult, ExportConfig, ExportChunk } from './response';
+import { Response, InsertNodesResult, InsertEdgesResult, ExportNodesResult, ExportEdgesResult, ExportConfig, ExportChunk } from './response';
 import { Session } from './session';
 import { Transaction } from './transaction';
 import { GraphInfo, GraphType, HealthStatus, CacheStats, CacheType, Statistics, CompactResult, ComputeTopologyResult, SystemMetrics, NodeData, EdgeData, BulkCreateNodesOptions, BulkCreateEdgesOptions, BulkImportOptions, BulkImportSession, CheckpointResult, EndBulkImportResult, AbortBulkImportResult, BulkImportStatus, TransactionInfo, TransactionRow, DBType, InsertType, LabelInfo, NodeTypeInfo, EdgeTypeInfo, ConvPropertyDef, IndexProperty, IndexInfo, FulltextInfo, TaskInfo, ProcessInfo, GraphStats, AlgoInfo, AiReadResult } from './types';
@@ -25,6 +25,25 @@ export interface InsertConfig extends QueryConfig {
     /** Insert mode. Defaults to InsertType.Normal when omitted. */
     insertType?: InsertType;
 }
+/**
+ * Configuration for the new GQL-emitter delete API
+ * (deleteNodesByIds / deleteNodesByCondition /
+ *  deleteEdgesByIds / deleteEdgesByCondition).
+ *
+ * Extends QueryConfig so per-call `graphName` works the same as
+ * `InsertConfig`. Two delete-specific knobs:
+ *   - `returnDeleted` (default true) — emit `RETURN ...` so the
+ *     response carries the full deleted node/edge data. Set to false
+ *     on large bulk deletes to save bandwidth; `rowsAffected` still
+ *     carries the count.
+ *   - `allowDeleteAll` (default false) — safety latch. With empty
+ *     labels/ids AND empty where, the SDK would otherwise emit a
+ *     graph-wide delete; this flag must be explicitly true to opt in.
+ */
+export interface DeleteConfig extends QueryConfig {
+    returnDeleted?: boolean;
+    allowDeleteAll?: boolean;
+}
 /** Configuration for insert nodes */
 export interface InsertNodesConfig {
     options?: BulkCreateNodesOptions;
@@ -139,10 +158,40 @@ export declare class GqldbClient {
     insertNodesBatchAuto(graphName: string, nodes: NodeData[], config?: InsertNodesConfig): Promise<InsertNodesResult>;
     /** Insert multiple edges into a graph using gRPC bulk insert */
     insertEdgesBatchAuto(graphName: string, edges: EdgeData[], config?: InsertEdgesConfig): Promise<InsertEdgesResult>;
-    /** Delete nodes from a graph */
-    deleteNodes(graphName: string, nodeIds?: string[], labels?: string[], where?: string): Promise<DeleteResult>;
-    /** Delete edges from a graph */
-    deleteEdges(graphName: string, edgeIds?: string[], label?: string, where?: string): Promise<DeleteResult>;
+    /**
+     * Delete nodes by id list. Emits
+     * `MATCH (n) WHERE id(n) IN [...] DETACH DELETE n RETURN n`.
+     *
+     * Empty/null `nodeIds` short-circuits without contacting the server.
+     *
+     * @returns Response with one row per actually-deleted node, column
+     *   "n" holding the GqldbNode. Use `response.alias("n").asNodes()`.
+     *   With `returnDeleted=false` the response carries only
+     *   `rowsAffected`; rows is empty.
+     */
+    deleteNodesByIds(nodeIds: string[], config?: DeleteConfig): Promise<Response>;
+    /**
+     * Delete nodes matching labels and/or where clause. Emits
+     * `MATCH (n:L1|L2) WHERE <where> DETACH DELETE n RETURN n`.
+     *
+     * Throws if both labels and where are empty unless
+     * `config.allowDeleteAll = true`.
+     */
+    deleteNodesByCondition(labels: string[] | undefined, where: string | undefined, limit?: number, config?: DeleteConfig): Promise<Response>;
+    /**
+     * Delete edges by id list. Emits 5-column GQL with `id(e)` so the
+     * same emit works on graphs with or without EDGE_ID enabled, then
+     * reshapes the response into a single "e" column holding GqldbEdge.
+     */
+    deleteEdgesByIds(edgeIds: string[], config?: DeleteConfig): Promise<Response>;
+    /**
+     * Delete edges matching label and/or where. Emits 5-column GQL,
+     * then reshapes into a single "e" column.
+     *
+     * Throws if both label and where are empty unless
+     * `config.allowDeleteAll = true`.
+     */
+    deleteEdgesByCondition(label: string | undefined, where: string | undefined, limit?: number, config?: DeleteConfig): Promise<Response>;
     /**
      * Export graph data in JSON Lines format (streaming).
      * @param config Export configuration