@ultipa-graph/ultipa-driver 6.2.3 → 6.2.5

package/dist/client.d.ts

@@ -6,7 +6,7 @@ import { GqldbConfig } from './config';
 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';
+import { GraphInfo, GraphType, EdgeIdMode, 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';
 /** Configuration for a query */
 export interface QueryConfig {
     graphName?: string;
@@ -72,6 +72,10 @@ export declare class GqldbClient {
     private storedUsername;
     private storedPassword;
     private storedGraph;
+    private grpcHost;
+    private grpcCredentials;
+    private grpcChannelOptions;
+    private ctx;
     private sessionService;
     private queryService;
     private graphService;
@@ -95,9 +99,21 @@ export declare class GqldbClient {
     /** Authenticate the user and create a session */
     login(username: string, password: string): Promise<Session>;
     /**
-     * Execute fn and auto-reconnect on UNAUTHENTICATED error.
-     * If fn throws an UNAUTHENTICATED gRPC error and credentials are stored,
-     * re-login and retry fn once.
+     * Rebuild every gRPC client used by this connection so the next call
+     * gets a fresh channel.  Called by withAutoReconnect when a call
+     * fails with UNAVAILABLE / connection reset.  Does NOT close old
+     * clients synchronously — in-flight calls hold them alive and gRPC
+     * closes them once those calls complete.
+     */
+    private forceReconnectAll;
+    /**
+     * Execute fn with two recovery behaviours:
+     *   - UNAUTHENTICATED — if stored credentials are available, re-login
+     *     and retry fn once.
+     *   - UNAVAILABLE / connection reset — rebuild every gRPC client so
+     *     the NEXT call gets a fresh channel.  The current call is NOT
+     *     retried; caller decides (write-side calls are often not
+     *     idempotent).
      */
     private withAutoReconnect;
     /** Terminate the current session */
@@ -112,8 +128,15 @@ export declare class GqldbClient {
     explain(query: string, config?: QueryConfig): Promise<string>;
     /** Execute a query with profiling and return statistics */
     profile(query: string, config?: QueryConfig): Promise<string>;
-    /** Create a new graph */
-    createGraph(name: string, graphType?: GraphType, description?: string): Promise<void>;
+    /**
+     * Create a new graph.
+     *
+     * When `edgeId` is provided, the driver issues a follow-up
+     * `ALTER GRAPH <name> SET EDGE_ID ENABLED|DISABLED` via GQL after the
+     * gRPC create call. When `edgeId` is undefined, behavior is unchanged
+     * and no ALTER statement is sent.
+     */
+    createGraph(name: string, graphType?: GraphType, description?: string, edgeId?: EdgeIdMode): Promise<void>;
     /** Delete a graph */
     dropGraph(name: string, ifExists?: boolean): Promise<void>;
     /** Set the current graph for the session */
@@ -160,7 +183,7 @@ export declare class GqldbClient {
     insertEdgesBatchAuto(graphName: string, edges: EdgeData[], config?: InsertEdgesConfig): Promise<InsertEdgesResult>;
     /**
      * Delete nodes by id list. Emits
-     * `MATCH (n) WHERE id(n) IN [...] DETACH DELETE n RETURN n`.
+     * `MATCH (n) WHERE n._id IN [...] DETACH DELETE n RETURN n`.
      *
      * Empty/null `nodeIds` short-circuits without contacting the server.
      *
@@ -179,9 +202,11 @@ export declare class GqldbClient {
      */
     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
+     * Delete edges by id list. Emits 5-column GQL keyed on `e._id`, then
      * reshapes the response into a single "e" column holding GqldbEdge.
+     * Requires EDGE_ID ENABLED: on a disabled graph the server returns
+     * `[5017]` guiding the caller to `ALTER GRAPH <g> SET EDGE_ID ENABLED`
+     * (deletion does NOT fall back to the discouraged `internal_id(e)`).
      */
     deleteEdgesByIds(edgeIds: string[], config?: DeleteConfig): Promise<Response>;
     /**
@@ -308,7 +333,7 @@ export declare class GqldbClient {
      * Create a graph if it does not already exist.
      * Returns true if the graph was created, false if it already existed.
      */
-    createGraphIfNotExist(name: string, graphType?: GraphType, description?: string): Promise<boolean>;
+    createGraphIfNotExist(name: string, graphType?: GraphType, description?: string, edgeId?: EdgeIdMode): Promise<boolean>;
     /** Check whether a graph with the given name exists */
     hasGraph(name: string): Promise<boolean>;
     /** Rename a graph */
@@ -461,7 +486,7 @@ export declare class GqldbClient {
      *
      *   2. `insertEdges(edges, config?)` — convenience GQL emitter
      *      (added after 6.0.0). Per edge synthesizes
-     *      `MATCH (src WHERE id(src) = 'from'), (dst WHERE id(dst) = 'to') INSERT (src)-[e0:Label {...}]->(dst) RETURN e0`.
+     *      `MATCH (src WHERE src._id = 'from'), (dst WHERE dst._id = 'to') INSERT (src)-[e0:Label {...}]->(dst) RETURN e0`.
      *      Returns a merged `Response` with columns `e0, e1, ...`.
      */
     insertEdges(graphName: string, edges: EdgeData[], config?: InsertEdgesConfig): Promise<InsertEdgesResult>;