robosystems-client 0.2.2__py3-none-any.whl → 0.2.3__py3-none-any.whl

robosystems_client/api/tables/ingest_tables.py

@@ -0,0 +1,616 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.bulk_ingest_request import BulkIngestRequest
+from ...models.bulk_ingest_response import BulkIngestResponse
+from ...models.error_response import ErrorResponse
+from ...models.http_validation_error import HTTPValidationError
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+  graph_id: str,
+  *,
+  body: BulkIngestRequest,
+  token: Union[None, Unset, str] = UNSET,
+  authorization: Union[None, Unset, str] = UNSET,
+) -> dict[str, Any]:
+  headers: dict[str, Any] = {}
+  if not isinstance(authorization, Unset):
+    headers["authorization"] = authorization
+
+  params: dict[str, Any] = {}
+
+  json_token: Union[None, Unset, str]
+  if isinstance(token, Unset):
+    json_token = UNSET
+  else:
+    json_token = token
+  params["token"] = json_token
+
+  params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+  _kwargs: dict[str, Any] = {
+    "method": "post",
+    "url": f"/v1/graphs/{graph_id}/tables/ingest",
+    "params": params,
+  }
+
+  _kwargs["json"] = body.to_dict()
+
+  headers["Content-Type"] = "application/json"
+
+  _kwargs["headers"] = headers
+  return _kwargs
+
+
+def _parse_response(
+  *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[Any, BulkIngestResponse, ErrorResponse, HTTPValidationError]]:
+  if response.status_code == 200:
+    response_200 = BulkIngestResponse.from_dict(response.json())
+
+    return response_200
+
+  if response.status_code == 401:
+    response_401 = cast(Any, None)
+    return response_401
+
+  if response.status_code == 403:
+    response_403 = ErrorResponse.from_dict(response.json())
+
+    return response_403
+
+  if response.status_code == 404:
+    response_404 = ErrorResponse.from_dict(response.json())
+
+    return response_404
+
+  if response.status_code == 409:
+    response_409 = ErrorResponse.from_dict(response.json())
+
+    return response_409
+
+  if response.status_code == 422:
+    response_422 = HTTPValidationError.from_dict(response.json())
+
+    return response_422
+
+  if response.status_code == 500:
+    response_500 = ErrorResponse.from_dict(response.json())
+
+    return response_500
+
+  if client.raise_on_unexpected_status:
+    raise errors.UnexpectedStatus(response.status_code, response.content)
+  else:
+    return None
+
+
+def _build_response(
+  *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[Any, BulkIngestResponse, ErrorResponse, HTTPValidationError]]:
+  return Response(
+    status_code=HTTPStatus(response.status_code),
+    content=response.content,
+    headers=response.headers,
+    parsed=_parse_response(client=client, response=response),
+  )
+
+
+def sync_detailed(
+  graph_id: str,
+  *,
+  client: AuthenticatedClient,
+  body: BulkIngestRequest,
+  token: Union[None, Unset, str] = UNSET,
+  authorization: Union[None, Unset, str] = UNSET,
+) -> Response[Union[Any, BulkIngestResponse, ErrorResponse, HTTPValidationError]]:
+  r""" Ingest Tables to Graph
+
+     Load all files from S3 into DuckDB staging tables and ingest into Kuzu graph database.
+
+    **Purpose:**
+    Orchestrates the complete data pipeline from S3 staging files into the Kuzu graph database.
+    Processes all tables in a single bulk operation with comprehensive error handling and metrics.
+
+    **Use Cases:**
+    - Initial graph population from uploaded data
+    - Incremental data updates with new files
+    - Complete database rebuild from source files
+    - Recovery from failed ingestion attempts
+
+    **Workflow:**
+    1. Upload data files via `POST /tables/{table_name}/files`
+    2. Files are validated and marked as 'uploaded'
+    3. Trigger ingestion: `POST /tables/ingest`
+    4. DuckDB staging tables created from S3 patterns
+    5. Data copied row-by-row from DuckDB to Kuzu
+    6. Per-table results and metrics returned
+
+    **Rebuild Feature:**
+    Setting `rebuild=true` regenerates the entire graph database from scratch:
+    - Deletes existing Kuzu database
+    - Recreates with fresh schema from active GraphSchema
+    - Ingests all data files
+    - Safe operation - S3 is source of truth
+    - Useful for schema changes or data corrections
+    - Graph marked as 'rebuilding' during process
+
+    **Error Handling:**
+    - Per-table error isolation with `ignore_errors` flag
+    - Partial success support (some tables succeed, some fail)
+    - Detailed error reporting per table
+    - Graph status tracking throughout process
+    - Automatic failure recovery and cleanup
+
+    **Performance:**
+    - Processes all tables in sequence
+    - Each table timed independently
+    - Total execution metrics provided
+    - Scales to thousands of files
+    - Optimized for large datasets
+
+    **Example Request:**
+    ```bash
+    curl -X POST \"https://api.robosystems.ai/v1/graphs/kg123/tables/ingest\" \
+      -H \"Authorization: Bearer YOUR_TOKEN\" \
+      -H \"Content-Type: application/json\" \
+      -d '{
+        \"ignore_errors\": true,
+        \"rebuild\": false
+      }'
+    ```
+
+    **Example Response:**
+    ```json
+    {
+      \"status\": \"success\",
+      \"graph_id\": \"kg123\",
+      \"total_tables\": 5,
+      \"successful_tables\": 5,
+      \"failed_tables\": 0,
+      \"skipped_tables\": 0,
+      \"total_rows_ingested\": 25000,
+      \"total_execution_time_ms\": 15420.5,
+      \"results\": [
+        {
+          \"table_name\": \"Entity\",
+          \"status\": \"success\",
+          \"rows_ingested\": 5000,
+          \"execution_time_ms\": 3200.1,
+          \"error\": null
+        }
+      ]
+    }
+    ```
+
+    **Concurrency Control:**
+    Only one ingestion can run per graph at a time. If another ingestion is in progress,
+    you'll receive a 409 Conflict error. The distributed lock automatically expires after
+    the configured TTL (default: 1 hour) to prevent deadlocks from failed ingestions.
+
+    **Tips:**
+    - Only files with 'uploaded' status are processed
+    - Tables with no uploaded files are skipped
+    - Use `ignore_errors=false` for strict validation
+    - Monitor progress via per-table results
+    - Check graph metadata for rebuild status
+    - Wait for current ingestion to complete before starting another
+
+    **Note:**
+    Table ingestion is included - no credit consumption.
+
+    Args:
+        graph_id (str): Graph database identifier
+        token (Union[None, Unset, str]): JWT token for SSE authentication
+        authorization (Union[None, Unset, str]):
+        body (BulkIngestRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[Any, BulkIngestResponse, ErrorResponse, HTTPValidationError]]
+     """
+
+  kwargs = _get_kwargs(
+    graph_id=graph_id,
+    body=body,
+    token=token,
+    authorization=authorization,
+  )
+
+  response = client.get_httpx_client().request(
+    **kwargs,
+  )
+
+  return _build_response(client=client, response=response)
+
+
+def sync(
+  graph_id: str,
+  *,
+  client: AuthenticatedClient,
+  body: BulkIngestRequest,
+  token: Union[None, Unset, str] = UNSET,
+  authorization: Union[None, Unset, str] = UNSET,
+) -> Optional[Union[Any, BulkIngestResponse, ErrorResponse, HTTPValidationError]]:
+  r""" Ingest Tables to Graph
+
+     Load all files from S3 into DuckDB staging tables and ingest into Kuzu graph database.
+
+    **Purpose:**
+    Orchestrates the complete data pipeline from S3 staging files into the Kuzu graph database.
+    Processes all tables in a single bulk operation with comprehensive error handling and metrics.
+
+    **Use Cases:**
+    - Initial graph population from uploaded data
+    - Incremental data updates with new files
+    - Complete database rebuild from source files
+    - Recovery from failed ingestion attempts
+
+    **Workflow:**
+    1. Upload data files via `POST /tables/{table_name}/files`
+    2. Files are validated and marked as 'uploaded'
+    3. Trigger ingestion: `POST /tables/ingest`
+    4. DuckDB staging tables created from S3 patterns
+    5. Data copied row-by-row from DuckDB to Kuzu
+    6. Per-table results and metrics returned
+
+    **Rebuild Feature:**
+    Setting `rebuild=true` regenerates the entire graph database from scratch:
+    - Deletes existing Kuzu database
+    - Recreates with fresh schema from active GraphSchema
+    - Ingests all data files
+    - Safe operation - S3 is source of truth
+    - Useful for schema changes or data corrections
+    - Graph marked as 'rebuilding' during process
+
+    **Error Handling:**
+    - Per-table error isolation with `ignore_errors` flag
+    - Partial success support (some tables succeed, some fail)
+    - Detailed error reporting per table
+    - Graph status tracking throughout process
+    - Automatic failure recovery and cleanup
+
+    **Performance:**
+    - Processes all tables in sequence
+    - Each table timed independently
+    - Total execution metrics provided
+    - Scales to thousands of files
+    - Optimized for large datasets
+
+    **Example Request:**
+    ```bash
+    curl -X POST \"https://api.robosystems.ai/v1/graphs/kg123/tables/ingest\" \
+      -H \"Authorization: Bearer YOUR_TOKEN\" \
+      -H \"Content-Type: application/json\" \
+      -d '{
+        \"ignore_errors\": true,
+        \"rebuild\": false
+      }'
+    ```
+
+    **Example Response:**
+    ```json
+    {
+      \"status\": \"success\",
+      \"graph_id\": \"kg123\",
+      \"total_tables\": 5,
+      \"successful_tables\": 5,
+      \"failed_tables\": 0,
+      \"skipped_tables\": 0,
+      \"total_rows_ingested\": 25000,
+      \"total_execution_time_ms\": 15420.5,
+      \"results\": [
+        {
+          \"table_name\": \"Entity\",
+          \"status\": \"success\",
+          \"rows_ingested\": 5000,
+          \"execution_time_ms\": 3200.1,
+          \"error\": null
+        }
+      ]
+    }
+    ```
+
+    **Concurrency Control:**
+    Only one ingestion can run per graph at a time. If another ingestion is in progress,
+    you'll receive a 409 Conflict error. The distributed lock automatically expires after
+    the configured TTL (default: 1 hour) to prevent deadlocks from failed ingestions.
+
+    **Tips:**
+    - Only files with 'uploaded' status are processed
+    - Tables with no uploaded files are skipped
+    - Use `ignore_errors=false` for strict validation
+    - Monitor progress via per-table results
+    - Check graph metadata for rebuild status
+    - Wait for current ingestion to complete before starting another
+
+    **Note:**
+    Table ingestion is included - no credit consumption.
+
+    Args:
+        graph_id (str): Graph database identifier
+        token (Union[None, Unset, str]): JWT token for SSE authentication
+        authorization (Union[None, Unset, str]):
+        body (BulkIngestRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[Any, BulkIngestResponse, ErrorResponse, HTTPValidationError]
+     """
+
+  return sync_detailed(
+    graph_id=graph_id,
+    client=client,
+    body=body,
+    token=token,
+    authorization=authorization,
+  ).parsed
+
+
+async def asyncio_detailed(
+  graph_id: str,
+  *,
+  client: AuthenticatedClient,
+  body: BulkIngestRequest,
+  token: Union[None, Unset, str] = UNSET,
+  authorization: Union[None, Unset, str] = UNSET,
+) -> Response[Union[Any, BulkIngestResponse, ErrorResponse, HTTPValidationError]]:
+  r""" Ingest Tables to Graph
+
+     Load all files from S3 into DuckDB staging tables and ingest into Kuzu graph database.
+
+    **Purpose:**
+    Orchestrates the complete data pipeline from S3 staging files into the Kuzu graph database.
+    Processes all tables in a single bulk operation with comprehensive error handling and metrics.
+
+    **Use Cases:**
+    - Initial graph population from uploaded data
+    - Incremental data updates with new files
+    - Complete database rebuild from source files
+    - Recovery from failed ingestion attempts
+
+    **Workflow:**
+    1. Upload data files via `POST /tables/{table_name}/files`
+    2. Files are validated and marked as 'uploaded'
+    3. Trigger ingestion: `POST /tables/ingest`
+    4. DuckDB staging tables created from S3 patterns
+    5. Data copied row-by-row from DuckDB to Kuzu
+    6. Per-table results and metrics returned
+
+    **Rebuild Feature:**
+    Setting `rebuild=true` regenerates the entire graph database from scratch:
+    - Deletes existing Kuzu database
+    - Recreates with fresh schema from active GraphSchema
+    - Ingests all data files
+    - Safe operation - S3 is source of truth
+    - Useful for schema changes or data corrections
+    - Graph marked as 'rebuilding' during process
+
+    **Error Handling:**
+    - Per-table error isolation with `ignore_errors` flag
+    - Partial success support (some tables succeed, some fail)
+    - Detailed error reporting per table
+    - Graph status tracking throughout process
+    - Automatic failure recovery and cleanup
+
+    **Performance:**
+    - Processes all tables in sequence
+    - Each table timed independently
+    - Total execution metrics provided
+    - Scales to thousands of files
+    - Optimized for large datasets
+
+    **Example Request:**
+    ```bash
+    curl -X POST \"https://api.robosystems.ai/v1/graphs/kg123/tables/ingest\" \
+      -H \"Authorization: Bearer YOUR_TOKEN\" \
+      -H \"Content-Type: application/json\" \
+      -d '{
+        \"ignore_errors\": true,
+        \"rebuild\": false
+      }'
+    ```
+
+    **Example Response:**
+    ```json
+    {
+      \"status\": \"success\",
+      \"graph_id\": \"kg123\",
+      \"total_tables\": 5,
+      \"successful_tables\": 5,
+      \"failed_tables\": 0,
+      \"skipped_tables\": 0,
+      \"total_rows_ingested\": 25000,
+      \"total_execution_time_ms\": 15420.5,
+      \"results\": [
+        {
+          \"table_name\": \"Entity\",
+          \"status\": \"success\",
+          \"rows_ingested\": 5000,
+          \"execution_time_ms\": 3200.1,
+          \"error\": null
+        }
+      ]
+    }
+    ```
+
+    **Concurrency Control:**
+    Only one ingestion can run per graph at a time. If another ingestion is in progress,
+    you'll receive a 409 Conflict error. The distributed lock automatically expires after
+    the configured TTL (default: 1 hour) to prevent deadlocks from failed ingestions.
+
+    **Tips:**
+    - Only files with 'uploaded' status are processed
+    - Tables with no uploaded files are skipped
+    - Use `ignore_errors=false` for strict validation
+    - Monitor progress via per-table results
+    - Check graph metadata for rebuild status
+    - Wait for current ingestion to complete before starting another
+
+    **Note:**
+    Table ingestion is included - no credit consumption.
+
+    Args:
+        graph_id (str): Graph database identifier
+        token (Union[None, Unset, str]): JWT token for SSE authentication
+        authorization (Union[None, Unset, str]):
+        body (BulkIngestRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[Any, BulkIngestResponse, ErrorResponse, HTTPValidationError]]
+     """
+
+  kwargs = _get_kwargs(
+    graph_id=graph_id,
+    body=body,
+    token=token,
+    authorization=authorization,
+  )
+
+  response = await client.get_async_httpx_client().request(**kwargs)
+
+  return _build_response(client=client, response=response)
+
+
+async def asyncio(
+  graph_id: str,
+  *,
+  client: AuthenticatedClient,
+  body: BulkIngestRequest,
+  token: Union[None, Unset, str] = UNSET,
+  authorization: Union[None, Unset, str] = UNSET,
+) -> Optional[Union[Any, BulkIngestResponse, ErrorResponse, HTTPValidationError]]:
+  r""" Ingest Tables to Graph
+
+     Load all files from S3 into DuckDB staging tables and ingest into Kuzu graph database.
+
+    **Purpose:**
+    Orchestrates the complete data pipeline from S3 staging files into the Kuzu graph database.
+    Processes all tables in a single bulk operation with comprehensive error handling and metrics.
+
+    **Use Cases:**
+    - Initial graph population from uploaded data
+    - Incremental data updates with new files
+    - Complete database rebuild from source files
+    - Recovery from failed ingestion attempts
+
+    **Workflow:**
+    1. Upload data files via `POST /tables/{table_name}/files`
+    2. Files are validated and marked as 'uploaded'
+    3. Trigger ingestion: `POST /tables/ingest`
+    4. DuckDB staging tables created from S3 patterns
+    5. Data copied row-by-row from DuckDB to Kuzu
+    6. Per-table results and metrics returned
+
+    **Rebuild Feature:**
+    Setting `rebuild=true` regenerates the entire graph database from scratch:
+    - Deletes existing Kuzu database
+    - Recreates with fresh schema from active GraphSchema
+    - Ingests all data files
+    - Safe operation - S3 is source of truth
+    - Useful for schema changes or data corrections
+    - Graph marked as 'rebuilding' during process
+
+    **Error Handling:**
+    - Per-table error isolation with `ignore_errors` flag
+    - Partial success support (some tables succeed, some fail)
+    - Detailed error reporting per table
+    - Graph status tracking throughout process
+    - Automatic failure recovery and cleanup
+
+    **Performance:**
+    - Processes all tables in sequence
+    - Each table timed independently
+    - Total execution metrics provided
+    - Scales to thousands of files
+    - Optimized for large datasets
+
+    **Example Request:**
+    ```bash
+    curl -X POST \"https://api.robosystems.ai/v1/graphs/kg123/tables/ingest\" \
+      -H \"Authorization: Bearer YOUR_TOKEN\" \
+      -H \"Content-Type: application/json\" \
+      -d '{
+        \"ignore_errors\": true,
+        \"rebuild\": false
+      }'
+    ```
+
+    **Example Response:**
+    ```json
+    {
+      \"status\": \"success\",
+      \"graph_id\": \"kg123\",
+      \"total_tables\": 5,
+      \"successful_tables\": 5,
+      \"failed_tables\": 0,
+      \"skipped_tables\": 0,
+      \"total_rows_ingested\": 25000,
+      \"total_execution_time_ms\": 15420.5,
+      \"results\": [
+        {
+          \"table_name\": \"Entity\",
+          \"status\": \"success\",
+          \"rows_ingested\": 5000,
+          \"execution_time_ms\": 3200.1,
+          \"error\": null
+        }
+      ]
+    }
+    ```
+
+    **Concurrency Control:**
+    Only one ingestion can run per graph at a time. If another ingestion is in progress,
+    you'll receive a 409 Conflict error. The distributed lock automatically expires after
+    the configured TTL (default: 1 hour) to prevent deadlocks from failed ingestions.
+
+    **Tips:**
+    - Only files with 'uploaded' status are processed
+    - Tables with no uploaded files are skipped
+    - Use `ignore_errors=false` for strict validation
+    - Monitor progress via per-table results
+    - Check graph metadata for rebuild status
+    - Wait for current ingestion to complete before starting another
+
+    **Note:**
+    Table ingestion is included - no credit consumption.
+
+    Args:
+        graph_id (str): Graph database identifier
+        token (Union[None, Unset, str]): JWT token for SSE authentication
+        authorization (Union[None, Unset, str]):
+        body (BulkIngestRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[Any, BulkIngestResponse, ErrorResponse, HTTPValidationError]
+     """
+
+  return (
+    await asyncio_detailed(
+      graph_id=graph_id,
+      client=client,
+      body=body,
+      token=token,
+      authorization=authorization,
+    )
+  ).parsed