@ultipa-graph/ultipa-driver 6.0.13 → 6.0.15

package/dist/client.d.ts

@@ -6,7 +6,7 @@ import { GqldbConfig } from './config';
 import { Response, InsertNodesResult, InsertEdgesResult, DeleteResult, 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, DBType, InsertType, LabelInfo, NodeTypeInfo, EdgeTypeInfo, ConvPropertyDef, IndexProperty, IndexInfo, FulltextInfo, TaskInfo, ProcessInfo, GraphStats, AlgoInfo, AiReadResult } from './types';
+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';
 /** Configuration for a query */
 export interface QueryConfig {
     graphName?: string;
@@ -63,6 +63,13 @@ export declare class GqldbClient {
     private bulkImportService;
     /** Get session metadata for authenticated requests */
     private getSessionMetadata;
+    /**
+     * Stable per-client logical session id surfaced under the
+     * transaction-branch model. See TRANSACTIONS_DRIVER_GUIDE.md §2.0–2.1.
+     * Falls back to a UUID v4 hex generated at construction when
+     * `config.sessionId` is not set.
+     */
+    readonly clientSessionId: string;
     constructor(config: GqldbConfig);
     /** Close the client and all connections */
     close(): Promise<void>;
@@ -106,6 +113,28 @@ export declare class GqldbClient {
     listTransactions(): Promise<TransactionInfo[]>;
     /** Execute a function within a transaction */
     withTransaction<T>(graphName: string, fn: (txId: number) => Promise<T>, readOnly?: boolean): Promise<T>;
+    /**
+     * Return active transactions via the GQL admin DDL `SHOW TRANSACTIONS`.
+     * Each row mirrors the 5-column server-side schema:
+     * `transactionId / status / readOnly / startTime / sessionId`.
+     * `sessionId` is `''` unless the server has auto-derived one from peer
+     * info or the driver explicitly surfaces `x-ultipa-session-id` metadata.
+     *
+     * Distinct from `listTransactions()` which uses the legacy gRPC.
+     */
+    showTransactions(): Promise<TransactionRow[]>;
+    /**
+     * Roll back a single transaction by id via `KILL TRANSACTION '<id>'`.
+     * `transactionId` here is the **string** id surfaced by
+     * `showTransactions()` (e.g. `'tx_a396c531-...'`), distinct from the
+     * `number` id returned by `begin()`.
+     */
+    killTransaction(transactionId: string): Promise<Response>;
+    /**
+     * Roll back every active transaction via `RESET TRANSACTIONS`. Admin-only.
+     * Intended as an escape hatch when an orphan tx blocks new BEGINs.
+     */
+    resetTransactions(): Promise<Response>;
     /** Insert multiple nodes into a graph using gRPC bulk insert */
     insertNodesBatchAuto(graphName: string, nodes: NodeData[], config?: InsertNodesConfig): Promise<InsertNodesResult>;
     /** Insert multiple edges into a graph using gRPC bulk insert */
@@ -347,27 +376,44 @@ export declare class GqldbClient {
     /** Stop a running task by ID */
     stopTask(taskId: string, config?: QueryConfig): Promise<Response>;
     /**
-     * Insert nodes using GQL INSERT syntax with RETURN clause.
-     * GQL: INSERT (n0:Label {p1: v1}), (n1:Label {p2: v2}) RETURN n0, n1
-     * When config.insertType is InsertType.Overwrite, uses INSERT OVERWRITE syntax.
-     * If NodeData.id is set (non-empty), includes it as _id property in the GQL.
-     * Returns the raw Response containing the inserted nodes in columns n0, n1, etc.
+     * Insert nodes — backward-compatible overloaded entry point.
+     *
+     * Two call shapes are accepted; the runtime dispatches on the first
+     * argument's type:
      *
-     * @param nodes Nodes to insert.
-     * @param config Optional InsertConfig. Supports per-call graphName and insertType.
+     *   1. `insertNodes(graphName: string, nodes, config?)` — original
+     *      6.0.0 signature, routes through the bulk-import gRPC path
+     *      (`DataService.InsertNodes`). Returns `InsertNodesResult` with
+     *      gRPC-level metadata. Preserves source compatibility for
+     *      callers written against 6.0.0 (e.g. gqldb-manager).
+     *
+     *   2. `insertNodes(nodes, config?)` — convenience GQL emitter (added
+     *      after 6.0.0). Synthesizes
+     *      `INSERT (n0:Label {...}), (n1:Label {...}) RETURN n0, n1`,
+     *      with `INSERT OVERWRITE` when `config.insertType` is
+     *      `InsertType.Overwrite`. Returns the raw `Response`.
+     *      `NodeData.id`, when set, is emitted as the `_id` property.
      */
+    insertNodes(graphName: string, nodes: NodeData[], config?: InsertNodesConfig): Promise<InsertNodesResult>;
     insertNodes(nodes: NodeData[], config?: InsertConfig): Promise<Response>;
     /**
-     * Insert edges using GQL INSERT syntax with RETURN clause.
-     * Each edge is inserted individually using MATCH + INSERT to resolve node IDs.
-     * GQL: MATCH (src WHERE id(src) = 'from'), (dst WHERE id(dst) = 'to')
-     *      INSERT (src)-[e0:Label {p1: v1}]->(dst) RETURN e0
-     * When config.insertType is InsertType.Overwrite, uses INSERT OVERWRITE syntax.
-     * Returns a merged Response containing all inserted edges in columns e0, e1, etc.
+     * Insert edges — backward-compatible overloaded entry point.
+     *
+     * Two call shapes are accepted; the runtime dispatches on the first
+     * argument's type:
+     *
+     *   1. `insertEdges(graphName: string, edges, config?)` — original
+     *      6.0.0 signature, routes through the bulk-import gRPC path
+     *      (`DataService.InsertEdges`). Returns `InsertEdgesResult` with
+     *      gRPC-level metadata. Preserves source compatibility for
+     *      6.0.0 callers.
      *
-     * @param edges Edges to insert.
-     * @param config Optional InsertConfig. Supports per-call graphName and insertType.
+     *   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`.
+     *      Returns a merged `Response` with columns `e0, e1, ...`.
      */
+    insertEdges(graphName: string, edges: EdgeData[], config?: InsertEdgesConfig): Promise<InsertEdgesResult>;
     insertEdges(edges: EdgeData[], config?: InsertConfig): Promise<Response>;
     /** Return currently running processes (queries) */
     top(config?: QueryConfig): Promise<ProcessInfo[]>;