Download Evaluate/projects/iceberg/python/pyiceberg/catalog/rest.py from SYSUSELab/RustRepoTrans: direct link, hf CLI and curl.
- Browser
- Download file 31.7 kB
-
https://huggingface.co/datasets/SYSUSELab/RustRepoTrans/resolve/main/Evaluate/projects/iceberg/python/pyiceberg/catalog/rest.py
- Command line
-
hf download hf://datasets/SYSUSELab/RustRepoTrans/Evaluate/projects/iceberg/python/pyiceberg/catalog/rest.py
-
curl -L -o rest.py https://huggingface.co/datasets/SYSUSELab/RustRepoTrans/resolve/main/Evaluate/projects/iceberg/python/pyiceberg/catalog/rest.py
31.7 kB
| # Licensed to the Apache Software Foundation (ASF) under one | |
| # or more contributor license agreements. See the NOTICE file | |
| # distributed with this work for additional information | |
| # regarding copyright ownership. The ASF licenses this file | |
| # to you under the Apache License, Version 2.0 (the | |
| # "License"); you may not use this file except in compliance | |
| # with the License. You may obtain a copy of the License at | |
| # | |
| # http://www.apache.org/licenses/LICENSE-2.0 | |
| # | |
| # Unless required by applicable law or agreed to in writing, | |
| # software distributed under the License is distributed on an | |
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
| # KIND, either express or implied. See the License for the | |
| # specific language governing permissions and limitations | |
| # under the License. | |
| from json import JSONDecodeError | |
| from typing import ( | |
| TYPE_CHECKING, | |
| Any, | |
| Dict, | |
| List, | |
| Literal, | |
| Optional, | |
| Set, | |
| Tuple, | |
| Type, | |
| Union, | |
| ) | |
| from pydantic import Field, ValidationError, field_validator | |
| from requests import HTTPError, Session | |
| from tenacity import RetryCallState, retry, retry_if_exception_type, stop_after_attempt | |
| from pyiceberg import __version__ | |
| from pyiceberg.catalog import ( | |
| TOKEN, | |
| URI, | |
| WAREHOUSE_LOCATION, | |
| Catalog, | |
| PropertiesUpdateSummary, | |
| ) | |
| from pyiceberg.exceptions import ( | |
| AuthorizationExpiredError, | |
| BadRequestError, | |
| CommitFailedException, | |
| CommitStateUnknownException, | |
| ForbiddenError, | |
| NamespaceAlreadyExistsError, | |
| NoSuchNamespaceError, | |
| NoSuchTableError, | |
| OAuthError, | |
| RESTError, | |
| ServerError, | |
| ServiceUnavailableError, | |
| TableAlreadyExistsError, | |
| UnauthorizedError, | |
| ) | |
| from pyiceberg.partitioning import UNPARTITIONED_PARTITION_SPEC, PartitionSpec, assign_fresh_partition_spec_ids | |
| from pyiceberg.schema import Schema, assign_fresh_schema_ids | |
| from pyiceberg.table import ( | |
| CommitTableRequest, | |
| CommitTableResponse, | |
| CreateTableTransaction, | |
| StagedTable, | |
| Table, | |
| TableIdentifier, | |
| ) | |
| from pyiceberg.table.metadata import TableMetadata | |
| from pyiceberg.table.sorting import UNSORTED_SORT_ORDER, SortOrder, assign_fresh_sort_order_ids | |
| from pyiceberg.typedef import EMPTY_DICT, UTF8, IcebergBaseModel, Identifier, Properties | |
| from pyiceberg.types import transform_dict_value_to_str | |
| if TYPE_CHECKING: | |
| import pyarrow as pa | |
| ICEBERG_REST_SPEC_VERSION = "0.14.1" | |
| class Endpoints: | |
| get_config: str = "config" | |
| list_namespaces: str = "namespaces" | |
| create_namespace: str = "namespaces" | |
| load_namespace_metadata: str = "namespaces/{namespace}" | |
| drop_namespace: str = "namespaces/{namespace}" | |
| update_namespace_properties: str = "namespaces/{namespace}/properties" | |
| list_tables: str = "namespaces/{namespace}/tables" | |
| create_table: str = "namespaces/{namespace}/tables" | |
| register_table = "namespaces/{namespace}/register" | |
| load_table: str = "namespaces/{namespace}/tables/{table}" | |
| update_table: str = "namespaces/{namespace}/tables/{table}" | |
| drop_table: str = "namespaces/{namespace}/tables/{table}?purgeRequested={purge}" | |
| table_exists: str = "namespaces/{namespace}/tables/{table}" | |
| get_token: str = "oauth/tokens" | |
| rename_table: str = "tables/rename" | |
| AUTHORIZATION_HEADER = "Authorization" | |
| BEARER_PREFIX = "Bearer" | |
| CATALOG_SCOPE = "catalog" | |
| CLIENT_ID = "client_id" | |
| PREFIX = "prefix" | |
| CLIENT_SECRET = "client_secret" | |
| CLIENT_CREDENTIALS = "client_credentials" | |
| CREDENTIAL = "credential" | |
| GRANT_TYPE = "grant_type" | |
| SCOPE = "scope" | |
| AUDIENCE = "audience" | |
| RESOURCE = "resource" | |
| TOKEN_EXCHANGE = "urn:ietf:params:oauth:grant-type:token-exchange" | |
| SEMICOLON = ":" | |
| KEY = "key" | |
| CERT = "cert" | |
| CLIENT = "client" | |
| CA_BUNDLE = "cabundle" | |
| SSL = "ssl" | |
| SIGV4 = "rest.sigv4-enabled" | |
| SIGV4_REGION = "rest.signing-region" | |
| SIGV4_SERVICE = "rest.signing-name" | |
| AUTH_URL = "rest.authorization-url" | |
| HEADER_PREFIX = "header." | |
| NAMESPACE_SEPARATOR = b"\x1f".decode(UTF8) | |
| def _retry_hook(retry_state: RetryCallState) -> None: | |
| rest_catalog: RestCatalog = retry_state.args[0] | |
| rest_catalog._refresh_token() # pylint: disable=protected-access | |
| _RETRY_ARGS = { | |
| "retry": retry_if_exception_type(AuthorizationExpiredError), | |
| "stop": stop_after_attempt(2), | |
| "before_sleep": _retry_hook, | |
| "reraise": True, | |
| } | |
| class TableResponse(IcebergBaseModel): | |
| metadata_location: Optional[str] = Field(alias="metadata-location") | |
| metadata: TableMetadata | |
| config: Properties = Field(default_factory=dict) | |
| class CreateTableRequest(IcebergBaseModel): | |
| name: str = Field() | |
| location: Optional[str] = Field() | |
| table_schema: Schema = Field(alias="schema") | |
| partition_spec: Optional[PartitionSpec] = Field(alias="partition-spec") | |
| write_order: Optional[SortOrder] = Field(alias="write-order") | |
| stage_create: bool = Field(alias="stage-create", default=False) | |
| properties: Dict[str, str] = Field(default_factory=dict) | |
| # validators | |
| def transform_properties_dict_value_to_str(cls, properties: Properties) -> Dict[str, str]: | |
| return transform_dict_value_to_str(properties) | |
| class RegisterTableRequest(IcebergBaseModel): | |
| name: str | |
| metadata_location: str = Field(..., alias="metadata-location") | |
| class TokenResponse(IcebergBaseModel): | |
| access_token: str = Field() | |
| token_type: str = Field() | |
| expires_in: Optional[int] = Field(default=None) | |
| issued_token_type: Optional[str] = Field(default=None) | |
| refresh_token: Optional[str] = Field(default=None) | |
| scope: Optional[str] = Field(default=None) | |
| class ConfigResponse(IcebergBaseModel): | |
| defaults: Properties = Field() | |
| overrides: Properties = Field() | |
| class ListNamespaceResponse(IcebergBaseModel): | |
| namespaces: List[Identifier] = Field() | |
| class NamespaceResponse(IcebergBaseModel): | |
| namespace: Identifier = Field() | |
| properties: Properties = Field() | |
| class UpdateNamespacePropertiesResponse(IcebergBaseModel): | |
| removed: List[str] = Field() | |
| updated: List[str] = Field() | |
| missing: List[str] = Field() | |
| class ListTableResponseEntry(IcebergBaseModel): | |
| name: str = Field() | |
| namespace: Identifier = Field() | |
| class ListTablesResponse(IcebergBaseModel): | |
| identifiers: List[ListTableResponseEntry] = Field() | |
| class ErrorResponseMessage(IcebergBaseModel): | |
| message: str = Field() | |
| type: str = Field() | |
| code: int = Field() | |
| class ErrorResponse(IcebergBaseModel): | |
| error: ErrorResponseMessage = Field() | |
| class OAuthErrorResponse(IcebergBaseModel): | |
| error: Literal[ | |
| "invalid_request", "invalid_client", "invalid_grant", "unauthorized_client", "unsupported_grant_type", "invalid_scope" | |
| ] | |
| error_description: Optional[str] = None | |
| error_uri: Optional[str] = None | |
| class RestCatalog(Catalog): | |
| uri: str | |
| _session: Session | |
| def __init__(self, name: str, **properties: str): | |
| """Rest Catalog. | |
| You either need to provide a client_id and client_secret, or an already valid token. | |
| Args: | |
| name: Name to identify the catalog. | |
| properties: Properties that are passed along to the configuration. | |
| """ | |
| super().__init__(name, **properties) | |
| self.uri = properties[URI] | |
| self._fetch_config() | |
| self._session = self._create_session() | |
| def _create_session(self) -> Session: | |
| """Create a request session with provided catalog configuration.""" | |
| session = Session() | |
| # Sets the client side and server side SSL cert verification, if provided as properties. | |
| if ssl_config := self.properties.get(SSL): | |
| if ssl_ca_bundle := ssl_config.get(CA_BUNDLE): | |
| session.verify = ssl_ca_bundle | |
| if ssl_client := ssl_config.get(CLIENT): | |
| if all(k in ssl_client for k in (CERT, KEY)): | |
| session.cert = (ssl_client[CERT], ssl_client[KEY]) | |
| elif ssl_client_cert := ssl_client.get(CERT): | |
| session.cert = ssl_client_cert | |
| self._refresh_token(session, self.properties.get(TOKEN)) | |
| # Set HTTP headers | |
| self._config_headers(session) | |
| # Configure SigV4 Request Signing | |
| if str(self.properties.get(SIGV4, False)).lower() == "true": | |
| self._init_sigv4(session) | |
| return session | |
| def _check_valid_namespace_identifier(self, identifier: Union[str, Identifier]) -> Identifier: | |
| """Check if the identifier has at least one element.""" | |
| identifier_tuple = Catalog.identifier_to_tuple(identifier) | |
| if len(identifier_tuple) < 1: | |
| raise NoSuchNamespaceError(f"Empty namespace identifier: {identifier}") | |
| return identifier_tuple | |
| def url(self, endpoint: str, prefixed: bool = True, **kwargs: Any) -> str: | |
| """Construct the endpoint. | |
| Args: | |
| endpoint: Resource identifier that points to the REST catalog. | |
| prefixed: If the prefix return by the config needs to be appended. | |
| Returns: | |
| The base url of the rest catalog. | |
| """ | |
| url = self.uri | |
| url = url + "v1/" if url.endswith("/") else url + "/v1/" | |
| if prefixed: | |
| url += self.properties.get(PREFIX, "") | |
| url = url if url.endswith("/") else url + "/" | |
| return url + endpoint.format(**kwargs) | |
| def auth_url(self) -> str: | |
| if url := self.properties.get(AUTH_URL): | |
| return url | |
| else: | |
| return self.url(Endpoints.get_token, prefixed=False) | |
| def _extract_optional_oauth_params(self) -> Dict[str, str]: | |
| optional_oauth_param = {SCOPE: self.properties.get(SCOPE) or CATALOG_SCOPE} | |
| set_of_optional_params = {AUDIENCE, RESOURCE} | |
| for param in set_of_optional_params: | |
| if param_value := self.properties.get(param): | |
| optional_oauth_param[param] = param_value | |
| return optional_oauth_param | |
| def _fetch_access_token(self, session: Session, credential: str) -> str: | |
| if SEMICOLON in credential: | |
| client_id, client_secret = credential.split(SEMICOLON) | |
| else: | |
| client_id, client_secret = None, credential | |
| data = {GRANT_TYPE: CLIENT_CREDENTIALS, CLIENT_ID: client_id, CLIENT_SECRET: client_secret} | |
| optional_oauth_params = self._extract_optional_oauth_params() | |
| data.update(optional_oauth_params) | |
| response = session.post( | |
| url=self.auth_url, data=data, headers={**session.headers, "Content-type": "application/x-www-form-urlencoded"} | |
| ) | |
| try: | |
| response.raise_for_status() | |
| except HTTPError as exc: | |
| self._handle_non_200_response(exc, {400: OAuthError, 401: OAuthError}) | |
| return TokenResponse(**response.json()).access_token | |
| def _fetch_config(self) -> None: | |
| params = {} | |
| if warehouse_location := self.properties.get(WAREHOUSE_LOCATION): | |
| params[WAREHOUSE_LOCATION] = warehouse_location | |
| with self._create_session() as session: | |
| response = session.get(self.url(Endpoints.get_config, prefixed=False), params=params) | |
| try: | |
| response.raise_for_status() | |
| except HTTPError as exc: | |
| self._handle_non_200_response(exc, {}) | |
| config_response = ConfigResponse(**response.json()) | |
| config = config_response.defaults | |
| config.update(self.properties) | |
| config.update(config_response.overrides) | |
| self.properties = config | |
| # Update URI based on overrides | |
| self.uri = config[URI] | |
| def _identifier_to_validated_tuple(self, identifier: Union[str, Identifier]) -> Identifier: | |
| identifier_tuple = self.identifier_to_tuple(identifier) | |
| if len(identifier_tuple) <= 1: | |
| raise NoSuchTableError(f"Missing namespace or invalid identifier: {'.'.join(identifier_tuple)}") | |
| return identifier_tuple | |
| def _split_identifier_for_path(self, identifier: Union[str, Identifier, TableIdentifier]) -> Properties: | |
| if isinstance(identifier, TableIdentifier): | |
| return {"namespace": NAMESPACE_SEPARATOR.join(identifier.namespace.root[1:]), "table": identifier.name} | |
| identifier_tuple = self._identifier_to_validated_tuple(identifier) | |
| return {"namespace": NAMESPACE_SEPARATOR.join(identifier_tuple[:-1]), "table": identifier_tuple[-1]} | |
| def _split_identifier_for_json(self, identifier: Union[str, Identifier]) -> Dict[str, Union[Identifier, str]]: | |
| identifier_tuple = self._identifier_to_validated_tuple(identifier) | |
| return {"namespace": identifier_tuple[:-1], "name": identifier_tuple[-1]} | |
| def _handle_non_200_response(self, exc: HTTPError, error_handler: Dict[int, Type[Exception]]) -> None: | |
| exception: Type[Exception] | |
| if exc.response is None: | |
| raise ValueError("Did not receive a response") | |
| code = exc.response.status_code | |
| if code in error_handler: | |
| exception = error_handler[code] | |
| elif code == 400: | |
| exception = BadRequestError | |
| elif code == 401: | |
| exception = UnauthorizedError | |
| elif code == 403: | |
| exception = ForbiddenError | |
| elif code == 422: | |
| exception = RESTError | |
| elif code == 419: | |
| exception = AuthorizationExpiredError | |
| elif code == 501: | |
| exception = NotImplementedError | |
| elif code == 503: | |
| exception = ServiceUnavailableError | |
| elif 500 <= code < 600: | |
| exception = ServerError | |
| else: | |
| exception = RESTError | |
| try: | |
| if exception == OAuthError: | |
| # The OAuthErrorResponse has a different format | |
| error = OAuthErrorResponse(**exc.response.json()) | |
| response = str(error.error) | |
| if description := error.error_description: | |
| response += f": {description}" | |
| if uri := error.error_uri: | |
| response += f" ({uri})" | |
| else: | |
| error = ErrorResponse(**exc.response.json()).error | |
| response = f"{error.type}: {error.message}" | |
| except JSONDecodeError: | |
| # In the case we don't have a proper response | |
| response = f"RESTError {exc.response.status_code}: Could not decode json payload: {exc.response.text}" | |
| except ValidationError as e: | |
| # In the case we don't have a proper response | |
| errs = ", ".join(err["msg"] for err in e.errors()) | |
| response = ( | |
| f"RESTError {exc.response.status_code}: Received unexpected JSON Payload: {exc.response.text}, errors: {errs}" | |
| ) | |
| raise exception(response) from exc | |
| def _init_sigv4(self, session: Session) -> None: | |
| from urllib import parse | |
| import boto3 | |
| from botocore.auth import SigV4Auth | |
| from botocore.awsrequest import AWSRequest | |
| from requests import PreparedRequest | |
| from requests.adapters import HTTPAdapter | |
| class SigV4Adapter(HTTPAdapter): | |
| def __init__(self, **properties: str): | |
| super().__init__() | |
| self._properties = properties | |
| def add_headers(self, request: PreparedRequest, **kwargs: Any) -> None: # pylint: disable=W0613 | |
| boto_session = boto3.Session() | |
| credentials = boto_session.get_credentials().get_frozen_credentials() | |
| region = self._properties.get(SIGV4_REGION, boto_session.region_name) | |
| service = self._properties.get(SIGV4_SERVICE, "execute-api") | |
| url = str(request.url).split("?")[0] | |
| query = str(parse.urlsplit(request.url).query) | |
| params = dict(parse.parse_qsl(query)) | |
| # remove the connection header as it will be updated after signing | |
| del request.headers["connection"] | |
| aws_request = AWSRequest( | |
| method=request.method, url=url, params=params, data=request.body, headers=dict(request.headers) | |
| ) | |
| SigV4Auth(credentials, service, region).add_auth(aws_request) | |
| original_header = request.headers | |
| signed_headers = aws_request.headers | |
| relocated_headers = {} | |
| # relocate headers if there is a conflict with signed headers | |
| for header, value in original_header.items(): | |
| if header in signed_headers and signed_headers[header] != value: | |
| relocated_headers[f"Original-{header}"] = value | |
| request.headers.update(relocated_headers) | |
| request.headers.update(signed_headers) | |
| session.mount(self.uri, SigV4Adapter(**self.properties)) | |
| def _response_to_table(self, identifier_tuple: Tuple[str, ...], table_response: TableResponse) -> Table: | |
| return Table( | |
| identifier=(self.name,) + identifier_tuple if self.name else identifier_tuple, | |
| metadata_location=table_response.metadata_location, # type: ignore | |
| metadata=table_response.metadata, | |
| io=self._load_file_io( | |
| {**table_response.metadata.properties, **table_response.config}, table_response.metadata_location | |
| ), | |
| catalog=self, | |
| ) | |
| def _response_to_staged_table(self, identifier_tuple: Tuple[str, ...], table_response: TableResponse) -> StagedTable: | |
| return StagedTable( | |
| identifier=(self.name,) + identifier_tuple if self.name else identifier_tuple, | |
| metadata_location=table_response.metadata_location, # type: ignore | |
| metadata=table_response.metadata, | |
| io=self._load_file_io( | |
| {**table_response.metadata.properties, **table_response.config}, table_response.metadata_location | |
| ), | |
| catalog=self, | |
| ) | |
| def _refresh_token(self, session: Optional[Session] = None, initial_token: Optional[str] = None) -> None: | |
| session = session or self._session | |
| if initial_token is not None: | |
| self.properties[TOKEN] = initial_token | |
| elif CREDENTIAL in self.properties: | |
| self.properties[TOKEN] = self._fetch_access_token(session, self.properties[CREDENTIAL]) | |
| # Set Auth token for subsequent calls in the session | |
| if token := self.properties.get(TOKEN): | |
| session.headers[AUTHORIZATION_HEADER] = f"{BEARER_PREFIX} {token}" | |
| def _config_headers(self, session: Session) -> None: | |
| header_properties = self._extract_headers_from_properties() | |
| session.headers.update(header_properties) | |
| session.headers["Content-type"] = "application/json" | |
| session.headers["X-Client-Version"] = ICEBERG_REST_SPEC_VERSION | |
| session.headers["User-Agent"] = f"PyIceberg/{__version__}" | |
| session.headers["X-Iceberg-Access-Delegation"] = "vended-credentials" | |
| def _extract_headers_from_properties(self) -> Dict[str, str]: | |
| return {key[len(HEADER_PREFIX) :]: value for key, value in self.properties.items() if key.startswith(HEADER_PREFIX)} | |
| def _create_table( | |
| self, | |
| identifier: Union[str, Identifier], | |
| schema: Union[Schema, "pa.Schema"], | |
| location: Optional[str] = None, | |
| partition_spec: PartitionSpec = UNPARTITIONED_PARTITION_SPEC, | |
| sort_order: SortOrder = UNSORTED_SORT_ORDER, | |
| properties: Properties = EMPTY_DICT, | |
| stage_create: bool = False, | |
| ) -> TableResponse: | |
| iceberg_schema = self._convert_schema_if_needed(schema) | |
| fresh_schema = assign_fresh_schema_ids(iceberg_schema) | |
| fresh_partition_spec = assign_fresh_partition_spec_ids(partition_spec, iceberg_schema, fresh_schema) | |
| fresh_sort_order = assign_fresh_sort_order_ids(sort_order, iceberg_schema, fresh_schema) | |
| namespace_and_table = self._split_identifier_for_path(identifier) | |
| if location: | |
| location = location.rstrip("/") | |
| request = CreateTableRequest( | |
| name=namespace_and_table["table"], | |
| location=location, | |
| table_schema=fresh_schema, | |
| partition_spec=fresh_partition_spec, | |
| write_order=fresh_sort_order, | |
| stage_create=stage_create, | |
| properties=properties, | |
| ) | |
| serialized_json = request.model_dump_json().encode(UTF8) | |
| response = self._session.post( | |
| self.url(Endpoints.create_table, namespace=namespace_and_table["namespace"]), | |
| data=serialized_json, | |
| ) | |
| try: | |
| response.raise_for_status() | |
| except HTTPError as exc: | |
| self._handle_non_200_response(exc, {409: TableAlreadyExistsError}) | |
| return TableResponse(**response.json()) | |
| def create_table( | |
| self, | |
| identifier: Union[str, Identifier], | |
| schema: Union[Schema, "pa.Schema"], | |
| location: Optional[str] = None, | |
| partition_spec: PartitionSpec = UNPARTITIONED_PARTITION_SPEC, | |
| sort_order: SortOrder = UNSORTED_SORT_ORDER, | |
| properties: Properties = EMPTY_DICT, | |
| ) -> Table: | |
| table_response = self._create_table( | |
| identifier=identifier, | |
| schema=schema, | |
| location=location, | |
| partition_spec=partition_spec, | |
| sort_order=sort_order, | |
| properties=properties, | |
| stage_create=False, | |
| ) | |
| return self._response_to_table(self.identifier_to_tuple(identifier), table_response) | |
| def create_table_transaction( | |
| self, | |
| identifier: Union[str, Identifier], | |
| schema: Union[Schema, "pa.Schema"], | |
| location: Optional[str] = None, | |
| partition_spec: PartitionSpec = UNPARTITIONED_PARTITION_SPEC, | |
| sort_order: SortOrder = UNSORTED_SORT_ORDER, | |
| properties: Properties = EMPTY_DICT, | |
| ) -> CreateTableTransaction: | |
| table_response = self._create_table( | |
| identifier=identifier, | |
| schema=schema, | |
| location=location, | |
| partition_spec=partition_spec, | |
| sort_order=sort_order, | |
| properties=properties, | |
| stage_create=True, | |
| ) | |
| staged_table = self._response_to_staged_table(self.identifier_to_tuple(identifier), table_response) | |
| return CreateTableTransaction(staged_table) | |
| def register_table(self, identifier: Union[str, Identifier], metadata_location: str) -> Table: | |
| """Register a new table using existing metadata. | |
| Args: | |
| identifier Union[str, Identifier]: Table identifier for the table | |
| metadata_location str: The location to the metadata | |
| Returns: | |
| Table: The newly registered table | |
| Raises: | |
| TableAlreadyExistsError: If the table already exists | |
| """ | |
| namespace_and_table = self._split_identifier_for_path(identifier) | |
| request = RegisterTableRequest( | |
| name=namespace_and_table["table"], | |
| metadata_location=metadata_location, | |
| ) | |
| serialized_json = request.model_dump_json().encode(UTF8) | |
| response = self._session.post( | |
| self.url(Endpoints.register_table, namespace=namespace_and_table["namespace"]), | |
| data=serialized_json, | |
| ) | |
| try: | |
| response.raise_for_status() | |
| except HTTPError as exc: | |
| self._handle_non_200_response(exc, {409: TableAlreadyExistsError}) | |
| table_response = TableResponse(**response.json()) | |
| return self._response_to_table(self.identifier_to_tuple(identifier), table_response) | |
| def list_tables(self, namespace: Union[str, Identifier]) -> List[Identifier]: | |
| namespace_tuple = self._check_valid_namespace_identifier(namespace) | |
| namespace_concat = NAMESPACE_SEPARATOR.join(namespace_tuple) | |
| response = self._session.get(self.url(Endpoints.list_tables, namespace=namespace_concat)) | |
| try: | |
| response.raise_for_status() | |
| except HTTPError as exc: | |
| self._handle_non_200_response(exc, {404: NoSuchNamespaceError}) | |
| return [(*table.namespace, table.name) for table in ListTablesResponse(**response.json()).identifiers] | |
| def load_table(self, identifier: Union[str, Identifier]) -> Table: | |
| identifier_tuple = self.identifier_to_tuple_without_catalog(identifier) | |
| response = self._session.get( | |
| self.url(Endpoints.load_table, prefixed=True, **self._split_identifier_for_path(identifier_tuple)) | |
| ) | |
| try: | |
| response.raise_for_status() | |
| except HTTPError as exc: | |
| self._handle_non_200_response(exc, {404: NoSuchTableError}) | |
| table_response = TableResponse(**response.json()) | |
| return self._response_to_table(identifier_tuple, table_response) | |
| def drop_table(self, identifier: Union[str, Identifier], purge_requested: bool = False) -> None: | |
| identifier_tuple = self.identifier_to_tuple_without_catalog(identifier) | |
| response = self._session.delete( | |
| self.url( | |
| Endpoints.drop_table, prefixed=True, purge=purge_requested, **self._split_identifier_for_path(identifier_tuple) | |
| ), | |
| ) | |
| try: | |
| response.raise_for_status() | |
| except HTTPError as exc: | |
| self._handle_non_200_response(exc, {404: NoSuchTableError}) | |
| def purge_table(self, identifier: Union[str, Identifier]) -> None: | |
| self.drop_table(identifier=identifier, purge_requested=True) | |
| def rename_table(self, from_identifier: Union[str, Identifier], to_identifier: Union[str, Identifier]) -> Table: | |
| from_identifier_tuple = self.identifier_to_tuple_without_catalog(from_identifier) | |
| payload = { | |
| "source": self._split_identifier_for_json(from_identifier_tuple), | |
| "destination": self._split_identifier_for_json(to_identifier), | |
| } | |
| response = self._session.post(self.url(Endpoints.rename_table), json=payload) | |
| try: | |
| response.raise_for_status() | |
| except HTTPError as exc: | |
| self._handle_non_200_response(exc, {404: NoSuchTableError, 409: TableAlreadyExistsError}) | |
| return self.load_table(to_identifier) | |
| def _commit_table(self, table_request: CommitTableRequest) -> CommitTableResponse: | |
| """Update the table. | |
| Args: | |
| table_request (CommitTableRequest): The table requests to be carried out. | |
| Returns: | |
| CommitTableResponse: The updated metadata. | |
| Raises: | |
| NoSuchTableError: If a table with the given identifier does not exist. | |
| CommitFailedException: Requirement not met, or a conflict with a concurrent commit. | |
| CommitStateUnknownException: Failed due to an internal exception on the side of the catalog. | |
| """ | |
| response = self._session.post( | |
| self.url(Endpoints.update_table, prefixed=True, **self._split_identifier_for_path(table_request.identifier)), | |
| data=table_request.model_dump_json().encode(UTF8), | |
| ) | |
| try: | |
| response.raise_for_status() | |
| except HTTPError as exc: | |
| self._handle_non_200_response( | |
| exc, | |
| { | |
| 409: CommitFailedException, | |
| 500: CommitStateUnknownException, | |
| 502: CommitStateUnknownException, | |
| 504: CommitStateUnknownException, | |
| }, | |
| ) | |
| return CommitTableResponse(**response.json()) | |
| def create_namespace(self, namespace: Union[str, Identifier], properties: Properties = EMPTY_DICT) -> None: | |
| namespace_tuple = self._check_valid_namespace_identifier(namespace) | |
| payload = {"namespace": namespace_tuple, "properties": properties} | |
| response = self._session.post(self.url(Endpoints.create_namespace), json=payload) | |
| try: | |
| response.raise_for_status() | |
| except HTTPError as exc: | |
| self._handle_non_200_response(exc, {409: NamespaceAlreadyExistsError}) | |
| def drop_namespace(self, namespace: Union[str, Identifier]) -> None: | |
| namespace_tuple = self._check_valid_namespace_identifier(namespace) | |
| namespace = NAMESPACE_SEPARATOR.join(namespace_tuple) | |
| response = self._session.delete(self.url(Endpoints.drop_namespace, namespace=namespace)) | |
| try: | |
| response.raise_for_status() | |
| except HTTPError as exc: | |
| self._handle_non_200_response(exc, {404: NoSuchNamespaceError}) | |
| def list_namespaces(self, namespace: Union[str, Identifier] = ()) -> List[Identifier]: | |
| namespace_tuple = self.identifier_to_tuple(namespace) | |
| response = self._session.get( | |
| self.url( | |
| f"{Endpoints.list_namespaces}?parent={NAMESPACE_SEPARATOR.join(namespace_tuple)}" | |
| if namespace_tuple | |
| else Endpoints.list_namespaces | |
| ), | |
| ) | |
| try: | |
| response.raise_for_status() | |
| except HTTPError as exc: | |
| self._handle_non_200_response(exc, {}) | |
| namespaces = ListNamespaceResponse(**response.json()) | |
| return [namespace_tuple + child_namespace for child_namespace in namespaces.namespaces] | |
| def load_namespace_properties(self, namespace: Union[str, Identifier]) -> Properties: | |
| namespace_tuple = self._check_valid_namespace_identifier(namespace) | |
| namespace = NAMESPACE_SEPARATOR.join(namespace_tuple) | |
| response = self._session.get(self.url(Endpoints.load_namespace_metadata, namespace=namespace)) | |
| try: | |
| response.raise_for_status() | |
| except HTTPError as exc: | |
| self._handle_non_200_response(exc, {404: NoSuchNamespaceError}) | |
| return NamespaceResponse(**response.json()).properties | |
| def update_namespace_properties( | |
| self, namespace: Union[str, Identifier], removals: Optional[Set[str]] = None, updates: Properties = EMPTY_DICT | |
| ) -> PropertiesUpdateSummary: | |
| namespace_tuple = self._check_valid_namespace_identifier(namespace) | |
| namespace = NAMESPACE_SEPARATOR.join(namespace_tuple) | |
| payload = {"removals": list(removals or []), "updates": updates} | |
| response = self._session.post(self.url(Endpoints.update_namespace_properties, namespace=namespace), json=payload) | |
| try: | |
| response.raise_for_status() | |
| except HTTPError as exc: | |
| self._handle_non_200_response(exc, {404: NoSuchNamespaceError}) | |
| parsed_response = UpdateNamespacePropertiesResponse(**response.json()) | |
| return PropertiesUpdateSummary( | |
| removed=parsed_response.removed, | |
| updated=parsed_response.updated, | |
| missing=parsed_response.missing, | |
| ) | |
| def table_exists(self, identifier: Union[str, Identifier]) -> bool: | |
| """Check if a table exists. | |
| Args: | |
| identifier (str | Identifier): Table identifier. | |
| Returns: | |
| bool: True if the table exists, False otherwise. | |
| """ | |
| identifier_tuple = self.identifier_to_tuple_without_catalog(identifier) | |
| response = self._session.head( | |
| self.url(Endpoints.load_table, prefixed=True, **self._split_identifier_for_path(identifier_tuple)) | |
| ) | |
| return response.status_code in (200, 204) | |