hotdata 0.1.0__tar.gz → 0.2.0__tar.gz

{hotdata-0.1.0 → hotdata-0.2.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: hotdata
-Version: 0.1.0
-Summary: Official Python client for the Hotdata API
+Version: 0.2.0
+Summary: Hotdata API
 Author-email: Hotdata <developers@hotdata.dev>
 License: MIT
 Project-URL: Homepage, https://www.hotdata.dev
@@ -13,6 +13,8 @@ Requires-Dist: urllib3<3.0.0,>=2.1.0
 Requires-Dist: python-dateutil>=2.8.2
 Requires-Dist: pydantic>=2
 Requires-Dist: typing-extensions>=4.7.1
+Provides-Extra: arrow
+Requires-Dist: pyarrow>=14; extra == "arrow"
 
 # hotdata
 
@@ -76,6 +78,35 @@ with hotdata.ApiClient(configuration) as api_client:
 
 Each `Api` class groups endpoints by resource. Construct the client, then call the typed methods you need.
 
+## Arrow results
+
+Query results can be fetched as an [Apache Arrow](https://arrow.apache.org/) IPC stream instead of JSON, which is faster and far more memory-efficient for large result sets. Install the optional extra:
+
+```sh
+pip install 'hotdata[arrow]'
+```
+
+Use `hotdata.arrow.ResultsApi` (a drop-in subclass of `ResultsApi` that adds Arrow methods):
+
+```python
+from hotdata import ApiClient, Configuration
+from hotdata.arrow import ResultsApi
+
+with ApiClient(Configuration(api_key="...", workspace_id="...")) as client:
+    results = ResultsApi(client)
+
+    # Buffered: returns a pyarrow.Table.
+    table = results.get_result_arrow(result_id)
+
+    # Streaming: yields a pyarrow.RecordBatchStreamReader without
+    # materializing the full table in memory.
+    with results.stream_result_arrow(result_id) as reader:
+        for batch in reader:
+            ...
+```
+
+Both methods accept `offset` and `limit` for pagination. They raise `hotdata.arrow.ResultNotReadyError` if the result is still pending or processing — poll `results.get_result(result_id)` until `status == "ready"` first.
+
 ## API reference
 
 Generated Markdown for every operation and model is in [`docs/`](https://github.com/hotdata-dev/sdk-python/tree/main/docs):

{hotdata-0.1.0 → hotdata-0.2.0}/README.md

@@ -60,6 +60,35 @@ with hotdata.ApiClient(configuration) as api_client:
 
 Each `Api` class groups endpoints by resource. Construct the client, then call the typed methods you need.
 
+## Arrow results
+
+Query results can be fetched as an [Apache Arrow](https://arrow.apache.org/) IPC stream instead of JSON, which is faster and far more memory-efficient for large result sets. Install the optional extra:
+
+```sh
+pip install 'hotdata[arrow]'
+```
+
+Use `hotdata.arrow.ResultsApi` (a drop-in subclass of `ResultsApi` that adds Arrow methods):
+
+```python
+from hotdata import ApiClient, Configuration
+from hotdata.arrow import ResultsApi
+
+with ApiClient(Configuration(api_key="...", workspace_id="...")) as client:
+    results = ResultsApi(client)
+
+    # Buffered: returns a pyarrow.Table.
+    table = results.get_result_arrow(result_id)
+
+    # Streaming: yields a pyarrow.RecordBatchStreamReader without
+    # materializing the full table in memory.
+    with results.stream_result_arrow(result_id) as reader:
+        for batch in reader:
+            ...
+```
+
+Both methods accept `offset` and `limit` for pagination. They raise `hotdata.arrow.ResultNotReadyError` if the result is still pending or processing — poll `results.get_result(result_id)` until `status == "ready"` first.
+
 ## API reference
 
 Generated Markdown for every operation and model is in [`docs/`](https://github.com/hotdata-dev/sdk-python/tree/main/docs):

{hotdata-0.1.0 → hotdata-0.2.0}/hotdata/__init__.py

@@ -85,6 +85,11 @@ __all__ = [
     "CreateWorkspaceRequest",
     "CreateWorkspaceResponse",
     "DatasetSource",
+    "DatasetSourceOneOf",
+    "DatasetSourceOneOf1",
+    "DatasetSourceOneOf2",
+    "DatasetSourceOneOf3",
+    "DatasetSourceOneOf4",
     "DatasetSummary",
     "DatasetVersionSummary",
     "DeleteSandboxResponse",
@@ -122,6 +127,8 @@ __all__ = [
     "ListUploadsResponse",
     "ListWorkspaceContextsResponse",
     "ListWorkspacesResponse",
+    "LoadManagedTableRequest",
+    "LoadManagedTableResponse",
     "NumericProfileDetail",
     "QueryRequest",
     "QueryResponse",
@@ -131,6 +138,7 @@ __all__ = [
     "RefreshResponse",
     "RefreshWarning",
     "ResultInfo",
+    "ResultsFormatQuery",
     "Sandbox",
     "SandboxResponse",
     "SavedQueryDatasetSource",
@@ -232,6 +240,11 @@ from hotdata.models.create_secret_response import CreateSecretResponse as Create
 from hotdata.models.create_workspace_request import CreateWorkspaceRequest as CreateWorkspaceRequest
 from hotdata.models.create_workspace_response import CreateWorkspaceResponse as CreateWorkspaceResponse
 from hotdata.models.dataset_source import DatasetSource as DatasetSource
+from hotdata.models.dataset_source_one_of import DatasetSourceOneOf as DatasetSourceOneOf
+from hotdata.models.dataset_source_one_of1 import DatasetSourceOneOf1 as DatasetSourceOneOf1
+from hotdata.models.dataset_source_one_of2 import DatasetSourceOneOf2 as DatasetSourceOneOf2
+from hotdata.models.dataset_source_one_of3 import DatasetSourceOneOf3 as DatasetSourceOneOf3
+from hotdata.models.dataset_source_one_of4 import DatasetSourceOneOf4 as DatasetSourceOneOf4
 from hotdata.models.dataset_summary import DatasetSummary as DatasetSummary
 from hotdata.models.dataset_version_summary import DatasetVersionSummary as DatasetVersionSummary
 from hotdata.models.delete_sandbox_response import DeleteSandboxResponse as DeleteSandboxResponse
@@ -269,6 +282,8 @@ from hotdata.models.list_secrets_response import ListSecretsResponse as ListSecr
 from hotdata.models.list_uploads_response import ListUploadsResponse as ListUploadsResponse
 from hotdata.models.list_workspace_contexts_response import ListWorkspaceContextsResponse as ListWorkspaceContextsResponse
 from hotdata.models.list_workspaces_response import ListWorkspacesResponse as ListWorkspacesResponse
+from hotdata.models.load_managed_table_request import LoadManagedTableRequest as LoadManagedTableRequest
+from hotdata.models.load_managed_table_response import LoadManagedTableResponse as LoadManagedTableResponse
 from hotdata.models.numeric_profile_detail import NumericProfileDetail as NumericProfileDetail
 from hotdata.models.query_request import QueryRequest as QueryRequest
 from hotdata.models.query_response import QueryResponse as QueryResponse
@@ -278,6 +293,7 @@ from hotdata.models.refresh_request import RefreshRequest as RefreshRequest
 from hotdata.models.refresh_response import RefreshResponse as RefreshResponse
 from hotdata.models.refresh_warning import RefreshWarning as RefreshWarning
 from hotdata.models.result_info import ResultInfo as ResultInfo
+from hotdata.models.results_format_query import ResultsFormatQuery as ResultsFormatQuery
 from hotdata.models.sandbox import Sandbox as Sandbox
 from hotdata.models.sandbox_response import SandboxResponse as SandboxResponse
 from hotdata.models.saved_query_dataset_source import SavedQueryDatasetSource as SavedQueryDatasetSource