@ultipa-graph/ultipa-driver 6.0.5 → 6.0.7

package/README.md

@@ -58,8 +58,8 @@ main().catch(console.error);
 
 ## Documentation
 
-See [GUIDE.md](https://github.com/ultipa/gqldb-drivers/blob/main/nodejs/GUIDE.md) for detailed usage.
+See [Quick Start](https://www.ultipa.com/docs/drivers/nodejs-quick-start) for detailed usage.
 
 ## License
 
-[MIT License](https://github.com/ultipa/gqldb-drivers/blob/main/nodejs/LICENSE)
+MIT License

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 } from './types';
+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 } from './types';
 /** Configuration for a query */
 export interface QueryConfig {
     graphName?: string;
@@ -42,6 +42,9 @@ export declare class GqldbClient {
     private sessions;
     private txManager;
     private closed;
+    private storedUsername;
+    private storedPassword;
+    private storedGraph;
     private sessionService;
     private queryService;
     private graphService;
@@ -57,6 +60,12 @@ export declare class GqldbClient {
     close(): Promise<void>;
     /** 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.
+     */
+    private withAutoReconnect;
     /** Terminate the current session */
     logout(): Promise<void>;
     /** Check the connection and return the latency in nanoseconds */
@@ -89,10 +98,10 @@ 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>;
-    /** Insert multiple nodes into a graph */
-    insertNodes(graphName: string, nodes: NodeData[], config?: InsertNodesConfig): Promise<InsertNodesResult>;
-    /** Insert multiple edges into a graph */
-    insertEdges(graphName: string, edges: EdgeData[], config?: InsertEdgesConfig): Promise<InsertEdgesResult>;
+    /** 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 */
+    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 */
@@ -193,4 +202,157 @@ export declare class GqldbClient {
     get clusterId(): string;
     /** Get the partition count (0 if not a cluster) */
     get partitionCount(): number;
+    /** Wrap a name in backticks for safe use in GQL statements.
+     * Label names and property names should be quoted; graph names, index names,
+     * and fulltext names should NOT be wrapped in backticks. */
+    private static quoteLabel;
+    /** Wrap each label name in backticks and join with ", " */
+    private static quoteLabels;
+    /** Join names with ", " without backtick wrapping */
+    private static joinNames;
+    /** Create a new open (schema-less) graph */
+    createOpenGraph(name: string): Promise<Response>;
+    /** Create a new closed (schema-enforced) graph with node and edge label definitions */
+    createClosedGraph(name: string): Promise<Response>;
+    /**
+     * 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>;
+    /** Check whether a graph with the given name exists */
+    hasGraph(name: string): Promise<boolean>;
+    /** Rename a graph */
+    alterGraph(graphName: string, newName: string): Promise<Response>;
+    /** Remove all data from a graph while keeping its structure */
+    truncate(graphName: string): Promise<Response>;
+    /** Return all labels (node and edge) in the current graph */
+    showLabels(): Promise<LabelInfo[]>;
+    /** Return all node labels in the current graph */
+    showNodeLabels(): Promise<LabelInfo[]>;
+    /** Return all edge labels in the current graph */
+    showEdgeLabels(): Promise<LabelInfo[]>;
+    /** Return all node types with their properties */
+    showNodeTypes(): Promise<NodeTypeInfo[]>;
+    /** Return all edge types with their properties */
+    showEdgeTypes(): Promise<EdgeTypeInfo[]>;
+    /** Return a specific label by name from the current graph, or null if not found */
+    getLabel(name: string): Promise<LabelInfo | null>;
+    /** Return a specific node type by name, or null if not found */
+    getNodeLabel(name: string): Promise<NodeTypeInfo | null>;
+    /** Return a specific edge type by name, or null if not found */
+    getEdgeLabel(name: string): Promise<EdgeTypeInfo | null>;
+    /** Create a node label in the current graph (closed graph) */
+    createNodeLabel(name: string, props?: ConvPropertyDef[]): Promise<Response>;
+    /** Create an edge label in the current graph (closed graph) */
+    createEdgeLabel(name: string, props?: ConvPropertyDef[]): Promise<Response>;
+    /** Drop a node label from the current graph (closed graph) */
+    dropNodeLabel(name: string): Promise<Response>;
+    /** Drop one or more edge labels from the current graph (closed graph) */
+    dropEdgeLabel(...names: string[]): Promise<Response>;
+    /**
+     * Create a label if it does not already exist.
+     * Returns true if created, false if it already existed.
+     */
+    createLabelIfNotExist(nodeOrEdge: DBType, name: string, props?: ConvPropertyDef[]): Promise<boolean>;
+    /** Rename a node label */
+    alterNodeLabel(oldName: string, newName: string): Promise<Response>;
+    /** Rename an edge label */
+    alterEdgeLabel(oldName: string, newName: string): Promise<Response>;
+    /** Return all available algorithms */
+    showAlgos(): Promise<AlgoInfo[]>;
+    /** Return properties for a label (node or edge) in the current graph */
+    showProperty(nodeOrEdge: DBType, labelName: string): Promise<ConvPropertyDef[]>;
+    /** Return properties for a node label */
+    showNodeProperty(labelName: string): Promise<ConvPropertyDef[]>;
+    /** Return properties for an edge label */
+    showEdgeProperty(labelName: string): Promise<ConvPropertyDef[]>;
+    /** Return a specific property definition for a label, or null if not found */
+    getProperty(nodeOrEdge: DBType, labelName: string, propName: string): Promise<ConvPropertyDef | null>;
+    /** Return a specific property definition for a node label, or null if not found */
+    getNodeProperty(labelName: string, propName: string): Promise<ConvPropertyDef | null>;
+    /** Return a specific property definition for an edge label, or null if not found */
+    getEdgeProperty(labelName: string, propName: string): Promise<ConvPropertyDef | null>;
+    /** Add properties to a label (node or edge) */
+    createProperty(nodeOrEdge: DBType, labelName: string, props: ConvPropertyDef[]): Promise<Response>;
+    /** Add properties to a node label */
+    createNodeProperty(labelName: string, props: ConvPropertyDef[]): Promise<Response>;
+    /** Add properties to an edge label */
+    createEdgeProperty(labelName: string, props: ConvPropertyDef[]): Promise<Response>;
+    /** Drop properties from a label (node or edge) */
+    dropProperty(nodeOrEdge: DBType, labelName: string, ...propNames: string[]): Promise<Response>;
+    /** Drop properties from a node label */
+    dropNodeProperty(labelName: string, ...propNames: string[]): Promise<Response>;
+    /** Drop properties from an edge label */
+    dropEdgeProperty(labelName: string, ...propNames: string[]): Promise<Response>;
+    /**
+     * Create properties on a label if they do not already exist.
+     * Returns true if any properties were created, false if all already existed.
+     */
+    createPropertyIfNotExist(nodeOrEdge: DBType, labelName: string, props: ConvPropertyDef[]): Promise<boolean>;
+    /** Create a NOT NULL constraint on a property */
+    createNotNullConstraint(nodeOrEdge: DBType, labelName: string, propName: string): Promise<Response>;
+    /** Create a UNIQUE constraint on one or more properties */
+    createUniqueConstraint(nodeOrEdge: DBType, labelName: string, ...propNames: string[]): Promise<Response>;
+    /** Remove a NOT NULL constraint from a property */
+    dropNotNullConstraint(nodeOrEdge: DBType, labelName: string, propName: string): Promise<Response>;
+    /** Remove a UNIQUE constraint from one or more properties */
+    dropUniqueConstraint(nodeOrEdge: DBType, labelName: string, ...propNames: string[]): Promise<Response>;
+    /** Return all indexes in the current graph */
+    showIndex(): Promise<IndexInfo[]>;
+    /** Return all node indexes in the current graph */
+    showNodeIndex(): Promise<IndexInfo[]>;
+    /** Return all edge indexes in the current graph */
+    showEdgeIndex(): Promise<IndexInfo[]>;
+    /** Create an index on a node label */
+    createNodeIndex(indexName: string, labelName: string, props: IndexProperty[]): Promise<Response>;
+    /** Create an index on an edge label */
+    createEdgeIndex(indexName: string, labelName: string, props: IndexProperty[]): Promise<Response>;
+    /** Drop a node index by name */
+    dropNodeIndex(indexName: string): Promise<Response>;
+    /** Drop an edge index by name */
+    dropEdgeIndex(indexName: string): Promise<Response>;
+    /** Return all fulltext indexes in the current graph */
+    showFulltext(): Promise<FulltextInfo[]>;
+    /** Return all node fulltext indexes */
+    showNodeFulltext(): Promise<FulltextInfo[]>;
+    /** Return all edge fulltext indexes */
+    showEdgeFulltext(): Promise<FulltextInfo[]>;
+    /** Create a fulltext index on a node label */
+    createNodeFulltext(indexName: string, labelName: string, props: string[]): Promise<Response>;
+    /** Create a fulltext index on an edge label */
+    createEdgeFulltext(indexName: string, labelName: string, props: string[]): Promise<Response>;
+    /** Drop a node fulltext index by name */
+    dropNodeFulltext(indexName: string): Promise<Response>;
+    /** Drop an edge fulltext index by name */
+    dropEdgeFulltext(indexName: string): Promise<Response>;
+    /** Return all tasks in the current graph */
+    showTasks(): Promise<TaskInfo[]>;
+    /** Delete a task by ID */
+    deleteTask(taskId: string): Promise<Response>;
+    /** Stop a running task by ID */
+    stopTask(taskId: string): Promise<Response>;
+    /** Insert nodes using GQL INSERT syntax */
+    /**
+     * Insert nodes using GQL INSERT syntax with RETURN clause.
+     * GQL: INSERT (n0:Label {p1: v1}), (n1:Label {p2: v2}) RETURN n0, n1
+     * 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.
+     */
+    insertNodes(nodes: NodeData[], insertType?: InsertType): 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
+     * Returns a merged Response containing all inserted edges in columns e0, e1, etc.
+     */
+    insertEdges(edges: EdgeData[], insertType?: InsertType): Promise<Response>;
+    /** Return currently running processes (queries) */
+    top(): Promise<ProcessInfo[]>;
+    /** Terminate a running query by its query ID */
+    kill(queryId: string): Promise<Response>;
+    /** Return statistics for the current graph using db.stats() */
+    stats(): Promise<GraphStats>;
+    /** Send a ping to the server and return the latency in nanoseconds */
+    test(): Promise<number>;
 }