From 84ebdbfe5204c9ec9d075ed59f00c31fcab7b1b6 Mon Sep 17 00:00:00 2001 From: svc-excavator-bot Date: Mon, 11 May 2026 22:47:08 +0000 Subject: [PATCH] Excavator: Upgrade API Version --- README.md | 6 ++++ docs-snippets-npm/package.json | 2 +- docs-snippets-npm/src/index.ts | 2 +- docs/v2/Filesystem/models/TrashStatus.md | 6 +++- docs/v2/Ontologies/CipherTextProperty.md | 2 +- docs/v2/SqlQueries/SqlQuery.md | 11 ++++++-- .../models/ExecuteSqlQueryRequest.md | 1 + .../SqlQueries/models/SerializationFormat.md | 12 ++++++++ foundry_sdk/__init__.py | 2 ++ .../_core/context_and_environment_vars.py | 5 ++++ foundry_sdk/_core/http_client.py | 9 +++++- foundry_sdk/_version.py | 2 +- foundry_sdk/v1/ontologies/errors.py | 28 +++++++++++++++++++ foundry_sdk/v2/cli.py | 13 +++++++-- foundry_sdk/v2/filesystem/models.py | 7 ++++- foundry_sdk/v2/ontologies/errors.py | 28 +++++++++++++++++++ foundry_sdk/v2/sql_queries/errors.py | 14 ++++++++++ foundry_sdk/v2/sql_queries/models.py | 8 ++++++ foundry_sdk/v2/sql_queries/sql_query.py | 20 ++++++++++--- 19 files changed, 162 insertions(+), 16 deletions(-) create mode 100644 docs/v2/SqlQueries/models/SerializationFormat.md diff --git a/README.md b/README.md index fe17c9a4d..d04865f85 100644 --- a/README.md +++ b/README.md @@ -2960,6 +2960,7 @@ Namespace | Name | Import | **SqlQueries** | [ParameterValue](docs/v2/SqlQueries/models/ParameterValue.md) | `from foundry_sdk.v2.sql_queries.models import ParameterValue` | **SqlQueries** | [QueryStatus](docs/v2/SqlQueries/models/QueryStatus.md) | `from foundry_sdk.v2.sql_queries.models import QueryStatus` | **SqlQueries** | [RunningQueryStatus](docs/v2/SqlQueries/models/RunningQueryStatus.md) | `from foundry_sdk.v2.sql_queries.models import RunningQueryStatus` | +**SqlQueries** | [SerializationFormat](docs/v2/SqlQueries/models/SerializationFormat.md) | `from foundry_sdk.v2.sql_queries.models import SerializationFormat` | **SqlQueries** | [SqlQueryId](docs/v2/SqlQueries/models/SqlQueryId.md) | `from foundry_sdk.v2.sql_queries.models import SqlQueryId` | **SqlQueries** | [StructColumnFieldType](docs/v2/SqlQueries/models/StructColumnFieldType.md) | `from foundry_sdk.v2.sql_queries.models import StructColumnFieldType` | **SqlQueries** | [StructColumnType](docs/v2/SqlQueries/models/StructColumnType.md) | `from foundry_sdk.v2.sql_queries.models import StructColumnType` | @@ -3738,6 +3739,7 @@ Namespace | Name | Import | **Models** | UnsupportedModelSource | `from foundry_sdk.v2.models.errors import UnsupportedModelSource` | **Ontologies** | ActionContainsDuplicateEdits | `from foundry_sdk.v2.ontologies.errors import ActionContainsDuplicateEdits` | **Ontologies** | ActionEditedPropertiesNotFound | `from foundry_sdk.v2.ontologies.errors import ActionEditedPropertiesNotFound` | +**Ontologies** | ActionEditsNotSupportedWithMarketplace | `from foundry_sdk.v2.ontologies.errors import ActionEditsNotSupportedWithMarketplace` | **Ontologies** | ActionEditsReadOnlyEntity | `from foundry_sdk.v2.ontologies.errors import ActionEditsReadOnlyEntity` | **Ontologies** | ActionNotFound | `from foundry_sdk.v2.ontologies.errors import ActionNotFound` | **Ontologies** | ActionParameterInterfaceTypeNotFound | `from foundry_sdk.v2.ontologies.errors import ActionParameterInterfaceTypeNotFound` | @@ -3754,6 +3756,7 @@ Namespace | Name | Import | **Ontologies** | AttachmentNotFound | `from foundry_sdk.v2.ontologies.errors import AttachmentNotFound` | **Ontologies** | AttachmentRidAlreadyExists | `from foundry_sdk.v2.ontologies.errors import AttachmentRidAlreadyExists` | **Ontologies** | AttachmentSizeExceededLimit | `from foundry_sdk.v2.ontologies.errors import AttachmentSizeExceededLimit` | +**Ontologies** | BranchNotSupportedWithMarketplaceQuery | `from foundry_sdk.v2.ontologies.errors import BranchNotSupportedWithMarketplaceQuery` | **Ontologies** | CipherChannelNotFound | `from foundry_sdk.v2.ontologies.errors import CipherChannelNotFound` | **Ontologies** | CompositePrimaryKeyNotSupported | `from foundry_sdk.v2.ontologies.errors import CompositePrimaryKeyNotSupported` | **Ontologies** | ConsistentSnapshotError | `from foundry_sdk.v2.ontologies.errors import ConsistentSnapshotError` | @@ -3917,6 +3920,7 @@ Namespace | Name | Import | **Orchestration** | TargetNotSupported | `from foundry_sdk.v2.orchestration.errors import TargetNotSupported` | **Orchestration** | UnpauseSchedulePermissionDenied | `from foundry_sdk.v2.orchestration.errors import UnpauseSchedulePermissionDenied` | **SqlQueries** | CancelSqlQueryPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import CancelSqlQueryPermissionDenied` | +**SqlQueries** | ColumnTypesNotSupported | `from foundry_sdk.v2.sql_queries.errors import ColumnTypesNotSupported` | **SqlQueries** | ExecuteOntologySqlQueryPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import ExecuteOntologySqlQueryPermissionDenied` | **SqlQueries** | ExecuteSqlQueryPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import ExecuteSqlQueryPermissionDenied` | **SqlQueries** | GetResultsSqlQueryPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import GetResultsSqlQueryPermissionDenied` | @@ -4057,6 +4061,7 @@ Namespace | Name | Import | **Datasets** | UploadFilePermissionDenied | `from foundry_sdk.v1.datasets.errors import UploadFilePermissionDenied` | **Ontologies** | ActionContainsDuplicateEdits | `from foundry_sdk.v1.ontologies.errors import ActionContainsDuplicateEdits` | **Ontologies** | ActionEditedPropertiesNotFound | `from foundry_sdk.v1.ontologies.errors import ActionEditedPropertiesNotFound` | +**Ontologies** | ActionEditsNotSupportedWithMarketplace | `from foundry_sdk.v1.ontologies.errors import ActionEditsNotSupportedWithMarketplace` | **Ontologies** | ActionEditsReadOnlyEntity | `from foundry_sdk.v1.ontologies.errors import ActionEditsReadOnlyEntity` | **Ontologies** | ActionNotFound | `from foundry_sdk.v1.ontologies.errors import ActionNotFound` | **Ontologies** | ActionParameterInterfaceTypeNotFound | `from foundry_sdk.v1.ontologies.errors import ActionParameterInterfaceTypeNotFound` | @@ -4073,6 +4078,7 @@ Namespace | Name | Import | **Ontologies** | AttachmentNotFound | `from foundry_sdk.v1.ontologies.errors import AttachmentNotFound` | **Ontologies** | AttachmentRidAlreadyExists | `from foundry_sdk.v1.ontologies.errors import AttachmentRidAlreadyExists` | **Ontologies** | AttachmentSizeExceededLimit | `from foundry_sdk.v1.ontologies.errors import AttachmentSizeExceededLimit` | +**Ontologies** | BranchNotSupportedWithMarketplaceQuery | `from foundry_sdk.v1.ontologies.errors import BranchNotSupportedWithMarketplaceQuery` | **Ontologies** | CipherChannelNotFound | `from foundry_sdk.v1.ontologies.errors import CipherChannelNotFound` | **Ontologies** | CompositePrimaryKeyNotSupported | `from foundry_sdk.v1.ontologies.errors import CompositePrimaryKeyNotSupported` | **Ontologies** | ConsistentSnapshotError | `from foundry_sdk.v1.ontologies.errors import ConsistentSnapshotError` | diff --git a/docs-snippets-npm/package.json b/docs-snippets-npm/package.json index ff8722703..7241991fe 100644 --- a/docs-snippets-npm/package.json +++ b/docs-snippets-npm/package.json @@ -24,7 +24,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1593.0", + "minVersion": "1.1598.2", "maxVersion": "1.x.x", "optional": false } diff --git a/docs-snippets-npm/src/index.ts b/docs-snippets-npm/src/index.ts index e109a3d86..9fc02c32a 100644 --- a/docs-snippets-npm/src/index.ts +++ b/docs-snippets-npm/src/index.ts @@ -1875,7 +1875,7 @@ export const PYTHON_PLATFORM_SNIPPETS: SdkSnippets sql_queries_models.QueryStatus: @@ -128,11 +129,14 @@ def execute( :type query: str :param fallback_branch_ids: The list of branch ids to use as fallbacks if the query fails to execute on the primary branch. If a is not explicitly provided in the SQL query, the resource will be queried on the first fallback branch provided that exists. If no fallback branches are provided the default branch is used. This is `master` for most enrollments. :type fallback_branch_ids: Optional[List[BranchName]] + :param serialization_format: The format used to serialize query results. If not specified, defaults to `ARROW`. + :type serialization_format: Optional[SerializationFormat] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. :rtype: sql_queries_models.QueryStatus + :raises ColumnTypesNotSupported: The query result contains column types that are not supported by the requested serialization format. :raises ExecuteSqlQueryPermissionDenied: Could not execute the SqlQuery. :raises QueryCanceled: The query was canceled. :raises QueryFailed: The query failed. @@ -155,10 +159,12 @@ def execute( body=sql_queries_models.ExecuteSqlQueryRequest( query=query, fallback_branch_ids=fallback_branch_ids, + serialization_format=serialization_format, ), response_type=sql_queries_models.QueryStatus, request_timeout=request_timeout, throwable_errors={ + "ColumnTypesNotSupported": sql_queries_errors.ColumnTypesNotSupported, "ExecuteSqlQueryPermissionDenied": sql_queries_errors.ExecuteSqlQueryPermissionDenied, "QueryCanceled": sql_queries_errors.QueryCanceled, "QueryFailed": sql_queries_errors.QueryFailed, @@ -249,8 +255,8 @@ def get_results( _sdk_internal: core.SdkInternal = {}, ) -> core.TableResponse: """ - Gets the results of a query. The results of the query are returned in the - [Apache Arrow](https://arrow.apache.org/) format. + Gets the results of a query. Results are returned in the `serializationFormat` specified at execute time + (defaulting to [Apache Arrow](https://arrow.apache.org/) if no format is provided). This endpoint implements long polling and requests will time out after one minute. They can be safely retried while the query is still running. @@ -477,6 +483,7 @@ def execute( *, query: str, fallback_branch_ids: typing.Optional[typing.List[core_models.BranchName]] = None, + serialization_format: typing.Optional[sql_queries_models.SerializationFormat] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[sql_queries_models.QueryStatus]: @@ -489,11 +496,14 @@ def execute( :type query: str :param fallback_branch_ids: The list of branch ids to use as fallbacks if the query fails to execute on the primary branch. If a is not explicitly provided in the SQL query, the resource will be queried on the first fallback branch provided that exists. If no fallback branches are provided the default branch is used. This is `master` for most enrollments. :type fallback_branch_ids: Optional[List[BranchName]] + :param serialization_format: The format used to serialize query results. If not specified, defaults to `ARROW`. + :type serialization_format: Optional[SerializationFormat] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. :rtype: typing.Awaitable[sql_queries_models.QueryStatus] + :raises ColumnTypesNotSupported: The query result contains column types that are not supported by the requested serialization format. :raises ExecuteSqlQueryPermissionDenied: Could not execute the SqlQuery. :raises QueryCanceled: The query was canceled. :raises QueryFailed: The query failed. @@ -516,10 +526,12 @@ def execute( body=sql_queries_models.ExecuteSqlQueryRequest( query=query, fallback_branch_ids=fallback_branch_ids, + serialization_format=serialization_format, ), response_type=sql_queries_models.QueryStatus, request_timeout=request_timeout, throwable_errors={ + "ColumnTypesNotSupported": sql_queries_errors.ColumnTypesNotSupported, "ExecuteSqlQueryPermissionDenied": sql_queries_errors.ExecuteSqlQueryPermissionDenied, "QueryCanceled": sql_queries_errors.QueryCanceled, "QueryFailed": sql_queries_errors.QueryFailed, @@ -610,8 +622,8 @@ def get_results( _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[core.TableResponse]: """ - Gets the results of a query. The results of the query are returned in the - [Apache Arrow](https://arrow.apache.org/) format. + Gets the results of a query. Results are returned in the `serializationFormat` specified at execute time + (defaulting to [Apache Arrow](https://arrow.apache.org/) if no format is provided). This endpoint implements long polling and requests will time out after one minute. They can be safely retried while the query is still running.