robosystems-client 0.2.13__py3-none-any.whl → 0.2.15__py3-none-any.whl
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.
Potentially problematic release.
This version of robosystems-client might be problematic. Click here for more details.
- robosystems_client/api/agent/auto_select_agent.py +28 -0
- robosystems_client/api/billing/{update_org_payment_method.py → create_portal_session.py} +57 -47
- robosystems_client/api/graph_health/get_database_health.py +28 -0
- robosystems_client/api/graph_info/get_database_info.py +28 -0
- robosystems_client/api/graph_limits/get_graph_limits.py +4 -4
- robosystems_client/api/mcp/call_mcp_tool.py +28 -0
- robosystems_client/api/mcp/list_mcp_tools.py +28 -0
- robosystems_client/api/query/execute_cypher_query.py +24 -0
- robosystems_client/api/schema/get_graph_schema.py +32 -0
- robosystems_client/api/schema/validate_schema.py +28 -0
- robosystems_client/api/subgraphs/create_subgraph.py +28 -4
- robosystems_client/api/subgraphs/delete_subgraph.py +46 -22
- robosystems_client/api/subgraphs/get_subgraph_info.py +34 -14
- robosystems_client/api/tables/get_upload_url.py +28 -0
- robosystems_client/api/tables/ingest_tables.py +32 -4
- robosystems_client/api/tables/query_tables.py +24 -0
- robosystems_client/models/__init__.py +2 -6
- robosystems_client/models/create_subgraph_request.py +5 -26
- robosystems_client/models/graph_subscription_response.py +21 -0
- robosystems_client/models/list_subgraphs_response.py +9 -0
- robosystems_client/models/payment_method.py +3 -3
- robosystems_client/models/{update_payment_method_request.py → portal_session_response.py} +12 -12
- {robosystems_client-0.2.13.dist-info → robosystems_client-0.2.15.dist-info}/METADATA +1 -1
- {robosystems_client-0.2.13.dist-info → robosystems_client-0.2.15.dist-info}/RECORD +26 -29
- robosystems_client/api/subscriptions/cancel_subscription.py +0 -193
- robosystems_client/models/cancellation_response.py +0 -76
- robosystems_client/models/update_payment_method_response.py +0 -74
- {robosystems_client-0.2.13.dist-info → robosystems_client-0.2.15.dist-info}/WHEEL +0 -0
- {robosystems_client-0.2.13.dist-info → robosystems_client-0.2.15.dist-info}/licenses/LICENSE +0 -0
|
@@ -105,6 +105,13 @@ def sync_detailed(
|
|
|
105
105
|
- Performance problems
|
|
106
106
|
- Naming conflicts
|
|
107
107
|
|
|
108
|
+
**Subgraph Support:**
|
|
109
|
+
This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
110
|
+
- Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
111
|
+
- Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
112
|
+
Schema validation is performed against the specified graph/subgraph's current
|
|
113
|
+
schema and data structure.
|
|
114
|
+
|
|
108
115
|
This operation is included - no credit consumption required.
|
|
109
116
|
|
|
110
117
|
Args:
|
|
@@ -160,6 +167,13 @@ def sync(
|
|
|
160
167
|
- Performance problems
|
|
161
168
|
- Naming conflicts
|
|
162
169
|
|
|
170
|
+
**Subgraph Support:**
|
|
171
|
+
This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
172
|
+
- Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
173
|
+
- Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
174
|
+
Schema validation is performed against the specified graph/subgraph's current
|
|
175
|
+
schema and data structure.
|
|
176
|
+
|
|
163
177
|
This operation is included - no credit consumption required.
|
|
164
178
|
|
|
165
179
|
Args:
|
|
@@ -210,6 +224,13 @@ async def asyncio_detailed(
|
|
|
210
224
|
- Performance problems
|
|
211
225
|
- Naming conflicts
|
|
212
226
|
|
|
227
|
+
**Subgraph Support:**
|
|
228
|
+
This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
229
|
+
- Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
230
|
+
- Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
231
|
+
Schema validation is performed against the specified graph/subgraph's current
|
|
232
|
+
schema and data structure.
|
|
233
|
+
|
|
213
234
|
This operation is included - no credit consumption required.
|
|
214
235
|
|
|
215
236
|
Args:
|
|
@@ -263,6 +284,13 @@ async def asyncio(
|
|
|
263
284
|
- Performance problems
|
|
264
285
|
- Naming conflicts
|
|
265
286
|
|
|
287
|
+
**Subgraph Support:**
|
|
288
|
+
This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
289
|
+
- Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
290
|
+
- Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
291
|
+
Schema validation is performed against the specified graph/subgraph's current
|
|
292
|
+
schema and data structure.
|
|
293
|
+
|
|
266
294
|
This operation is included - no credit consumption required.
|
|
267
295
|
|
|
268
296
|
Args:
|
|
@@ -75,12 +75,18 @@ def sync_detailed(
|
|
|
75
75
|
- Valid authentication
|
|
76
76
|
- Parent graph must exist and be accessible to the user
|
|
77
77
|
- User must have 'admin' permission on the parent graph
|
|
78
|
-
- Parent graph tier must support subgraphs (
|
|
78
|
+
- Parent graph tier must support subgraphs (Kuzu Large/XLarge or Neo4j Enterprise XLarge)
|
|
79
79
|
- Must be within subgraph quota limits
|
|
80
80
|
- Subgraph name must be unique within the parent graph
|
|
81
81
|
|
|
82
82
|
**Returns:**
|
|
83
83
|
- Created subgraph details including its unique ID
|
|
84
|
+
- Subgraph ID format: `{parent_id}_{subgraph_name}` (e.g., kg1234567890abcdef_dev)
|
|
85
|
+
|
|
86
|
+
**Usage:**
|
|
87
|
+
- Subgraphs share parent's credit pool
|
|
88
|
+
- Subgraph ID can be used in all standard `/v1/graphs/{graph_id}/*` endpoints
|
|
89
|
+
- Permissions inherited from parent graph
|
|
84
90
|
|
|
85
91
|
Args:
|
|
86
92
|
graph_id (str):
|
|
@@ -120,12 +126,18 @@ def sync(
|
|
|
120
126
|
- Valid authentication
|
|
121
127
|
- Parent graph must exist and be accessible to the user
|
|
122
128
|
- User must have 'admin' permission on the parent graph
|
|
123
|
-
- Parent graph tier must support subgraphs (
|
|
129
|
+
- Parent graph tier must support subgraphs (Kuzu Large/XLarge or Neo4j Enterprise XLarge)
|
|
124
130
|
- Must be within subgraph quota limits
|
|
125
131
|
- Subgraph name must be unique within the parent graph
|
|
126
132
|
|
|
127
133
|
**Returns:**
|
|
128
134
|
- Created subgraph details including its unique ID
|
|
135
|
+
- Subgraph ID format: `{parent_id}_{subgraph_name}` (e.g., kg1234567890abcdef_dev)
|
|
136
|
+
|
|
137
|
+
**Usage:**
|
|
138
|
+
- Subgraphs share parent's credit pool
|
|
139
|
+
- Subgraph ID can be used in all standard `/v1/graphs/{graph_id}/*` endpoints
|
|
140
|
+
- Permissions inherited from parent graph
|
|
129
141
|
|
|
130
142
|
Args:
|
|
131
143
|
graph_id (str):
|
|
@@ -160,12 +172,18 @@ async def asyncio_detailed(
|
|
|
160
172
|
- Valid authentication
|
|
161
173
|
- Parent graph must exist and be accessible to the user
|
|
162
174
|
- User must have 'admin' permission on the parent graph
|
|
163
|
-
- Parent graph tier must support subgraphs (
|
|
175
|
+
- Parent graph tier must support subgraphs (Kuzu Large/XLarge or Neo4j Enterprise XLarge)
|
|
164
176
|
- Must be within subgraph quota limits
|
|
165
177
|
- Subgraph name must be unique within the parent graph
|
|
166
178
|
|
|
167
179
|
**Returns:**
|
|
168
180
|
- Created subgraph details including its unique ID
|
|
181
|
+
- Subgraph ID format: `{parent_id}_{subgraph_name}` (e.g., kg1234567890abcdef_dev)
|
|
182
|
+
|
|
183
|
+
**Usage:**
|
|
184
|
+
- Subgraphs share parent's credit pool
|
|
185
|
+
- Subgraph ID can be used in all standard `/v1/graphs/{graph_id}/*` endpoints
|
|
186
|
+
- Permissions inherited from parent graph
|
|
169
187
|
|
|
170
188
|
Args:
|
|
171
189
|
graph_id (str):
|
|
@@ -203,12 +221,18 @@ async def asyncio(
|
|
|
203
221
|
- Valid authentication
|
|
204
222
|
- Parent graph must exist and be accessible to the user
|
|
205
223
|
- User must have 'admin' permission on the parent graph
|
|
206
|
-
- Parent graph tier must support subgraphs (
|
|
224
|
+
- Parent graph tier must support subgraphs (Kuzu Large/XLarge or Neo4j Enterprise XLarge)
|
|
207
225
|
- Must be within subgraph quota limits
|
|
208
226
|
- Subgraph name must be unique within the parent graph
|
|
209
227
|
|
|
210
228
|
**Returns:**
|
|
211
229
|
- Created subgraph details including its unique ID
|
|
230
|
+
- Subgraph ID format: `{parent_id}_{subgraph_name}` (e.g., kg1234567890abcdef_dev)
|
|
231
|
+
|
|
232
|
+
**Usage:**
|
|
233
|
+
- Subgraphs share parent's credit pool
|
|
234
|
+
- Subgraph ID can be used in all standard `/v1/graphs/{graph_id}/*` endpoints
|
|
235
|
+
- Permissions inherited from parent graph
|
|
212
236
|
|
|
213
237
|
Args:
|
|
214
238
|
graph_id (str):
|
|
@@ -13,7 +13,7 @@ from ...types import Response
|
|
|
13
13
|
|
|
14
14
|
def _get_kwargs(
|
|
15
15
|
graph_id: str,
|
|
16
|
-
|
|
16
|
+
subgraph_name: str,
|
|
17
17
|
*,
|
|
18
18
|
body: DeleteSubgraphRequest,
|
|
19
19
|
) -> dict[str, Any]:
|
|
@@ -21,7 +21,7 @@ def _get_kwargs(
|
|
|
21
21
|
|
|
22
22
|
_kwargs: dict[str, Any] = {
|
|
23
23
|
"method": "delete",
|
|
24
|
-
"url": f"/v1/graphs/{graph_id}/subgraphs/{
|
|
24
|
+
"url": f"/v1/graphs/{graph_id}/subgraphs/{subgraph_name}",
|
|
25
25
|
}
|
|
26
26
|
|
|
27
27
|
_kwargs["json"] = body.to_dict()
|
|
@@ -88,7 +88,7 @@ def _build_response(
|
|
|
88
88
|
|
|
89
89
|
def sync_detailed(
|
|
90
90
|
graph_id: str,
|
|
91
|
-
|
|
91
|
+
subgraph_name: str,
|
|
92
92
|
*,
|
|
93
93
|
client: AuthenticatedClient,
|
|
94
94
|
body: DeleteSubgraphRequest,
|
|
@@ -100,6 +100,7 @@ def sync_detailed(
|
|
|
100
100
|
**Requirements:**
|
|
101
101
|
- Must be a valid subgraph (not parent graph)
|
|
102
102
|
- User must have admin access to parent graph
|
|
103
|
+
- Subgraph name must be alphanumeric (1-20 characters)
|
|
103
104
|
- Optional backup before deletion
|
|
104
105
|
|
|
105
106
|
**Deletion Options:**
|
|
@@ -111,12 +112,17 @@ def sync_detailed(
|
|
|
111
112
|
All data in the subgraph will be lost.
|
|
112
113
|
|
|
113
114
|
**Backup Location:**
|
|
114
|
-
If backup requested, stored in S3 at:
|
|
115
|
-
`s3://
|
|
115
|
+
If backup requested, stored in S3 Kuzu database bucket at:
|
|
116
|
+
`s3://{kuzu_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
|
|
117
|
+
|
|
118
|
+
**Notes:**
|
|
119
|
+
- Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID
|
|
120
|
+
- Deletion does not affect parent graph's credit pool or permissions
|
|
121
|
+
- Backup creation consumes credits from parent graph's allocation
|
|
116
122
|
|
|
117
123
|
Args:
|
|
118
124
|
graph_id (str):
|
|
119
|
-
|
|
125
|
+
subgraph_name (str): Subgraph name to delete (e.g., 'dev', 'staging')
|
|
120
126
|
body (DeleteSubgraphRequest): Request model for deleting a subgraph.
|
|
121
127
|
|
|
122
128
|
Raises:
|
|
@@ -129,7 +135,7 @@ def sync_detailed(
|
|
|
129
135
|
|
|
130
136
|
kwargs = _get_kwargs(
|
|
131
137
|
graph_id=graph_id,
|
|
132
|
-
|
|
138
|
+
subgraph_name=subgraph_name,
|
|
133
139
|
body=body,
|
|
134
140
|
)
|
|
135
141
|
|
|
@@ -142,7 +148,7 @@ def sync_detailed(
|
|
|
142
148
|
|
|
143
149
|
def sync(
|
|
144
150
|
graph_id: str,
|
|
145
|
-
|
|
151
|
+
subgraph_name: str,
|
|
146
152
|
*,
|
|
147
153
|
client: AuthenticatedClient,
|
|
148
154
|
body: DeleteSubgraphRequest,
|
|
@@ -154,6 +160,7 @@ def sync(
|
|
|
154
160
|
**Requirements:**
|
|
155
161
|
- Must be a valid subgraph (not parent graph)
|
|
156
162
|
- User must have admin access to parent graph
|
|
163
|
+
- Subgraph name must be alphanumeric (1-20 characters)
|
|
157
164
|
- Optional backup before deletion
|
|
158
165
|
|
|
159
166
|
**Deletion Options:**
|
|
@@ -165,12 +172,17 @@ def sync(
|
|
|
165
172
|
All data in the subgraph will be lost.
|
|
166
173
|
|
|
167
174
|
**Backup Location:**
|
|
168
|
-
If backup requested, stored in S3 at:
|
|
169
|
-
`s3://
|
|
175
|
+
If backup requested, stored in S3 Kuzu database bucket at:
|
|
176
|
+
`s3://{kuzu_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
|
|
177
|
+
|
|
178
|
+
**Notes:**
|
|
179
|
+
- Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID
|
|
180
|
+
- Deletion does not affect parent graph's credit pool or permissions
|
|
181
|
+
- Backup creation consumes credits from parent graph's allocation
|
|
170
182
|
|
|
171
183
|
Args:
|
|
172
184
|
graph_id (str):
|
|
173
|
-
|
|
185
|
+
subgraph_name (str): Subgraph name to delete (e.g., 'dev', 'staging')
|
|
174
186
|
body (DeleteSubgraphRequest): Request model for deleting a subgraph.
|
|
175
187
|
|
|
176
188
|
Raises:
|
|
@@ -183,7 +195,7 @@ def sync(
|
|
|
183
195
|
|
|
184
196
|
return sync_detailed(
|
|
185
197
|
graph_id=graph_id,
|
|
186
|
-
|
|
198
|
+
subgraph_name=subgraph_name,
|
|
187
199
|
client=client,
|
|
188
200
|
body=body,
|
|
189
201
|
).parsed
|
|
@@ -191,7 +203,7 @@ def sync(
|
|
|
191
203
|
|
|
192
204
|
async def asyncio_detailed(
|
|
193
205
|
graph_id: str,
|
|
194
|
-
|
|
206
|
+
subgraph_name: str,
|
|
195
207
|
*,
|
|
196
208
|
client: AuthenticatedClient,
|
|
197
209
|
body: DeleteSubgraphRequest,
|
|
@@ -203,6 +215,7 @@ async def asyncio_detailed(
|
|
|
203
215
|
**Requirements:**
|
|
204
216
|
- Must be a valid subgraph (not parent graph)
|
|
205
217
|
- User must have admin access to parent graph
|
|
218
|
+
- Subgraph name must be alphanumeric (1-20 characters)
|
|
206
219
|
- Optional backup before deletion
|
|
207
220
|
|
|
208
221
|
**Deletion Options:**
|
|
@@ -214,12 +227,17 @@ async def asyncio_detailed(
|
|
|
214
227
|
All data in the subgraph will be lost.
|
|
215
228
|
|
|
216
229
|
**Backup Location:**
|
|
217
|
-
If backup requested, stored in S3 at:
|
|
218
|
-
`s3://
|
|
230
|
+
If backup requested, stored in S3 Kuzu database bucket at:
|
|
231
|
+
`s3://{kuzu_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
|
|
232
|
+
|
|
233
|
+
**Notes:**
|
|
234
|
+
- Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID
|
|
235
|
+
- Deletion does not affect parent graph's credit pool or permissions
|
|
236
|
+
- Backup creation consumes credits from parent graph's allocation
|
|
219
237
|
|
|
220
238
|
Args:
|
|
221
239
|
graph_id (str):
|
|
222
|
-
|
|
240
|
+
subgraph_name (str): Subgraph name to delete (e.g., 'dev', 'staging')
|
|
223
241
|
body (DeleteSubgraphRequest): Request model for deleting a subgraph.
|
|
224
242
|
|
|
225
243
|
Raises:
|
|
@@ -232,7 +250,7 @@ async def asyncio_detailed(
|
|
|
232
250
|
|
|
233
251
|
kwargs = _get_kwargs(
|
|
234
252
|
graph_id=graph_id,
|
|
235
|
-
|
|
253
|
+
subgraph_name=subgraph_name,
|
|
236
254
|
body=body,
|
|
237
255
|
)
|
|
238
256
|
|
|
@@ -243,7 +261,7 @@ async def asyncio_detailed(
|
|
|
243
261
|
|
|
244
262
|
async def asyncio(
|
|
245
263
|
graph_id: str,
|
|
246
|
-
|
|
264
|
+
subgraph_name: str,
|
|
247
265
|
*,
|
|
248
266
|
client: AuthenticatedClient,
|
|
249
267
|
body: DeleteSubgraphRequest,
|
|
@@ -255,6 +273,7 @@ async def asyncio(
|
|
|
255
273
|
**Requirements:**
|
|
256
274
|
- Must be a valid subgraph (not parent graph)
|
|
257
275
|
- User must have admin access to parent graph
|
|
276
|
+
- Subgraph name must be alphanumeric (1-20 characters)
|
|
258
277
|
- Optional backup before deletion
|
|
259
278
|
|
|
260
279
|
**Deletion Options:**
|
|
@@ -266,12 +285,17 @@ async def asyncio(
|
|
|
266
285
|
All data in the subgraph will be lost.
|
|
267
286
|
|
|
268
287
|
**Backup Location:**
|
|
269
|
-
If backup requested, stored in S3 at:
|
|
270
|
-
`s3://
|
|
288
|
+
If backup requested, stored in S3 Kuzu database bucket at:
|
|
289
|
+
`s3://{kuzu_s3_bucket}/{instance_id}/{database_name}_{timestamp}.backup`
|
|
290
|
+
|
|
291
|
+
**Notes:**
|
|
292
|
+
- Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID
|
|
293
|
+
- Deletion does not affect parent graph's credit pool or permissions
|
|
294
|
+
- Backup creation consumes credits from parent graph's allocation
|
|
271
295
|
|
|
272
296
|
Args:
|
|
273
297
|
graph_id (str):
|
|
274
|
-
|
|
298
|
+
subgraph_name (str): Subgraph name to delete (e.g., 'dev', 'staging')
|
|
275
299
|
body (DeleteSubgraphRequest): Request model for deleting a subgraph.
|
|
276
300
|
|
|
277
301
|
Raises:
|
|
@@ -285,7 +309,7 @@ async def asyncio(
|
|
|
285
309
|
return (
|
|
286
310
|
await asyncio_detailed(
|
|
287
311
|
graph_id=graph_id,
|
|
288
|
-
|
|
312
|
+
subgraph_name=subgraph_name,
|
|
289
313
|
client=client,
|
|
290
314
|
body=body,
|
|
291
315
|
)
|
|
@@ -12,11 +12,11 @@ from ...types import Response
|
|
|
12
12
|
|
|
13
13
|
def _get_kwargs(
|
|
14
14
|
graph_id: str,
|
|
15
|
-
|
|
15
|
+
subgraph_name: str,
|
|
16
16
|
) -> dict[str, Any]:
|
|
17
17
|
_kwargs: dict[str, Any] = {
|
|
18
18
|
"method": "get",
|
|
19
|
-
"url": f"/v1/graphs/{graph_id}/subgraphs/{
|
|
19
|
+
"url": f"/v1/graphs/{graph_id}/subgraphs/{subgraph_name}/info",
|
|
20
20
|
}
|
|
21
21
|
|
|
22
22
|
return _kwargs
|
|
@@ -74,7 +74,7 @@ def _build_response(
|
|
|
74
74
|
|
|
75
75
|
def sync_detailed(
|
|
76
76
|
graph_id: str,
|
|
77
|
-
|
|
77
|
+
subgraph_name: str,
|
|
78
78
|
*,
|
|
79
79
|
client: AuthenticatedClient,
|
|
80
80
|
) -> Response[Union[Any, HTTPValidationError, SubgraphResponse]]:
|
|
@@ -84,6 +84,7 @@ def sync_detailed(
|
|
|
84
84
|
|
|
85
85
|
**Requirements:**
|
|
86
86
|
- User must have read access to parent graph
|
|
87
|
+
- Subgraph name must be alphanumeric (1-20 characters)
|
|
87
88
|
|
|
88
89
|
**Response includes:**
|
|
89
90
|
- Full subgraph metadata
|
|
@@ -100,9 +101,13 @@ def sync_detailed(
|
|
|
100
101
|
- Database size on disk
|
|
101
102
|
- Schema information
|
|
102
103
|
|
|
104
|
+
**Note:**
|
|
105
|
+
Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID.
|
|
106
|
+
The full ID is returned in the response (e.g., 'kg0123456789abcdef_dev').
|
|
107
|
+
|
|
103
108
|
Args:
|
|
104
109
|
graph_id (str):
|
|
105
|
-
|
|
110
|
+
subgraph_name (str): Subgraph name (e.g., 'dev', 'staging')
|
|
106
111
|
|
|
107
112
|
Raises:
|
|
108
113
|
errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
|
|
@@ -114,7 +119,7 @@ def sync_detailed(
|
|
|
114
119
|
|
|
115
120
|
kwargs = _get_kwargs(
|
|
116
121
|
graph_id=graph_id,
|
|
117
|
-
|
|
122
|
+
subgraph_name=subgraph_name,
|
|
118
123
|
)
|
|
119
124
|
|
|
120
125
|
response = client.get_httpx_client().request(
|
|
@@ -126,7 +131,7 @@ def sync_detailed(
|
|
|
126
131
|
|
|
127
132
|
def sync(
|
|
128
133
|
graph_id: str,
|
|
129
|
-
|
|
134
|
+
subgraph_name: str,
|
|
130
135
|
*,
|
|
131
136
|
client: AuthenticatedClient,
|
|
132
137
|
) -> Optional[Union[Any, HTTPValidationError, SubgraphResponse]]:
|
|
@@ -136,6 +141,7 @@ def sync(
|
|
|
136
141
|
|
|
137
142
|
**Requirements:**
|
|
138
143
|
- User must have read access to parent graph
|
|
144
|
+
- Subgraph name must be alphanumeric (1-20 characters)
|
|
139
145
|
|
|
140
146
|
**Response includes:**
|
|
141
147
|
- Full subgraph metadata
|
|
@@ -152,9 +158,13 @@ def sync(
|
|
|
152
158
|
- Database size on disk
|
|
153
159
|
- Schema information
|
|
154
160
|
|
|
161
|
+
**Note:**
|
|
162
|
+
Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID.
|
|
163
|
+
The full ID is returned in the response (e.g., 'kg0123456789abcdef_dev').
|
|
164
|
+
|
|
155
165
|
Args:
|
|
156
166
|
graph_id (str):
|
|
157
|
-
|
|
167
|
+
subgraph_name (str): Subgraph name (e.g., 'dev', 'staging')
|
|
158
168
|
|
|
159
169
|
Raises:
|
|
160
170
|
errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
|
|
@@ -166,14 +176,14 @@ def sync(
|
|
|
166
176
|
|
|
167
177
|
return sync_detailed(
|
|
168
178
|
graph_id=graph_id,
|
|
169
|
-
|
|
179
|
+
subgraph_name=subgraph_name,
|
|
170
180
|
client=client,
|
|
171
181
|
).parsed
|
|
172
182
|
|
|
173
183
|
|
|
174
184
|
async def asyncio_detailed(
|
|
175
185
|
graph_id: str,
|
|
176
|
-
|
|
186
|
+
subgraph_name: str,
|
|
177
187
|
*,
|
|
178
188
|
client: AuthenticatedClient,
|
|
179
189
|
) -> Response[Union[Any, HTTPValidationError, SubgraphResponse]]:
|
|
@@ -183,6 +193,7 @@ async def asyncio_detailed(
|
|
|
183
193
|
|
|
184
194
|
**Requirements:**
|
|
185
195
|
- User must have read access to parent graph
|
|
196
|
+
- Subgraph name must be alphanumeric (1-20 characters)
|
|
186
197
|
|
|
187
198
|
**Response includes:**
|
|
188
199
|
- Full subgraph metadata
|
|
@@ -199,9 +210,13 @@ async def asyncio_detailed(
|
|
|
199
210
|
- Database size on disk
|
|
200
211
|
- Schema information
|
|
201
212
|
|
|
213
|
+
**Note:**
|
|
214
|
+
Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID.
|
|
215
|
+
The full ID is returned in the response (e.g., 'kg0123456789abcdef_dev').
|
|
216
|
+
|
|
202
217
|
Args:
|
|
203
218
|
graph_id (str):
|
|
204
|
-
|
|
219
|
+
subgraph_name (str): Subgraph name (e.g., 'dev', 'staging')
|
|
205
220
|
|
|
206
221
|
Raises:
|
|
207
222
|
errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
|
|
@@ -213,7 +228,7 @@ async def asyncio_detailed(
|
|
|
213
228
|
|
|
214
229
|
kwargs = _get_kwargs(
|
|
215
230
|
graph_id=graph_id,
|
|
216
|
-
|
|
231
|
+
subgraph_name=subgraph_name,
|
|
217
232
|
)
|
|
218
233
|
|
|
219
234
|
response = await client.get_async_httpx_client().request(**kwargs)
|
|
@@ -223,7 +238,7 @@ async def asyncio_detailed(
|
|
|
223
238
|
|
|
224
239
|
async def asyncio(
|
|
225
240
|
graph_id: str,
|
|
226
|
-
|
|
241
|
+
subgraph_name: str,
|
|
227
242
|
*,
|
|
228
243
|
client: AuthenticatedClient,
|
|
229
244
|
) -> Optional[Union[Any, HTTPValidationError, SubgraphResponse]]:
|
|
@@ -233,6 +248,7 @@ async def asyncio(
|
|
|
233
248
|
|
|
234
249
|
**Requirements:**
|
|
235
250
|
- User must have read access to parent graph
|
|
251
|
+
- Subgraph name must be alphanumeric (1-20 characters)
|
|
236
252
|
|
|
237
253
|
**Response includes:**
|
|
238
254
|
- Full subgraph metadata
|
|
@@ -249,9 +265,13 @@ async def asyncio(
|
|
|
249
265
|
- Database size on disk
|
|
250
266
|
- Schema information
|
|
251
267
|
|
|
268
|
+
**Note:**
|
|
269
|
+
Use the subgraph name (e.g., 'dev', 'staging') not the full subgraph ID.
|
|
270
|
+
The full ID is returned in the response (e.g., 'kg0123456789abcdef_dev').
|
|
271
|
+
|
|
252
272
|
Args:
|
|
253
273
|
graph_id (str):
|
|
254
|
-
|
|
274
|
+
subgraph_name (str): Subgraph name (e.g., 'dev', 'staging')
|
|
255
275
|
|
|
256
276
|
Raises:
|
|
257
277
|
errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
|
|
@@ -264,7 +284,7 @@ async def asyncio(
|
|
|
264
284
|
return (
|
|
265
285
|
await asyncio_detailed(
|
|
266
286
|
graph_id=graph_id,
|
|
267
|
-
|
|
287
|
+
subgraph_name=subgraph_name,
|
|
268
288
|
client=client,
|
|
269
289
|
)
|
|
270
290
|
).parsed
|
|
@@ -123,6 +123,13 @@ def sync_detailed(
|
|
|
123
123
|
Tables are automatically created on first file upload with type inferred from name
|
|
124
124
|
(e.g., \"Transaction\" → relationship) and empty schema populated during ingestion.
|
|
125
125
|
|
|
126
|
+
**Subgraph Support:**
|
|
127
|
+
This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
128
|
+
- Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
129
|
+
- Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
130
|
+
Each subgraph has completely isolated S3 staging areas and tables. Files uploaded
|
|
131
|
+
to one subgraph do not appear in other subgraphs.
|
|
132
|
+
|
|
126
133
|
**Important Notes:**
|
|
127
134
|
- Presigned URLs expire (default: 1 hour)
|
|
128
135
|
- Use appropriate Content-Type header when uploading to S3
|
|
@@ -192,6 +199,13 @@ def sync(
|
|
|
192
199
|
Tables are automatically created on first file upload with type inferred from name
|
|
193
200
|
(e.g., \"Transaction\" → relationship) and empty schema populated during ingestion.
|
|
194
201
|
|
|
202
|
+
**Subgraph Support:**
|
|
203
|
+
This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
204
|
+
- Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
205
|
+
- Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
206
|
+
Each subgraph has completely isolated S3 staging areas and tables. Files uploaded
|
|
207
|
+
to one subgraph do not appear in other subgraphs.
|
|
208
|
+
|
|
195
209
|
**Important Notes:**
|
|
196
210
|
- Presigned URLs expire (default: 1 hour)
|
|
197
211
|
- Use appropriate Content-Type header when uploading to S3
|
|
@@ -256,6 +270,13 @@ async def asyncio_detailed(
|
|
|
256
270
|
Tables are automatically created on first file upload with type inferred from name
|
|
257
271
|
(e.g., \"Transaction\" → relationship) and empty schema populated during ingestion.
|
|
258
272
|
|
|
273
|
+
**Subgraph Support:**
|
|
274
|
+
This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
275
|
+
- Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
276
|
+
- Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
277
|
+
Each subgraph has completely isolated S3 staging areas and tables. Files uploaded
|
|
278
|
+
to one subgraph do not appear in other subgraphs.
|
|
279
|
+
|
|
259
280
|
**Important Notes:**
|
|
260
281
|
- Presigned URLs expire (default: 1 hour)
|
|
261
282
|
- Use appropriate Content-Type header when uploading to S3
|
|
@@ -323,6 +344,13 @@ async def asyncio(
|
|
|
323
344
|
Tables are automatically created on first file upload with type inferred from name
|
|
324
345
|
(e.g., \"Transaction\" → relationship) and empty schema populated during ingestion.
|
|
325
346
|
|
|
347
|
+
**Subgraph Support:**
|
|
348
|
+
This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
349
|
+
- Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
350
|
+
- Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
351
|
+
Each subgraph has completely isolated S3 staging areas and tables. Files uploaded
|
|
352
|
+
to one subgraph do not appear in other subgraphs.
|
|
353
|
+
|
|
326
354
|
**Important Notes:**
|
|
327
355
|
- Presigned URLs expire (default: 1 hour)
|
|
328
356
|
- Use appropriate Content-Type header when uploading to S3
|
|
@@ -110,7 +110,7 @@ def sync_detailed(
|
|
|
110
110
|
2. Files are validated and marked as 'uploaded'
|
|
111
111
|
3. Trigger ingestion: `POST /tables/ingest`
|
|
112
112
|
4. DuckDB staging tables created from S3 patterns
|
|
113
|
-
5. Data copied
|
|
113
|
+
5. Data copied from DuckDB to Kuzu
|
|
114
114
|
6. Per-table results and metrics returned
|
|
115
115
|
|
|
116
116
|
**Rebuild Feature:**
|
|
@@ -141,6 +141,13 @@ def sync_detailed(
|
|
|
141
141
|
you'll receive a 409 Conflict error. The distributed lock automatically expires after
|
|
142
142
|
the configured TTL (default: 1 hour) to prevent deadlocks from failed ingestions.
|
|
143
143
|
|
|
144
|
+
**Subgraph Support:**
|
|
145
|
+
This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
146
|
+
- Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
147
|
+
- Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
148
|
+
Each subgraph has independent staging tables and graph data. Ingestion operates
|
|
149
|
+
on the specified graph/subgraph only and does not affect other subgraphs.
|
|
150
|
+
|
|
144
151
|
**Important Notes:**
|
|
145
152
|
- Only files with 'uploaded' status are processed
|
|
146
153
|
- Tables with no uploaded files are skipped
|
|
@@ -198,7 +205,7 @@ def sync(
|
|
|
198
205
|
2. Files are validated and marked as 'uploaded'
|
|
199
206
|
3. Trigger ingestion: `POST /tables/ingest`
|
|
200
207
|
4. DuckDB staging tables created from S3 patterns
|
|
201
|
-
5. Data copied
|
|
208
|
+
5. Data copied from DuckDB to Kuzu
|
|
202
209
|
6. Per-table results and metrics returned
|
|
203
210
|
|
|
204
211
|
**Rebuild Feature:**
|
|
@@ -229,6 +236,13 @@ def sync(
|
|
|
229
236
|
you'll receive a 409 Conflict error. The distributed lock automatically expires after
|
|
230
237
|
the configured TTL (default: 1 hour) to prevent deadlocks from failed ingestions.
|
|
231
238
|
|
|
239
|
+
**Subgraph Support:**
|
|
240
|
+
This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
241
|
+
- Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
242
|
+
- Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
243
|
+
Each subgraph has independent staging tables and graph data. Ingestion operates
|
|
244
|
+
on the specified graph/subgraph only and does not affect other subgraphs.
|
|
245
|
+
|
|
232
246
|
**Important Notes:**
|
|
233
247
|
- Only files with 'uploaded' status are processed
|
|
234
248
|
- Tables with no uploaded files are skipped
|
|
@@ -281,7 +295,7 @@ async def asyncio_detailed(
|
|
|
281
295
|
2. Files are validated and marked as 'uploaded'
|
|
282
296
|
3. Trigger ingestion: `POST /tables/ingest`
|
|
283
297
|
4. DuckDB staging tables created from S3 patterns
|
|
284
|
-
5. Data copied
|
|
298
|
+
5. Data copied from DuckDB to Kuzu
|
|
285
299
|
6. Per-table results and metrics returned
|
|
286
300
|
|
|
287
301
|
**Rebuild Feature:**
|
|
@@ -312,6 +326,13 @@ async def asyncio_detailed(
|
|
|
312
326
|
you'll receive a 409 Conflict error. The distributed lock automatically expires after
|
|
313
327
|
the configured TTL (default: 1 hour) to prevent deadlocks from failed ingestions.
|
|
314
328
|
|
|
329
|
+
**Subgraph Support:**
|
|
330
|
+
This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
331
|
+
- Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
332
|
+
- Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
333
|
+
Each subgraph has independent staging tables and graph data. Ingestion operates
|
|
334
|
+
on the specified graph/subgraph only and does not affect other subgraphs.
|
|
335
|
+
|
|
315
336
|
**Important Notes:**
|
|
316
337
|
- Only files with 'uploaded' status are processed
|
|
317
338
|
- Tables with no uploaded files are skipped
|
|
@@ -367,7 +388,7 @@ async def asyncio(
|
|
|
367
388
|
2. Files are validated and marked as 'uploaded'
|
|
368
389
|
3. Trigger ingestion: `POST /tables/ingest`
|
|
369
390
|
4. DuckDB staging tables created from S3 patterns
|
|
370
|
-
5. Data copied
|
|
391
|
+
5. Data copied from DuckDB to Kuzu
|
|
371
392
|
6. Per-table results and metrics returned
|
|
372
393
|
|
|
373
394
|
**Rebuild Feature:**
|
|
@@ -398,6 +419,13 @@ async def asyncio(
|
|
|
398
419
|
you'll receive a 409 Conflict error. The distributed lock automatically expires after
|
|
399
420
|
the configured TTL (default: 1 hour) to prevent deadlocks from failed ingestions.
|
|
400
421
|
|
|
422
|
+
**Subgraph Support:**
|
|
423
|
+
This endpoint accepts both parent graph IDs and subgraph IDs.
|
|
424
|
+
- Parent graph: Use `graph_id` like `kg0123456789abcdef`
|
|
425
|
+
- Subgraph: Use full subgraph ID like `kg0123456789abcdef_dev`
|
|
426
|
+
Each subgraph has independent staging tables and graph data. Ingestion operates
|
|
427
|
+
on the specified graph/subgraph only and does not affect other subgraphs.
|
|
428
|
+
|
|
401
429
|
**Important Notes:**
|
|
402
430
|
- Only files with 'uploaded' status are processed
|
|
403
431
|
- Tables with no uploaded files are skipped
|