Copilot commented on code in PR #12040: URL: https://github.com/apache/gravitino/pull/12040#discussion_r3596217423
########## clients/client-python/gravitino/api/rel/view_catalog.py: ########## @@ -0,0 +1,149 @@ +# 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 abc import ABC, abstractmethod +from typing import Optional + +from gravitino.api.rel.column import Column +from gravitino.api.rel.representation import Representation +from gravitino.api.rel.view import View +from gravitino.api.rel.view_change import ViewChange +from gravitino.exceptions.base import NoSuchViewException +from gravitino.name_identifier import NameIdentifier +from gravitino.namespace import Namespace + + +class ViewCatalog(ABC): + """The `ViewCatalog` interface defines the public API for managing views in a schema. + + If the catalog implementation supports views, it must implement this interface. + """ + + @abstractmethod + def list_views(self, namespace: Namespace) -> list[NameIdentifier]: + """List the views in a namespace from the catalog. + + Args: + namespace (Namespace): A namespace. + + Returns: + list[NameIdentifier]: An array of view identifiers in the namespace. + + Raises: + NoSuchSchemaException: If the schema does not exist. + """ + + @abstractmethod + def load_view(self, identifier: NameIdentifier) -> View: + """Load view metadata by `NameIdentifier` from the catalog. + + Args: + identifier (NameIdentifier): A view identifier. + + Returns: + View: The view metadata. + + Raises: + NoSuchViewException: If the view does not exist. + """ + + def view_exists(self, identifier: NameIdentifier) -> bool: + """Check if a view with the given name exists in the catalog. + + Args: + identifier: The view identifier. + + Returns: + True if the view exists, False otherwise. + """ + try: + self.load_view(identifier) + return True + except NoSuchViewException: + return False + + @abstractmethod + def create_view( + self, + identifier: NameIdentifier, + columns: list[Column], + representations: list[Representation], + comment: Optional[str] = None, + default_catalog: Optional[str] = None, + default_schema: Optional[str] = None, + properties: Optional[dict[str, str]] = None, + ) -> View: + """Create a view in the catalog. + + Args: + identifier (NameIdentifier): + A view identifier. + columns (list[Column]): + The columns of the new view. + representations (list[Representation]): + The SQL representations of the new view. Review Comment: In `create_view()`, the docstring describes `representations` as “SQL representations”, but the type is `list[Representation]` and the `Representation` abstraction implies non-SQL representations may exist. Consider making the wording representation-type-agnostic (and optionally note that at least one representation is expected, matching the Java API contract). -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
