@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/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`
|
package/sdk.gen.ts
CHANGED
|
@@ -1116,6 +1116,13 @@ export const listAgents = <ThrowOnError extends boolean = false>(options: Option
|
|
|
1116
1116
|
* - Leverage conversation history for contextual understanding
|
|
1117
1117
|
* - Enable RAG for knowledge base enrichment
|
|
1118
1118
|
*
|
|
1119
|
+
* **Subgraph Support:**
|
|
1120
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1121
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1122
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1123
|
+
* Agents operate on the specified graph/subgraph's data independently. RAG enrichment
|
|
1124
|
+
* and knowledge base search are scoped to the specific graph/subgraph.
|
|
1125
|
+
*
|
|
1119
1126
|
* See request/response examples in the "Examples" dropdown below.
|
|
1120
1127
|
*/
|
|
1121
1128
|
export const autoSelectAgent = <ThrowOnError extends boolean = false>(options: Options<AutoSelectAgentData, ThrowOnError>) => {
|
|
@@ -1300,6 +1307,13 @@ export const recommendAgent = <ThrowOnError extends boolean = false>(options: Op
|
|
|
1300
1307
|
* - User permissions and subscription tier
|
|
1301
1308
|
* - Backend capabilities (Kuzu, Neo4j, etc.)
|
|
1302
1309
|
*
|
|
1310
|
+
* **Subgraph Support:**
|
|
1311
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1312
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1313
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1314
|
+
* The returned tool list is identical for parent graphs and subgraphs, as all
|
|
1315
|
+
* MCP tools work uniformly across graph boundaries.
|
|
1316
|
+
*
|
|
1303
1317
|
* **Note:**
|
|
1304
1318
|
* MCP tool listing is included - no credit consumption required.
|
|
1305
1319
|
*/
|
|
@@ -1354,6 +1368,13 @@ export const listMcpTools = <ThrowOnError extends boolean = false>(options: Opti
|
|
|
1354
1368
|
* - `408 Request Timeout`: Tool execution exceeded timeout
|
|
1355
1369
|
* - Clients should implement exponential backoff on errors
|
|
1356
1370
|
*
|
|
1371
|
+
* **Subgraph Support:**
|
|
1372
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1373
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1374
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1375
|
+
* MCP tools operate on the specified graph/subgraph independently. Each subgraph
|
|
1376
|
+
* has its own schema, data, and can be queried separately via MCP.
|
|
1377
|
+
*
|
|
1357
1378
|
* **Credit Model:**
|
|
1358
1379
|
* MCP tool execution is included - no credit consumption required. Database
|
|
1359
1380
|
* operations (queries, schema inspection, analytics) are completely free.
|
|
@@ -1761,6 +1782,12 @@ export const getGraphUsageAnalytics = <ThrowOnError extends boolean = false>(opt
|
|
|
1761
1782
|
* - `503 Service Unavailable`: Circuit breaker open or SSE disabled
|
|
1762
1783
|
* - Clients should implement exponential backoff
|
|
1763
1784
|
*
|
|
1785
|
+
* **Subgraph Support:**
|
|
1786
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1787
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1788
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1789
|
+
* Subgraphs share the same instance as their parent graph and have independent data.
|
|
1790
|
+
*
|
|
1764
1791
|
* **Note:**
|
|
1765
1792
|
* Query operations are included - no credit consumption required.
|
|
1766
1793
|
* Queue position is based on subscription tier for priority.
|
|
@@ -1823,6 +1850,14 @@ export const executeCypherQuery = <ThrowOnError extends boolean = false>(options
|
|
|
1823
1850
|
* Property discovery is limited to 10 properties per node type for performance.
|
|
1824
1851
|
* For complete schema definitions, use `/schema/export`.
|
|
1825
1852
|
*
|
|
1853
|
+
* ## Subgraph Support
|
|
1854
|
+
*
|
|
1855
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1856
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1857
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1858
|
+
* Each subgraph has independent schema and data. The returned schema reflects
|
|
1859
|
+
* only the specified graph/subgraph's actual structure.
|
|
1860
|
+
*
|
|
1826
1861
|
* This operation is included - no credit consumption required.
|
|
1827
1862
|
*/
|
|
1828
1863
|
export const getGraphSchema = <ThrowOnError extends boolean = false>(options: Options<GetGraphSchemaData, ThrowOnError>) => {
|
|
@@ -1932,6 +1967,13 @@ export const exportGraphSchema = <ThrowOnError extends boolean = false>(options:
|
|
|
1932
1967
|
* - Performance problems
|
|
1933
1968
|
* - Naming conflicts
|
|
1934
1969
|
*
|
|
1970
|
+
* **Subgraph Support:**
|
|
1971
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
1972
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
1973
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
1974
|
+
* Schema validation is performed against the specified graph/subgraph's current
|
|
1975
|
+
* schema and data structure.
|
|
1976
|
+
*
|
|
1935
1977
|
* This operation is included - no credit consumption required.
|
|
1936
1978
|
*/
|
|
1937
1979
|
export const validateSchema = <ThrowOnError extends boolean = false>(options: Options<ValidateSchemaData, ThrowOnError>) => {
|
|
@@ -2128,6 +2170,13 @@ export const checkStorageLimits = <ThrowOnError extends boolean = false>(options
|
|
|
2128
2170
|
* - **Resource Usage**: Memory and storage consumption
|
|
2129
2171
|
* - **Alerts**: Active warnings or issues
|
|
2130
2172
|
*
|
|
2173
|
+
* **Subgraph Support:**
|
|
2174
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
2175
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
2176
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
2177
|
+
* Health metrics are specific to the requested graph/subgraph. Subgraphs share the
|
|
2178
|
+
* same physical instance as their parent but have independent health indicators.
|
|
2179
|
+
*
|
|
2131
2180
|
* This endpoint provides essential monitoring data for operational visibility.
|
|
2132
2181
|
*/
|
|
2133
2182
|
export const getDatabaseHealth = <ThrowOnError extends boolean = false>(options: Options<GetDatabaseHealthData, ThrowOnError>) => {
|
|
@@ -2166,6 +2215,13 @@ export const getDatabaseHealth = <ThrowOnError extends boolean = false>(options:
|
|
|
2166
2215
|
* - **Backup Status**: Backup availability and recency
|
|
2167
2216
|
* - **Timestamps**: Creation and modification dates
|
|
2168
2217
|
*
|
|
2218
|
+
* **Subgraph Support:**
|
|
2219
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
2220
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
2221
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
2222
|
+
* Returned metrics are specific to the requested graph/subgraph. Subgraphs have
|
|
2223
|
+
* independent size, node/relationship counts, and backup status.
|
|
2224
|
+
*
|
|
2169
2225
|
* This endpoint provides essential database information for capacity planning and monitoring.
|
|
2170
2226
|
*/
|
|
2171
2227
|
export const getDatabaseInfo = <ThrowOnError extends boolean = false>(options: Options<GetDatabaseInfoData, ThrowOnError>) => {
|
|
@@ -2199,7 +2255,7 @@ export const getDatabaseInfo = <ThrowOnError extends boolean = false>(options: O
|
|
|
2199
2255
|
*
|
|
2200
2256
|
* This unified endpoint provides all limits in one place for easier client integration.
|
|
2201
2257
|
*
|
|
2202
|
-
* **Note**: Limits vary based on subscription tier (
|
|
2258
|
+
* **Note**: Limits vary based on subscription tier (kuzu-standard, kuzu-large, kuzu-xlarge).
|
|
2203
2259
|
*/
|
|
2204
2260
|
export const getGraphLimits = <ThrowOnError extends boolean = false>(options: Options<GetGraphLimitsData, ThrowOnError>) => {
|
|
2205
2261
|
return (options.client ?? _heyApiClient).get<GetGraphLimitsResponses, GetGraphLimitsErrors, ThrowOnError>({
|
|
@@ -2262,6 +2318,12 @@ export const listSubgraphs = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
2262
2318
|
*
|
|
2263
2319
|
* **Returns:**
|
|
2264
2320
|
* - Created subgraph details including its unique ID
|
|
2321
|
+
* - Subgraph ID format: `{parent_id}_{subgraph_name}` (e.g., kg1234567890abcdef_dev)
|
|
2322
|
+
*
|
|
2323
|
+
* **Usage:**
|
|
2324
|
+
* - Subgraphs share parent's credit pool
|
|
2325
|
+
* - Subgraph ID can be used in all standard `/v1/graphs/{graph_id}*` endpoints
|
|
2326
|
+
* - Permissions inherited from parent graph
|
|
2265
2327
|
*/
|
|
2266
2328
|
export const createSubgraph = <ThrowOnError extends boolean = false>(options: Options<CreateSubgraphData, ThrowOnError>) => {
|
|
2267
2329
|
return (options.client ?? _heyApiClient).post<CreateSubgraphResponses, CreateSubgraphErrors, ThrowOnError>({
|
|
@@ -2291,6 +2353,7 @@ export const createSubgraph = <ThrowOnError extends boolean = false>(options: Op
|
|
|
2291
2353
|
* **Requirements:**
|
|
2292
2354
|
* - Must be a valid subgraph (not parent graph)
|
|
2293
2355
|
* - User must have admin access to parent graph
|
|
2356
|
+
* - Subgraph name must be alphanumeric (1-20 characters)
|
|
2294
2357
|
* - Optional backup before deletion
|
|
2295
2358
|
*
|
|
2296
2359
|
* **Deletion Options:**
|
|
@@ -2304,6 +2367,11 @@ export const createSubgraph = <ThrowOnError extends boolean = false>(options: Op
|
|
|
2304
2367
|
* **Backup Location:**
|
|
2305
2368
|
* If backup requested, stored in S3 Kuzu database bucket at:
|
|
2306
2369
|
* `s3://{kuzu_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
|
|
2370
|
+
*
|
|
2371
|
+
* **Notes:**
|
|
2372
|
+
* - Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID
|
|
2373
|
+
* - Deletion does not affect parent graph's credit pool or permissions
|
|
2374
|
+
* - Backup creation consumes credits from parent graph's allocation
|
|
2307
2375
|
*/
|
|
2308
2376
|
export const deleteSubgraph = <ThrowOnError extends boolean = false>(options: Options<DeleteSubgraphData, ThrowOnError>) => {
|
|
2309
2377
|
return (options.client ?? _heyApiClient).delete<DeleteSubgraphResponses, DeleteSubgraphErrors, ThrowOnError>({
|
|
@@ -2317,7 +2385,7 @@ export const deleteSubgraph = <ThrowOnError extends boolean = false>(options: Op
|
|
|
2317
2385
|
type: 'http'
|
|
2318
2386
|
}
|
|
2319
2387
|
],
|
|
2320
|
-
url: '/v1/graphs/{graph_id}/subgraphs/{
|
|
2388
|
+
url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}',
|
|
2321
2389
|
...options,
|
|
2322
2390
|
headers: {
|
|
2323
2391
|
'Content-Type': 'application/json',
|
|
@@ -2332,6 +2400,7 @@ export const deleteSubgraph = <ThrowOnError extends boolean = false>(options: Op
|
|
|
2332
2400
|
*
|
|
2333
2401
|
* **Requirements:**
|
|
2334
2402
|
* - User must have read access to parent graph
|
|
2403
|
+
* - Subgraph name must be alphanumeric (1-20 characters)
|
|
2335
2404
|
*
|
|
2336
2405
|
* **Response includes:**
|
|
2337
2406
|
* - Full subgraph metadata
|
|
@@ -2347,6 +2416,10 @@ export const deleteSubgraph = <ThrowOnError extends boolean = false>(options: Op
|
|
|
2347
2416
|
* - Edge count
|
|
2348
2417
|
* - Database size on disk
|
|
2349
2418
|
* - Schema information
|
|
2419
|
+
*
|
|
2420
|
+
* **Note:**
|
|
2421
|
+
* Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID.
|
|
2422
|
+
* The full ID is returned in the response (e.g., 'kg0123456789abcdef_dev').
|
|
2350
2423
|
*/
|
|
2351
2424
|
export const getSubgraphInfo = <ThrowOnError extends boolean = false>(options: Options<GetSubgraphInfoData, ThrowOnError>) => {
|
|
2352
2425
|
return (options.client ?? _heyApiClient).get<GetSubgraphInfoResponses, GetSubgraphInfoErrors, ThrowOnError>({
|
|
@@ -2360,7 +2433,7 @@ export const getSubgraphInfo = <ThrowOnError extends boolean = false>(options: O
|
|
|
2360
2433
|
type: 'http'
|
|
2361
2434
|
}
|
|
2362
2435
|
],
|
|
2363
|
-
url: '/v1/graphs/{graph_id}/subgraphs/{
|
|
2436
|
+
url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}/info',
|
|
2364
2437
|
...options
|
|
2365
2438
|
});
|
|
2366
2439
|
};
|
|
@@ -2624,6 +2697,13 @@ export const listTableFiles = <ThrowOnError extends boolean = false>(options: Op
|
|
|
2624
2697
|
* Tables are automatically created on first file upload with type inferred from name
|
|
2625
2698
|
* (e.g., "Transaction" → relationship) and empty schema populated during ingestion.
|
|
2626
2699
|
*
|
|
2700
|
+
* **Subgraph Support:**
|
|
2701
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
2702
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
2703
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
2704
|
+
* Each subgraph has completely isolated S3 staging areas and tables. Files uploaded
|
|
2705
|
+
* to one subgraph do not appear in other subgraphs.
|
|
2706
|
+
*
|
|
2627
2707
|
* **Important Notes:**
|
|
2628
2708
|
* - Presigned URLs expire (default: 1 hour)
|
|
2629
2709
|
* - Use appropriate Content-Type header when uploading to S3
|
|
@@ -2815,7 +2895,7 @@ export const updateFileStatus = <ThrowOnError extends boolean = false>(options:
|
|
|
2815
2895
|
* 2. Files are validated and marked as 'uploaded'
|
|
2816
2896
|
* 3. Trigger ingestion: `POST /tables/ingest`
|
|
2817
2897
|
* 4. DuckDB staging tables created from S3 patterns
|
|
2818
|
-
* 5. Data copied
|
|
2898
|
+
* 5. Data copied from DuckDB to Kuzu
|
|
2819
2899
|
* 6. Per-table results and metrics returned
|
|
2820
2900
|
*
|
|
2821
2901
|
* **Rebuild Feature:**
|
|
@@ -2846,6 +2926,13 @@ export const updateFileStatus = <ThrowOnError extends boolean = false>(options:
|
|
|
2846
2926
|
* you'll receive a 409 Conflict error. The distributed lock automatically expires after
|
|
2847
2927
|
* the configured TTL (default: 1 hour) to prevent deadlocks from failed ingestions.
|
|
2848
2928
|
*
|
|
2929
|
+
* **Subgraph Support:**
|
|
2930
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
2931
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
2932
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
2933
|
+
* Each subgraph has independent staging tables and graph data. Ingestion operates
|
|
2934
|
+
* on the specified graph/subgraph only and does not affect other subgraphs.
|
|
2935
|
+
*
|
|
2849
2936
|
* **Important Notes:**
|
|
2850
2937
|
* - Only files with 'uploaded' status are processed
|
|
2851
2938
|
* - Tables with no uploaded files are skipped
|
|
@@ -2922,6 +3009,12 @@ export const ingestTables = <ThrowOnError extends boolean = false>(options: Opti
|
|
|
2922
3009
|
* - Read-only: No INSERT, UPDATE, DELETE
|
|
2923
3010
|
* - User's tables only: Cannot query other users' data
|
|
2924
3011
|
*
|
|
3012
|
+
* **Subgraph Support:**
|
|
3013
|
+
* This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
3014
|
+
* - Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
3015
|
+
* - Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
3016
|
+
* Each subgraph has its own independent staging tables.
|
|
3017
|
+
*
|
|
2925
3018
|
* **Shared Repositories:**
|
|
2926
3019
|
* Shared repositories (SEC, etc.) do not allow direct SQL queries.
|
|
2927
3020
|
* Use the graph query endpoint instead: `POST /v1/graphs/{graph_id}/query`
|
package/types.gen.d.ts
CHANGED
|
@@ -3400,17 +3400,17 @@ export type PaymentMethod = {
|
|
|
3400
3400
|
brand?: string | null;
|
|
3401
3401
|
/**
|
|
3402
3402
|
* Last4
|
|
3403
|
-
* Last 4 digits
|
|
3403
|
+
* Last 4 digits of the card or account number
|
|
3404
3404
|
*/
|
|
3405
3405
|
last4?: string | null;
|
|
3406
3406
|
/**
|
|
3407
3407
|
* Exp Month
|
|
3408
|
-
* Expiration month
|
|
3408
|
+
* Expiration month of the card
|
|
3409
3409
|
*/
|
|
3410
3410
|
exp_month?: number | null;
|
|
3411
3411
|
/**
|
|
3412
3412
|
* Exp Year
|
|
3413
|
-
* Expiration year
|
|
3413
|
+
* Expiration year of the card
|
|
3414
3414
|
*/
|
|
3415
3415
|
exp_year?: number | null;
|
|
3416
3416
|
/**
|
|
@@ -7107,13 +7107,13 @@ export type DeleteSubgraphData = {
|
|
|
7107
7107
|
*/
|
|
7108
7108
|
graph_id: string;
|
|
7109
7109
|
/**
|
|
7110
|
-
* Subgraph
|
|
7111
|
-
* Subgraph
|
|
7110
|
+
* Subgraph Name
|
|
7111
|
+
* Subgraph name to delete (e.g., 'dev', 'staging')
|
|
7112
7112
|
*/
|
|
7113
|
-
|
|
7113
|
+
subgraph_name: string;
|
|
7114
7114
|
};
|
|
7115
7115
|
query?: never;
|
|
7116
|
-
url: '/v1/graphs/{graph_id}/subgraphs/{
|
|
7116
|
+
url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}';
|
|
7117
7117
|
};
|
|
7118
7118
|
export type DeleteSubgraphErrors = {
|
|
7119
7119
|
/**
|
|
@@ -7161,13 +7161,13 @@ export type GetSubgraphInfoData = {
|
|
|
7161
7161
|
*/
|
|
7162
7162
|
graph_id: string;
|
|
7163
7163
|
/**
|
|
7164
|
-
* Subgraph
|
|
7165
|
-
* Subgraph
|
|
7164
|
+
* Subgraph Name
|
|
7165
|
+
* Subgraph name (e.g., 'dev', 'staging')
|
|
7166
7166
|
*/
|
|
7167
|
-
|
|
7167
|
+
subgraph_name: string;
|
|
7168
7168
|
};
|
|
7169
7169
|
query?: never;
|
|
7170
|
-
url: '/v1/graphs/{graph_id}/subgraphs/{
|
|
7170
|
+
url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}/info';
|
|
7171
7171
|
};
|
|
7172
7172
|
export type GetSubgraphInfoErrors = {
|
|
7173
7173
|
/**
|
package/types.gen.ts
CHANGED
|
@@ -3509,17 +3509,17 @@ export type PaymentMethod = {
|
|
|
3509
3509
|
brand?: string | null;
|
|
3510
3510
|
/**
|
|
3511
3511
|
* Last4
|
|
3512
|
-
* Last 4 digits
|
|
3512
|
+
* Last 4 digits of the card or account number
|
|
3513
3513
|
*/
|
|
3514
3514
|
last4?: string | null;
|
|
3515
3515
|
/**
|
|
3516
3516
|
* Exp Month
|
|
3517
|
-
* Expiration month
|
|
3517
|
+
* Expiration month of the card
|
|
3518
3518
|
*/
|
|
3519
3519
|
exp_month?: number | null;
|
|
3520
3520
|
/**
|
|
3521
3521
|
* Exp Year
|
|
3522
|
-
* Expiration year
|
|
3522
|
+
* Expiration year of the card
|
|
3523
3523
|
*/
|
|
3524
3524
|
exp_year?: number | null;
|
|
3525
3525
|
/**
|
|
@@ -7617,13 +7617,13 @@ export type DeleteSubgraphData = {
|
|
|
7617
7617
|
*/
|
|
7618
7618
|
graph_id: string;
|
|
7619
7619
|
/**
|
|
7620
|
-
* Subgraph
|
|
7621
|
-
* Subgraph
|
|
7620
|
+
* Subgraph Name
|
|
7621
|
+
* Subgraph name to delete (e.g., 'dev', 'staging')
|
|
7622
7622
|
*/
|
|
7623
|
-
|
|
7623
|
+
subgraph_name: string;
|
|
7624
7624
|
};
|
|
7625
7625
|
query?: never;
|
|
7626
|
-
url: '/v1/graphs/{graph_id}/subgraphs/{
|
|
7626
|
+
url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}';
|
|
7627
7627
|
};
|
|
7628
7628
|
|
|
7629
7629
|
export type DeleteSubgraphErrors = {
|
|
@@ -7676,13 +7676,13 @@ export type GetSubgraphInfoData = {
|
|
|
7676
7676
|
*/
|
|
7677
7677
|
graph_id: string;
|
|
7678
7678
|
/**
|
|
7679
|
-
* Subgraph
|
|
7680
|
-
* Subgraph
|
|
7679
|
+
* Subgraph Name
|
|
7680
|
+
* Subgraph name (e.g., 'dev', 'staging')
|
|
7681
7681
|
*/
|
|
7682
|
-
|
|
7682
|
+
subgraph_name: string;
|
|
7683
7683
|
};
|
|
7684
7684
|
query?: never;
|
|
7685
|
-
url: '/v1/graphs/{graph_id}/subgraphs/{
|
|
7685
|
+
url: '/v1/graphs/{graph_id}/subgraphs/{subgraph_name}/info';
|
|
7686
7686
|
};
|
|
7687
7687
|
|
|
7688
7688
|
export type GetSubgraphInfoErrors = {
|