collections_tables_create_export¶
Request a download of a table in a specified format
Functions
- async pydelfini.delfini_core.api.tables.collections_tables_create_export.asyncio(collection_id, version_id, table_name, *, client, body)[source]¶
Request a download of a table in a specified format
Starts a background job that writes the table in the requested format and stores the result. Use this instead of the synchronous format/{export_format} endpoint for large tables, whose export can take longer than a request is allowed to run. A request that matches an export already built, or already being built, joins that one instead of doing the work twice.
When the requester is a signed-in user, a note with the download link is delivered to their inbox once the export is ready.
Responds 202 when a new build was queued, with a Location header addressing the status resource to poll. Responds 200 when an existing export was reused.
- Parameters:
collection_id (str)
version_id (str)
table_name (str)
body (ItemExportRequest) – Asks for a table to be written in a download format.
client (AuthenticatedClient)
- Raises:
errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.
httpx.TimeoutException – If the request takes longer than Client.timeout.
- Returns:
Union[ItemExport]
- Return type:
- async pydelfini.delfini_core.api.tables.collections_tables_create_export.asyncio_detailed(collection_id, version_id, table_name, *, client, body)[source]¶
Request a download of a table in a specified format
Starts a background job that writes the table in the requested format and stores the result. Use this instead of the synchronous format/{export_format} endpoint for large tables, whose export can take longer than a request is allowed to run. A request that matches an export already built, or already being built, joins that one instead of doing the work twice.
When the requester is a signed-in user, a note with the download link is delivered to their inbox once the export is ready.
Responds 202 when a new build was queued, with a Location header addressing the status resource to poll. Responds 200 when an existing export was reused.
- Parameters:
collection_id (str)
version_id (str)
table_name (str)
body (ItemExportRequest) – Asks for a table to be written in a download format.
client (AuthenticatedClient)
- 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[ItemExport, ServerError]]
- Return type:
- pydelfini.delfini_core.api.tables.collections_tables_create_export.sync(collection_id, version_id, table_name, *, client, body)[source]¶
Request a download of a table in a specified format
Starts a background job that writes the table in the requested format and stores the result. Use this instead of the synchronous format/{export_format} endpoint for large tables, whose export can take longer than a request is allowed to run. A request that matches an export already built, or already being built, joins that one instead of doing the work twice.
When the requester is a signed-in user, a note with the download link is delivered to their inbox once the export is ready.
Responds 202 when a new build was queued, with a Location header addressing the status resource to poll. Responds 200 when an existing export was reused.
- Parameters:
collection_id (str)
version_id (str)
table_name (str)
body (ItemExportRequest) – Asks for a table to be written in a download format.
client (AuthenticatedClient)
- Raises:
errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.
httpx.TimeoutException – If the request takes longer than Client.timeout.
- Returns:
Union[ItemExport]
- Return type:
- pydelfini.delfini_core.api.tables.collections_tables_create_export.sync_detailed(collection_id, version_id, table_name, *, client, body)[source]¶
Request a download of a table in a specified format
Starts a background job that writes the table in the requested format and stores the result. Use this instead of the synchronous format/{export_format} endpoint for large tables, whose export can take longer than a request is allowed to run. A request that matches an export already built, or already being built, joins that one instead of doing the work twice.
When the requester is a signed-in user, a note with the download link is delivered to their inbox once the export is ready.
Responds 202 when a new build was queued, with a Location header addressing the status resource to poll. Responds 200 when an existing export was reused.
- Parameters:
collection_id (str)
version_id (str)
table_name (str)
body (ItemExportRequest) – Asks for a table to be written in a download format.
client (AuthenticatedClient)
- 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[ItemExport, ServerError]]
- Return type: