@robosystems/client 0.2.13 → 0.2.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/sdk/sdk.gen.d.ts +95 -2
- package/sdk/sdk.gen.js +97 -4
- package/sdk/sdk.gen.ts +97 -4
- package/sdk/types.gen.d.ts +11 -11
- package/sdk/types.gen.ts +11 -11
- package/sdk.gen.d.ts +95 -2
- package/sdk.gen.js +97 -4
- package/sdk.gen.ts +97 -4
- package/types.gen.d.ts +11 -11
- package/types.gen.ts +11 -11
package/package.json
CHANGED
package/sdk/sdk.gen.d.ts
CHANGED
|
@@ -457,6 +457,13 @@ export declare const listAgents: <ThrowOnError extends boolean = false>(options:
|
|
|
457
457
|
* - Leverage conversation history for contextual understanding
|
|
458
458
|
* - Enable RAG for knowledge base enrichment
|
|
459
459
|
*
|
|
460
|
+
* **Subgraph Support:**
|
|
461
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
462
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
463
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
464
|
+
* Agents operate on the specified graph/subgraph's data independently. RAG enrichment
|
|
465
|
+
* and knowledge base search are scoped to the specific graph/subgraph.
|
|
466
|
+
*
|
|
460
467
|
* See request/response examples in the "Examples" dropdown below.
|
|
461
468
|
*/
|
|
462
469
|
export declare const autoSelectAgent: <ThrowOnError extends boolean = false>(options: Options<AutoSelectAgentData, ThrowOnError>) => import("./client").RequestResult<AutoSelectAgentResponses, AutoSelectAgentErrors, ThrowOnError, "fields">;
|
|
@@ -545,6 +552,13 @@ export declare const recommendAgent: <ThrowOnError extends boolean = false>(opti
|
|
|
545
552
|
* - User permissions and subscription tier
|
|
546
553
|
* - Backend capabilities (Kuzu, Neo4j, etc.)
|
|
547
554
|
*
|
|
555
|
+
* **Subgraph Support:**
|
|
556
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
557
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
558
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
559
|
+
* The returned tool list is identical for parent graphs and subgraphs, as all
|
|
560
|
+
* MCP tools work uniformly across graph boundaries.
|
|
561
|
+
*
|
|
548
562
|
* **Note:**
|
|
549
563
|
* MCP tool listing is included - no credit consumption required.
|
|
550
564
|
*/
|
|
@@ -583,6 +597,13 @@ export declare const listMcpTools: <ThrowOnError extends boolean = false>(option
|
|
|
583
597
|
* - `408 Request Timeout`: Tool execution exceeded timeout
|
|
584
598
|
* - Clients should implement exponential backoff on errors
|
|
585
599
|
*
|
|
600
|
+
* **Subgraph Support:**
|
|
601
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
602
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
603
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
604
|
+
* MCP tools operate on the specified graph/subgraph independently. Each subgraph
|
|
605
|
+
* has its own schema, data, and can be queried separately via MCP.
|
|
606
|
+
*
|
|
586
607
|
* **Credit Model:**
|
|
587
608
|
* MCP tool execution is included - no credit consumption required. Database
|
|
588
609
|
* operations (queries, schema inspection, analytics) are completely free.
|
|
@@ -850,6 +871,12 @@ export declare const getGraphUsageAnalytics: <ThrowOnError extends boolean = fal
|
|
|
850
871
|
* - `503 Service Unavailable`: Circuit breaker open or SSE disabled
|
|
851
872
|
* - Clients should implement exponential backoff
|
|
852
873
|
*
|
|
874
|
+
* **Subgraph Support:**
|
|
875
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
876
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
877
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
878
|
+
* Subgraphs share the same instance as their parent graph and have independent data.
|
|
879
|
+
*
|
|
853
880
|
* **Note:**
|
|
854
881
|
* Query operations are included - no credit consumption required.
|
|
855
882
|
* Queue position is based on subscription tier for priority.
|
|
@@ -892,6 +919,14 @@ export declare const executeCypherQuery: <ThrowOnError extends boolean = false>(
|
|
|
892
919
|
* Property discovery is limited to 10 properties per node type for performance.
|
|
893
920
|
* For complete schema definitions, use `/schema/export`.
|
|
894
921
|
*
|
|
922
|
+
* ## Subgraph Support
|
|
923
|
+
*
|
|
924
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
925
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
926
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
927
|
+
* Each subgraph has independent schema and data. The returned schema reflects
|
|
928
|
+
* only the specified graph/subgraph's actual structure.
|
|
929
|
+
*
|
|
895
930
|
* This operation is included - no credit consumption required.
|
|
896
931
|
*/
|
|
897
932
|
export declare const getGraphSchema: <ThrowOnError extends boolean = false>(options: Options<GetGraphSchemaData, ThrowOnError>) => import("./client").RequestResult<GetGraphSchemaResponses, GetGraphSchemaErrors, ThrowOnError, "fields">;
|
|
@@ -969,6 +1004,13 @@ export declare const exportGraphSchema: <ThrowOnError extends boolean = false>(o
|
|
|
969
1004
|
* - Performance problems
|
|
970
1005
|
* - Naming conflicts
|
|
971
1006
|
*
|
|
1007
|
+
* **Subgraph Support:**
|
|
1008
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1009
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1010
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1011
|
+
* Schema validation is performed against the specified graph/subgraph's current
|
|
1012
|
+
* schema and data structure.
|
|
1013
|
+
*
|
|
972
1014
|
* This operation is included - no credit consumption required.
|
|
973
1015
|
*/
|
|
974
1016
|
export declare const validateSchema: <ThrowOnError extends boolean = false>(options: Options<ValidateSchemaData, ThrowOnError>) => import("./client").RequestResult<ValidateSchemaResponses, ValidateSchemaErrors, ThrowOnError, "fields">;
|
|
@@ -1065,6 +1107,13 @@ export declare const checkStorageLimits: <ThrowOnError extends boolean = false>(
|
|
|
1065
1107
|
* - **Resource Usage**: Memory and storage consumption
|
|
1066
1108
|
* - **Alerts**: Active warnings or issues
|
|
1067
1109
|
*
|
|
1110
|
+
* **Subgraph Support:**
|
|
1111
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1112
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1113
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1114
|
+
* Health metrics are specific to the requested graph/subgraph. Subgraphs share the
|
|
1115
|
+
* same physical instance as their parent but have independent health indicators.
|
|
1116
|
+
*
|
|
1068
1117
|
* This endpoint provides essential monitoring data for operational visibility.
|
|
1069
1118
|
*/
|
|
1070
1119
|
export declare const getDatabaseHealth: <ThrowOnError extends boolean = false>(options: Options<GetDatabaseHealthData, ThrowOnError>) => import("./client").RequestResult<GetDatabaseHealthResponses, GetDatabaseHealthErrors, ThrowOnError, "fields">;
|
|
@@ -1087,6 +1136,13 @@ export declare const getDatabaseHealth: <ThrowOnError extends boolean = false>(o
|
|
|
1087
1136
|
* - **Backup Status**: Backup availability and recency
|
|
1088
1137
|
* - **Timestamps**: Creation and modification dates
|
|
1089
1138
|
*
|
|
1139
|
+
* **Subgraph Support:**
|
|
1140
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1141
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1142
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1143
|
+
* Returned metrics are specific to the requested graph/subgraph. Subgraphs have
|
|
1144
|
+
* independent size, node/relationship counts, and backup status.
|
|
1145
|
+
*
|
|
1090
1146
|
* This endpoint provides essential database information for capacity planning and monitoring.
|
|
1091
1147
|
*/
|
|
1092
1148
|
export declare const getDatabaseInfo: <ThrowOnError extends boolean = false>(options: Options<GetDatabaseInfoData, ThrowOnError>) => import("./client").RequestResult<GetDatabaseInfoResponses, GetDatabaseInfoErrors, ThrowOnError, "fields">;
|
|
@@ -1104,7 +1160,7 @@ export declare const getDatabaseInfo: <ThrowOnError extends boolean = false>(opt
|
|
|
1104
1160
|
*
|
|
1105
1161
|
* This unified endpoint provides all limits in one place for easier client integration.
|
|
1106
1162
|
*
|
|
1107
|
-
* **Note**: Limits vary based on subscription tier (
|
|
1163
|
+
* **Note**: Limits vary based on subscription tier (kuzu-standard, kuzu-large, kuzu-xlarge).
|
|
1108
1164
|
*/
|
|
1109
1165
|
export declare const getGraphLimits: <ThrowOnError extends boolean = false>(options: Options<GetGraphLimitsData, ThrowOnError>) => import("./client").RequestResult<GetGraphLimitsResponses, GetGraphLimitsErrors, ThrowOnError, "fields">;
|
|
1110
1166
|
/**
|
|
@@ -1135,6 +1191,12 @@ export declare const listSubgraphs: <ThrowOnError extends boolean = false>(optio
|
|
|
1135
1191
|
*
|
|
1136
1192
|
* **Returns:**
|
|
1137
1193
|
* - Created subgraph details including its unique ID
|
|
1194
|
+
* - Subgraph ID format: `{parent_id}_{subgraph_name}` (e.g., kg1234567890abcdef_dev)
|
|
1195
|
+
*
|
|
1196
|
+
* **Usage:**
|
|
1197
|
+
* - Subgraphs share parent's credit pool
|
|
1198
|
+
* - Subgraph ID can be used in all standard `/v1/graphs/{graph_id}*` endpoints
|
|
1199
|
+
* - Permissions inherited from parent graph
|
|
1138
1200
|
*/
|
|
1139
1201
|
export declare const createSubgraph: <ThrowOnError extends boolean = false>(options: Options<CreateSubgraphData, ThrowOnError>) => import("./client").RequestResult<CreateSubgraphResponses, CreateSubgraphErrors, ThrowOnError, "fields">;
|
|
1140
1202
|
/**
|
|
@@ -1144,6 +1206,7 @@ export declare const createSubgraph: <ThrowOnError extends boolean = false>(opti
|
|
|
1144
1206
|
* **Requirements:**
|
|
1145
1207
|
* - Must be a valid subgraph (not parent graph)
|
|
1146
1208
|
* - User must have admin access to parent graph
|
|
1209
|
+
* - Subgraph name must be alphanumeric (1-20 characters)
|
|
1147
1210
|
* - Optional backup before deletion
|
|
1148
1211
|
*
|
|
1149
1212
|
* **Deletion Options:**
|
|
@@ -1157,6 +1220,11 @@ export declare const createSubgraph: <ThrowOnError extends boolean = false>(opti
|
|
|
1157
1220
|
* **Backup Location:**
|
|
1158
1221
|
* If backup requested, stored in S3 Kuzu database bucket at:
|
|
1159
1222
|
* `s3://{kuzu_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
|
|
1223
|
+
*
|
|
1224
|
+
* **Notes:**
|
|
1225
|
+
* - Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID
|
|
1226
|
+
* - Deletion does not affect parent graph's credit pool or permissions
|
|
1227
|
+
* - Backup creation consumes credits from parent graph's allocation
|
|
1160
1228
|
*/
|
|
1161
1229
|
export declare const deleteSubgraph: <ThrowOnError extends boolean = false>(options: Options<DeleteSubgraphData, ThrowOnError>) => import("./client").RequestResult<DeleteSubgraphResponses, DeleteSubgraphErrors, ThrowOnError, "fields">;
|
|
1162
1230
|
/**
|
|
@@ -1165,6 +1233,7 @@ export declare const deleteSubgraph: <ThrowOnError extends boolean = false>(opti
|
|
|
1165
1233
|
*
|
|
1166
1234
|
* **Requirements:**
|
|
1167
1235
|
* - User must have read access to parent graph
|
|
1236
|
+
* - Subgraph name must be alphanumeric (1-20 characters)
|
|
1168
1237
|
*
|
|
1169
1238
|
* **Response includes:**
|
|
1170
1239
|
* - Full subgraph metadata
|
|
@@ -1180,6 +1249,10 @@ export declare const deleteSubgraph: <ThrowOnError extends boolean = false>(opti
|
|
|
1180
1249
|
* - Edge count
|
|
1181
1250
|
* - Database size on disk
|
|
1182
1251
|
* - Schema information
|
|
1252
|
+
*
|
|
1253
|
+
* **Note:**
|
|
1254
|
+
* Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID.
|
|
1255
|
+
* The full ID is returned in the response (e.g., 'kg0123456789abcdef_dev').
|
|
1183
1256
|
*/
|
|
1184
1257
|
export declare const getSubgraphInfo: <ThrowOnError extends boolean = false>(options: Options<GetSubgraphInfoData, ThrowOnError>) => import("./client").RequestResult<GetSubgraphInfoResponses, GetSubgraphInfoErrors, ThrowOnError, "fields">;
|
|
1185
1258
|
/**
|
|
@@ -1337,6 +1410,13 @@ export declare const listTableFiles: <ThrowOnError extends boolean = false>(opti
|
|
|
1337
1410
|
* Tables are automatically created on first file upload with type inferred from name
|
|
1338
1411
|
* (e.g., "Transaction" → relationship) and empty schema populated during ingestion.
|
|
1339
1412
|
*
|
|
1413
|
+
* **Subgraph Support:**
|
|
1414
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1415
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1416
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1417
|
+
* Each subgraph has completely isolated S3 staging areas and tables. Files uploaded
|
|
1418
|
+
* to one subgraph do not appear in other subgraphs.
|
|
1419
|
+
*
|
|
1340
1420
|
* **Important Notes:**
|
|
1341
1421
|
* - Presigned URLs expire (default: 1 hour)
|
|
1342
1422
|
* - Use appropriate Content-Type header when uploading to S3
|
|
@@ -1456,7 +1536,7 @@ export declare const updateFileStatus: <ThrowOnError extends boolean = false>(op
|
|
|
1456
1536
|
* 2. Files are validated and marked as 'uploaded'
|
|
1457
1537
|
* 3. Trigger ingestion: `POST /tables/ingest`
|
|
1458
1538
|
* 4. DuckDB staging tables created from S3 patterns
|
|
1459
|
-
* 5. Data copied
|
|
1539
|
+
* 5. Data copied from DuckDB to Kuzu
|
|
1460
1540
|
* 6. Per-table results and metrics returned
|
|
1461
1541
|
*
|
|
1462
1542
|
* **Rebuild Feature:**
|
|
@@ -1487,6 +1567,13 @@ export declare const updateFileStatus: <ThrowOnError extends boolean = false>(op
|
|
|
1487
1567
|
* you'll receive a 409 Conflict error. The distributed lock automatically expires after
|
|
1488
1568
|
* the configured TTL (default: 1 hour) to prevent deadlocks from failed ingestions.
|
|
1489
1569
|
*
|
|
1570
|
+
* **Subgraph Support:**
|
|
1571
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1572
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1573
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1574
|
+
* Each subgraph has independent staging tables and graph data. Ingestion operates
|
|
1575
|
+
* on the specified graph/subgraph only and does not affect other subgraphs.
|
|
1576
|
+
*
|
|
1490
1577
|
* **Important Notes:**
|
|
1491
1578
|
* - Only files with 'uploaded' status are processed
|
|
1492
1579
|
* - Tables with no uploaded files are skipped
|
|
@@ -1543,6 +1630,12 @@ export declare const ingestTables: <ThrowOnError extends boolean = false>(option
|
|
|
1543
1630
|
* - Read-only: No INSERT, UPDATE, DELETE
|
|
1544
1631
|
* - User's tables only: Cannot query other users' data
|
|
1545
1632
|
*
|
|
1633
|
+
* **Subgraph Support:**
|
|
1634
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1635
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1636
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1637
|
+
* Each subgraph has its own independent staging tables.
|
|
1638
|
+
*
|
|
1546
1639
|
* **Shared Repositories:**
|
|
1547
1640
|
* Shared repositories (SEC, etc.) do not allow direct SQL queries.
|
|
1548
1641
|
* Use the graph query endpoint instead: `POST /v1/graphs/{graph_id}/query`
|
package/sdk/sdk.gen.js
CHANGED
|
@@ -1103,6 +1103,13 @@ exports.listAgents = listAgents;
|
|
|
1103
1103
|
* - Leverage conversation history for contextual understanding
|
|
1104
1104
|
* - Enable RAG for knowledge base enrichment
|
|
1105
1105
|
*
|
|
1106
|
+
* **Subgraph Support:**
|
|
1107
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1108
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1109
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1110
|
+
* Agents operate on the specified graph/subgraph's data independently. RAG enrichment
|
|
1111
|
+
* and knowledge base search are scoped to the specific graph/subgraph.
|
|
1112
|
+
*
|
|
1106
1113
|
* See request/response examples in the "Examples" dropdown below.
|
|
1107
1114
|
*/
|
|
1108
1115
|
const autoSelectAgent = (options) => {
|
|
@@ -1287,6 +1294,13 @@ exports.recommendAgent = recommendAgent;
|
|
|
1287
1294
|
* - User permissions and subscription tier
|
|
1288
1295
|
* - Backend capabilities (Kuzu, Neo4j, etc.)
|
|
1289
1296
|
*
|
|
1297
|
+
* **Subgraph Support:**
|
|
1298
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1299
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1300
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1301
|
+
* The returned tool list is identical for parent graphs and subgraphs, as all
|
|
1302
|
+
* MCP tools work uniformly across graph boundaries.
|
|
1303
|
+
*
|
|
1290
1304
|
* **Note:**
|
|
1291
1305
|
* MCP tool listing is included - no credit consumption required.
|
|
1292
1306
|
*/
|
|
@@ -1341,6 +1355,13 @@ exports.listMcpTools = listMcpTools;
|
|
|
1341
1355
|
* - `408 Request Timeout`: Tool execution exceeded timeout
|
|
1342
1356
|
* - Clients should implement exponential backoff on errors
|
|
1343
1357
|
*
|
|
1358
|
+
* **Subgraph Support:**
|
|
1359
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1360
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1361
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1362
|
+
* MCP tools operate on the specified graph/subgraph independently. Each subgraph
|
|
1363
|
+
* has its own schema, data, and can be queried separately via MCP.
|
|
1364
|
+
*
|
|
1344
1365
|
* **Credit Model:**
|
|
1345
1366
|
* MCP tool execution is included - no credit consumption required. Database
|
|
1346
1367
|
* operations (queries, schema inspection, analytics) are completely free.
|
|
@@ -1748,6 +1769,12 @@ exports.getGraphUsageAnalytics = getGraphUsageAnalytics;
|
|
|
1748
1769
|
* - `503 Service Unavailable`: Circuit breaker open or SSE disabled
|
|
1749
1770
|
* - Clients should implement exponential backoff
|
|
1750
1771
|
*
|
|
1772
|
+
* **Subgraph Support:**
|
|
1773
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1774
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1775
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1776
|
+
* Subgraphs share the same instance as their parent graph and have independent data.
|
|
1777
|
+
*
|
|
1751
1778
|
* **Note:**
|
|
1752
1779
|
* Query operations are included - no credit consumption required.
|
|
1753
1780
|
* Queue position is based on subscription tier for priority.
|
|
@@ -1810,6 +1837,14 @@ exports.executeCypherQuery = executeCypherQuery;
|
|
|
1810
1837
|
* Property discovery is limited to 10 properties per node type for performance.
|
|
1811
1838
|
* For complete schema definitions, use `/schema/export`.
|
|
1812
1839
|
*
|
|
1840
|
+
* ## Subgraph Support
|
|
1841
|
+
*
|
|
1842
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1843
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1844
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1845
|
+
* Each subgraph has independent schema and data. The returned schema reflects
|
|
1846
|
+
* only the specified graph/subgraph's actual structure.
|
|
1847
|
+
*
|
|
1813
1848
|
* This operation is included - no credit consumption required.
|
|
1814
1849
|
*/
|
|
1815
1850
|
const getGraphSchema = (options) => {
|
|
@@ -1919,6 +1954,13 @@ exports.exportGraphSchema = exportGraphSchema;
|
|
|
1919
1954
|
* - Performance problems
|
|
1920
1955
|
* - Naming conflicts
|
|
1921
1956
|
*
|
|
1957
|
+
* **Subgraph Support:**
|
|
1958
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1959
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1960
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1961
|
+
* Schema validation is performed against the specified graph/subgraph's current
|
|
1962
|
+
* schema and data structure.
|
|
1963
|
+
*
|
|
1922
1964
|
* This operation is included - no credit consumption required.
|
|
1923
1965
|
*/
|
|
1924
1966
|
const validateSchema = (options) => {
|
|
@@ -2115,6 +2157,13 @@ exports.checkStorageLimits = checkStorageLimits;
|
|
|
2115
2157
|
* - **Resource Usage**: Memory and storage consumption
|
|
2116
2158
|
* - **Alerts**: Active warnings or issues
|
|
2117
2159
|
*
|
|
2160
|
+
* **Subgraph Support:**
|
|
2161
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
2162
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
2163
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
2164
|
+
* Health metrics are specific to the requested graph/subgraph. Subgraphs share the
|
|
2165
|
+
* same physical instance as their parent but have independent health indicators.
|
|
2166
|
+
*
|
|
2118
2167
|
* This endpoint provides essential monitoring data for operational visibility.
|
|
2119
2168
|
*/
|
|
2120
2169
|
const getDatabaseHealth = (options) => {
|
|
@@ -2153,6 +2202,13 @@ exports.getDatabaseHealth = getDatabaseHealth;
|
|
|
2153
2202
|
* - **Backup Status**: Backup availability and recency
|
|
2154
2203
|
* - **Timestamps**: Creation and modification dates
|
|
2155
2204
|
*
|
|
2205
|
+
* **Subgraph Support:**
|
|
2206
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
2207
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
2208
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
2209
|
+
* Returned metrics are specific to the requested graph/subgraph. Subgraphs have
|
|
2210
|
+
* independent size, node/relationship counts, and backup status.
|
|
2211
|
+
*
|
|
2156
2212
|
* This endpoint provides essential database information for capacity planning and monitoring.
|
|
2157
2213
|
*/
|
|
2158
2214
|
const getDatabaseInfo = (options) => {
|
|
@@ -2186,7 +2242,7 @@ exports.getDatabaseInfo = getDatabaseInfo;
|
|
|
2186
2242
|
*
|
|
2187
2243
|
* This unified endpoint provides all limits in one place for easier client integration.
|
|
2188
2244
|
*
|
|
2189
|
-
* **Note**: Limits vary based on subscription tier (
|
|
2245
|
+
* **Note**: Limits vary based on subscription tier (kuzu-standard, kuzu-large, kuzu-xlarge).
|
|
2190
2246
|
*/
|
|
2191
2247
|
const getGraphLimits = (options) => {
|
|
2192
2248
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -2249,6 +2305,12 @@ exports.listSubgraphs = listSubgraphs;
|
|
|
2249
2305
|
*
|
|
2250
2306
|
* **Returns:**
|
|
2251
2307
|
* - Created subgraph details including its unique ID
|
|
2308
|
+
* - Subgraph ID format: `{parent_id}_{subgraph_name}` (e.g., kg1234567890abcdef_dev)
|
|
2309
|
+
*
|
|
2310
|
+
* **Usage:**
|
|
2311
|
+
* - Subgraphs share parent's credit pool
|
|
2312
|
+
* - Subgraph ID can be used in all standard `/v1/graphs/{graph_id}*` endpoints
|
|
2313
|
+
* - Permissions inherited from parent graph
|
|
2252
2314
|
*/
|
|
2253
2315
|
const createSubgraph = (options) => {
|
|
2254
2316
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2278,6 +2340,7 @@ exports.createSubgraph = createSubgraph;
|
|
|
2278
2340
|
* **Requirements:**
|
|
2279
2341
|
* - Must be a valid subgraph (not parent graph)
|
|
2280
2342
|
* - User must have admin access to parent graph
|
|
2343
|
+
* - Subgraph name must be alphanumeric (1-20 characters)
|
|
2281
2344
|
* - Optional backup before deletion
|
|
2282
2345
|
*
|
|
2283
2346
|
* **Deletion Options:**
|
|
@@ -2291,6 +2354,11 @@ exports.createSubgraph = createSubgraph;
|
|
|
2291
2354
|
* **Backup Location:**
|
|
2292
2355
|
* If backup requested, stored in S3 Kuzu database bucket at:
|
|
2293
2356
|
* `s3://{kuzu_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
|
|
2357
|
+
*
|
|
2358
|
+
* **Notes:**
|
|
2359
|
+
* - Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID
|
|
2360
|
+
* - Deletion does not affect parent graph's credit pool or permissions
|
|
2361
|
+
* - Backup creation consumes credits from parent graph's allocation
|
|
2294
2362
|
*/
|
|
2295
2363
|
const deleteSubgraph = (options) => {
|
|
2296
2364
|
return (options.client ?? client_gen_1.client).delete({
|
|
@@ -2304,7 +2372,7 @@ const deleteSubgraph = (options) => {
|
|
|
2304
2372
|
type: 'http'
|
|
2305
2373
|
}
|
|
2306
2374
|
],
|
|
2307
|
-
url: '/v1/graphs/{graph_id}/subgraphs/{
|
|
2375
|
+
url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}',
|
|
2308
2376
|
...options,
|
|
2309
2377
|
headers: {
|
|
2310
2378
|
'Content-Type': 'application/json',
|
|
@@ -2319,6 +2387,7 @@ exports.deleteSubgraph = deleteSubgraph;
|
|
|
2319
2387
|
*
|
|
2320
2388
|
* **Requirements:**
|
|
2321
2389
|
* - User must have read access to parent graph
|
|
2390
|
+
* - Subgraph name must be alphanumeric (1-20 characters)
|
|
2322
2391
|
*
|
|
2323
2392
|
* **Response includes:**
|
|
2324
2393
|
* - Full subgraph metadata
|
|
@@ -2334,6 +2403,10 @@ exports.deleteSubgraph = deleteSubgraph;
|
|
|
2334
2403
|
* - Edge count
|
|
2335
2404
|
* - Database size on disk
|
|
2336
2405
|
* - Schema information
|
|
2406
|
+
*
|
|
2407
|
+
* **Note:**
|
|
2408
|
+
* Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID.
|
|
2409
|
+
* The full ID is returned in the response (e.g., 'kg0123456789abcdef_dev').
|
|
2337
2410
|
*/
|
|
2338
2411
|
const getSubgraphInfo = (options) => {
|
|
2339
2412
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -2347,7 +2420,7 @@ const getSubgraphInfo = (options) => {
|
|
|
2347
2420
|
type: 'http'
|
|
2348
2421
|
}
|
|
2349
2422
|
],
|
|
2350
|
-
url: '/v1/graphs/{graph_id}/subgraphs/{
|
|
2423
|
+
url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}/info',
|
|
2351
2424
|
...options
|
|
2352
2425
|
});
|
|
2353
2426
|
};
|
|
@@ -2611,6 +2684,13 @@ exports.listTableFiles = listTableFiles;
|
|
|
2611
2684
|
* Tables are automatically created on first file upload with type inferred from name
|
|
2612
2685
|
* (e.g., "Transaction" → relationship) and empty schema populated during ingestion.
|
|
2613
2686
|
*
|
|
2687
|
+
* **Subgraph Support:**
|
|
2688
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
2689
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
2690
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
2691
|
+
* Each subgraph has completely isolated S3 staging areas and tables. Files uploaded
|
|
2692
|
+
* to one subgraph do not appear in other subgraphs.
|
|
2693
|
+
*
|
|
2614
2694
|
* **Important Notes:**
|
|
2615
2695
|
* - Presigned URLs expire (default: 1 hour)
|
|
2616
2696
|
* - Use appropriate Content-Type header when uploading to S3
|
|
@@ -2802,7 +2882,7 @@ exports.updateFileStatus = updateFileStatus;
|
|
|
2802
2882
|
* 2. Files are validated and marked as 'uploaded'
|
|
2803
2883
|
* 3. Trigger ingestion: `POST /tables/ingest`
|
|
2804
2884
|
* 4. DuckDB staging tables created from S3 patterns
|
|
2805
|
-
* 5. Data copied
|
|
2885
|
+
* 5. Data copied from DuckDB to Kuzu
|
|
2806
2886
|
* 6. Per-table results and metrics returned
|
|
2807
2887
|
*
|
|
2808
2888
|
* **Rebuild Feature:**
|
|
@@ -2833,6 +2913,13 @@ exports.updateFileStatus = updateFileStatus;
|
|
|
2833
2913
|
* you'll receive a 409 Conflict error. The distributed lock automatically expires after
|
|
2834
2914
|
* the configured TTL (default: 1 hour) to prevent deadlocks from failed ingestions.
|
|
2835
2915
|
*
|
|
2916
|
+
* **Subgraph Support:**
|
|
2917
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
2918
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
2919
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
2920
|
+
* Each subgraph has independent staging tables and graph data. Ingestion operates
|
|
2921
|
+
* on the specified graph/subgraph only and does not affect other subgraphs.
|
|
2922
|
+
*
|
|
2836
2923
|
* **Important Notes:**
|
|
2837
2924
|
* - Only files with 'uploaded' status are processed
|
|
2838
2925
|
* - Tables with no uploaded files are skipped
|
|
@@ -2909,6 +2996,12 @@ exports.ingestTables = ingestTables;
|
|
|
2909
2996
|
* - Read-only: No INSERT, UPDATE, DELETE
|
|
2910
2997
|
* - User's tables only: Cannot query other users' data
|
|
2911
2998
|
*
|
|
2999
|
+
* **Subgraph Support:**
|
|
3000
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
3001
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
3002
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
3003
|
+
* Each subgraph has its own independent staging tables.
|
|
3004
|
+
*
|
|
2912
3005
|
* **Shared Repositories:**
|
|
2913
3006
|
* Shared repositories (SEC, etc.) do not allow direct SQL queries.
|
|
2914
3007
|
* Use the graph query endpoint instead: `POST /v1/graphs/{graph_id}/query`
|