snowflake-cli-labs 3.0.0rc5__py3-none-any.whl → 3.0.2__py3-none-any.whl

snowflake/cli/_plugins/spcs/image_repository/commands.py

@@ -1,202 +0,0 @@
-# Copyright (c) 2024 Snowflake Inc.
-#
-# Licensed 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 __future__ import annotations
-
-import json
-from typing import Optional
-
-import requests
-import typer
-from click import ClickException
-from snowflake.cli._plugins.object.command_aliases import (
-    add_object_command_aliases,
-    scope_option,
-)
-from snowflake.cli._plugins.spcs.image_registry.manager import RegistryManager
-from snowflake.cli._plugins.spcs.image_repository.manager import ImageRepositoryManager
-from snowflake.cli.api.commands.flags import (
-    IfNotExistsOption,
-    ReplaceOption,
-    identifier_argument,
-    like_option,
-)
-from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
-from snowflake.cli.api.console import cli_console
-from snowflake.cli.api.constants import ObjectType
-from snowflake.cli.api.identifiers import FQN
-from snowflake.cli.api.output.types import (
-    CollectionResult,
-    MessageResult,
-    SingleQueryResult,
-)
-from snowflake.cli.api.project.util import is_valid_object_name
-
-app = SnowTyperFactory(
-    name="image-repository",
-    help="Manages Snowpark Container Services image repositories.",
-    short_help="Manages image repositories.",
-)
-
-
-def _repo_name_callback(name: FQN):
-    if not is_valid_object_name(name.identifier, max_depth=2, allow_quoted=False):
-        raise ClickException(
-            f"'{name}' is not a valid image repository name. Note that image repository names must be unquoted identifiers. The same constraint also applies to database and schema names where you create an image repository."
-        )
-    return name
-
-
-REPO_NAME_ARGUMENT = identifier_argument(
-    sf_object="image repository",
-    example="my_repository",
-    callback=_repo_name_callback,
-)
-
-add_object_command_aliases(
-    app=app,
-    object_type=ObjectType.IMAGE_REPOSITORY,
-    name_argument=REPO_NAME_ARGUMENT,
-    like_option=like_option(
-        help_example='`list --like "my%"` lists all image repositories that begin with “my”.'
-    ),
-    scope_option=scope_option(help_example="`list --in database my_db`"),
-    ommit_commands=["describe"],
-)
-
-
-@app.command(requires_connection=True)
-def create(
-    name: FQN = REPO_NAME_ARGUMENT,
-    replace: bool = ReplaceOption(),
-    if_not_exists: bool = IfNotExistsOption(),
-    **options,
-):
-    """
-    Creates a new image repository in the current schema.
-    """
-    return SingleQueryResult(
-        ImageRepositoryManager().create(
-            name=name.identifier, replace=replace, if_not_exists=if_not_exists
-        )
-    )
-
-
-@app.command("list-images", requires_connection=True)
-def list_images(
-    name: FQN = REPO_NAME_ARGUMENT,
-    **options,
-) -> CollectionResult:
-    """Lists images in the given repository."""
-    repository_manager = ImageRepositoryManager()
-    database = repository_manager.get_database()
-    schema = repository_manager.get_schema()
-    url = repository_manager.get_repository_url(name.identifier)
-    api_url = repository_manager.get_repository_api_url(url)
-    bearer_login = RegistryManager().login_to_registry(api_url)
-    repos = []
-    query: Optional[str] = f"{api_url}/_catalog?n=10"
-
-    while query:
-        # Make paginated catalog requests
-        response = requests.get(
-            query, headers={"Authorization": f"Bearer {bearer_login}"}
-        )
-
-        if response.status_code != 200:
-            raise ClickException(f"Call to the registry failed {response.text}")
-
-        data = json.loads(response.text)
-        if "repositories" in data:
-            repos.extend(data["repositories"])
-
-        if "Link" in response.headers:
-            # There are more results
-            query = f"{api_url}/_catalog?n=10&last={repos[-1]}"
-        else:
-            query = None
-
-    images = []
-    for repo in repos:
-        prefix = f"/{database}/{schema}/{name}/"
-        repo = repo.replace("baserepo/", prefix)
-        images.append({"image": repo})
-
-    return CollectionResult(images)
-
-
-@app.command("list-tags", requires_connection=True)
-def list_tags(
-    name: FQN = REPO_NAME_ARGUMENT,
-    image_name: str = typer.Option(
-        ...,
-        "--image-name",
-        "--image_name",
-        "-i",
-        help="Fully qualified name of the image as shown in the output of list-images",
-        show_default=False,
-    ),
-    **options,
-) -> CollectionResult:
-    """Lists tags for the given image in a repository."""
-
-    repository_manager = ImageRepositoryManager()
-    url = repository_manager.get_repository_url(name.identifier)
-    api_url = repository_manager.get_repository_api_url(url)
-    bearer_login = RegistryManager().login_to_registry(api_url)
-
-    image_realname = "/".join(image_name.split("/")[4:])
-    tags = []
-    query: Optional[str] = f"{api_url}/{image_realname}/tags/list?n=10"
-
-    while query is not None:
-        # Make paginated catalog requests
-        response = requests.get(
-            query, headers={"Authorization": f"Bearer {bearer_login}"}
-        )
-
-        if response.status_code != 200:
-            cli_console.warning(f"Call to the registry failed {response.text}")
-
-        data = json.loads(response.text)
-        if "tags" in data:
-            tags.extend(data["tags"])
-
-        if "Link" in response.headers:
-            # There are more results
-            query = f"{api_url}/{image_realname}/tags/list?n=10&last={tags[-1]}"
-        else:
-            query = None
-
-    tags_list = []
-    for tag in tags:
-        image_tag = f"{image_name}:{tag}"
-        tags_list.append({"tag": image_tag})
-
-    return CollectionResult(tags_list)
-
-
-@app.command("url", requires_connection=True)
-def repo_url(
-    name: FQN = REPO_NAME_ARGUMENT,
-    **options,
-):
-    """Returns the URL for the given repository."""
-    return MessageResult(
-        (
-            ImageRepositoryManager().get_repository_url(
-                repo_name=name.identifier, with_scheme=False
-            )
-        )
-    )

snowflake/cli/_plugins/spcs/image_repository/manager.py

@@ -1,84 +0,0 @@
-# Copyright (c) 2024 Snowflake Inc.
-#
-# Licensed 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 urllib.parse import urlparse
-
-from snowflake.cli._plugins.spcs.common import handle_object_already_exists
-from snowflake.cli.api.constants import ObjectType
-from snowflake.cli.api.identifiers import FQN
-from snowflake.cli.api.sql_execution import SqlExecutionMixin
-from snowflake.connector.errors import ProgrammingError
-
-
-class ImageRepositoryManager(SqlExecutionMixin):
-    def get_database(self):
-        return self._conn.database
-
-    def get_schema(self):
-        return self._conn.schema
-
-    def get_role(self):
-        return self._conn.role
-
-    def get_repository_url(self, repo_name: str, with_scheme: bool = True):
-
-        repo_row = self.show_specific_object(
-            "image repositories", repo_name, check_schema=True
-        )
-        if repo_row is None:
-            fqn = FQN.from_string(repo_name).using_connection(self._conn)
-            raise ProgrammingError(
-                f"Image repository '{fqn.identifier}' does not exist or not authorized."
-            )
-        if with_scheme:
-            return f"https://{repo_row['repository_url']}"
-        else:
-            return repo_row["repository_url"]
-
-    def get_repository_api_url(self, repo_url):
-        """
-        Converts a repo URL to a registry OCI API URL.
-        https://reg.com/db/schema/repo becomes https://reg.com/v2/db/schema/repo
-        """
-        parsed_url = urlparse(repo_url)
-
-        scheme = parsed_url.scheme
-        host = parsed_url.netloc
-        path = parsed_url.path
-
-        return f"{scheme}://{host}/v2{path}"
-
-    def create(
-        self,
-        name: str,
-        if_not_exists: bool,
-        replace: bool,
-    ):
-        if if_not_exists and replace:
-            raise ValueError(
-                "'replace' and 'if_not_exists' options are mutually exclusive for ImageRepositoryManager.create"
-            )
-        elif replace:
-            create_statement = "create or replace image repository"
-        elif if_not_exists:
-            create_statement = "create image repository if not exists"
-        else:
-            create_statement = "create image repository"
-
-        try:
-            return self._execute_schema_query(f"{create_statement} {name}", name=name)
-        except ProgrammingError as e:
-            handle_object_already_exists(
-                e, ObjectType.IMAGE_REPOSITORY, name, replace_available=True
-            )

snowflake/cli/_plugins/spcs/plugin_spec.py

@@ -1,30 +0,0 @@
-# Copyright (c) 2024 Snowflake Inc.
-#
-# Licensed 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 snowflake.cli._plugins.spcs import app
-from snowflake.cli.api.plugins.command import (
-    SNOWCLI_ROOT_COMMAND_PATH,
-    CommandSpec,
-    CommandType,
-    plugin_hook_impl,
-)
-
-
-@plugin_hook_impl
-def command_spec():
-    return CommandSpec(
-        parent_command_path=SNOWCLI_ROOT_COMMAND_PATH,
-        command_type=CommandType.COMMAND_GROUP,
-        typer_instance=app.create_instance(),
-    )

snowflake/cli/_plugins/spcs/services/__init__.py

@@ -1,13 +0,0 @@
-# Copyright (c) 2024 Snowflake Inc.
-#
-# Licensed 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.

snowflake/cli/_plugins/spcs/services/commands.py

@@ -1,345 +0,0 @@
-# Copyright (c) 2024 Snowflake Inc.
-#
-# Licensed 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 __future__ import annotations
-
-import sys
-from pathlib import Path
-from typing import List, Optional
-
-import typer
-from click import ClickException
-from snowflake.cli._plugins.object.command_aliases import (
-    add_object_command_aliases,
-    scope_option,
-)
-from snowflake.cli._plugins.object.common import CommentOption, Tag, TagOption
-from snowflake.cli._plugins.spcs.common import (
-    print_log_lines,
-    validate_and_set_instances,
-)
-from snowflake.cli._plugins.spcs.services.manager import ServiceManager
-from snowflake.cli.api.commands.flags import (
-    IfNotExistsOption,
-    OverrideableOption,
-    identifier_argument,
-    like_option,
-)
-from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
-from snowflake.cli.api.constants import ObjectType
-from snowflake.cli.api.identifiers import FQN
-from snowflake.cli.api.output.types import (
-    CommandResult,
-    QueryJsonValueResult,
-    QueryResult,
-    SingleQueryResult,
-)
-from snowflake.cli.api.project.util import is_valid_object_name
-
-app = SnowTyperFactory(
-    name="service",
-    help="Manages Snowpark Container Services services.",
-    short_help="Manages services.",
-)
-
-
-def _service_name_callback(name: FQN) -> FQN:
-    if not is_valid_object_name(name.identifier, max_depth=2, allow_quoted=False):
-        raise ClickException(
-            f"'{name}' is not a valid service name. Note service names must be unquoted identifiers. The same constraint also applies to database and schema names where you create a service."
-        )
-    return name
-
-
-ServiceNameArgument = identifier_argument(
-    sf_object="service",
-    example="my_service",
-    callback=_service_name_callback,
-)
-
-SpecPathOption = typer.Option(
-    ...,
-    "--spec-path",
-    help="Path to service specification file.",
-    file_okay=True,
-    dir_okay=False,
-    exists=True,
-    show_default=False,
-)
-
-_MIN_INSTANCES_HELP = "Minimum number of service instances to run."
-MinInstancesOption = OverrideableOption(
-    1, "--min-instances", help=_MIN_INSTANCES_HELP, min=1
-)
-
-_MAX_INSTANCES_HELP = "Maximum number of service instances to run."
-MaxInstancesOption = OverrideableOption(
-    None, "--max-instances", help=_MAX_INSTANCES_HELP, min=1
-)
-
-_QUERY_WAREHOUSE_HELP = "Warehouse to use if a service container connects to Snowflake to execute a query without explicitly specifying a warehouse to use."
-QueryWarehouseOption = OverrideableOption(
-    None,
-    "--query-warehouse",
-    help=_QUERY_WAREHOUSE_HELP,
-)
-
-_AUTO_RESUME_HELP = "The service will automatically resume when a service function or ingress is called."
-AutoResumeOption = OverrideableOption(
-    True,
-    "--auto-resume/--no-auto-resume",
-    help=_AUTO_RESUME_HELP,
-)
-
-_COMMENT_HELP = "Comment for the service."
-
-add_object_command_aliases(
-    app=app,
-    object_type=ObjectType.SERVICE,
-    name_argument=ServiceNameArgument,
-    like_option=like_option(
-        help_example='`list --like "my%"` lists all services that begin with “my”.'
-    ),
-    scope_option=scope_option(help_example="`list --in compute-pool my_pool`"),
-)
-
-
-@app.command(requires_connection=True)
-def create(
-    name: FQN = ServiceNameArgument,
-    compute_pool: str = typer.Option(
-        ...,
-        "--compute-pool",
-        help="Compute pool to run the service on.",
-        show_default=False,
-    ),
-    spec_path: Path = SpecPathOption,
-    min_instances: int = MinInstancesOption(),
-    max_instances: Optional[int] = MaxInstancesOption(),
-    auto_resume: bool = AutoResumeOption(),
-    external_access_integrations: Optional[List[str]] = typer.Option(
-        None,
-        "--eai-name",
-        help="Identifies External Access Integrations(EAI) that the service can access. This option may be specified multiple times for multiple EAIs.",
-    ),
-    query_warehouse: Optional[str] = QueryWarehouseOption(),
-    tags: Optional[List[Tag]] = TagOption(help="Tag for the service."),
-    comment: Optional[str] = CommentOption(help=_COMMENT_HELP),
-    if_not_exists: bool = IfNotExistsOption(),
-    **options,
-) -> CommandResult:
-    """
-    Creates a new service in the current schema.
-    """
-    max_instances = validate_and_set_instances(
-        min_instances, max_instances, "instances"
-    )
-    cursor = ServiceManager().create(
-        service_name=name.identifier,
-        min_instances=min_instances,
-        max_instances=max_instances,
-        compute_pool=compute_pool,
-        spec_path=spec_path,
-        external_access_integrations=external_access_integrations,
-        auto_resume=auto_resume,
-        query_warehouse=query_warehouse,
-        tags=tags,
-        comment=comment,
-        if_not_exists=if_not_exists,
-    )
-    return SingleQueryResult(cursor)
-
-
-@app.command(requires_connection=True)
-def execute_job(
-    name: FQN = ServiceNameArgument,
-    compute_pool: str = typer.Option(
-        ...,
-        "--compute-pool",
-        help="Compute pool to run the job service on.",
-        show_default=False,
-    ),
-    spec_path: Path = SpecPathOption,
-    external_access_integrations: Optional[List[str]] = typer.Option(
-        None,
-        "--eai-name",
-        help="Identifies External Access Integrations(EAI) that the job service can access. This option may be specified multiple times for multiple EAIs.",
-    ),
-    query_warehouse: Optional[str] = QueryWarehouseOption(),
-    comment: Optional[str] = CommentOption(help=_COMMENT_HELP),
-    **options,
-) -> CommandResult:
-    """
-    Creates and executes a job service in the current schema.
-    """
-    cursor = ServiceManager().execute_job(
-        job_service_name=name.identifier,
-        compute_pool=compute_pool,
-        spec_path=spec_path,
-        external_access_integrations=external_access_integrations,
-        query_warehouse=query_warehouse,
-        comment=comment,
-    )
-    return SingleQueryResult(cursor)
-
-
-@app.command(requires_connection=True)
-def status(name: FQN = ServiceNameArgument, **options) -> CommandResult:
-    """
-    Retrieves the status of a service.
-    """
-    cursor = ServiceManager().status(service_name=name.identifier)
-    return QueryJsonValueResult(cursor)
-
-
-@app.command(requires_connection=True)
-def logs(
-    name: FQN = ServiceNameArgument,
-    container_name: str = typer.Option(
-        ...,
-        "--container-name",
-        help="Name of the container.",
-        show_default=False,
-    ),
-    instance_id: str = typer.Option(
-        ...,
-        "--instance-id",
-        help="ID of the service instance, starting with 0.",
-        show_default=False,
-    ),
-    num_lines: int = typer.Option(
-        500, "--num-lines", help="Number of lines to retrieve."
-    ),
-    **options,
-):
-    """
-    Retrieves local logs from a service container.
-    """
-    results = ServiceManager().logs(
-        service_name=name.identifier,
-        instance_id=instance_id,
-        container_name=container_name,
-        num_lines=num_lines,
-    )
-    cursor = results.fetchone()
-    logs = next(iter(cursor)).split("\n")
-    print_log_lines(sys.stdout, name, "0", logs)
-
-
-@app.command(requires_connection=True)
-def upgrade(
-    name: FQN = ServiceNameArgument,
-    spec_path: Path = SpecPathOption,
-    **options,
-):
-    """
-    Updates an existing service with a new specification file.
-    """
-    return SingleQueryResult(
-        ServiceManager().upgrade_spec(service_name=name.identifier, spec_path=spec_path)
-    )
-
-
-@app.command("list-endpoints", requires_connection=True)
-def list_endpoints(name: FQN = ServiceNameArgument, **options):
-    """
-    Lists the endpoints in a service.
-    """
-    return QueryResult(ServiceManager().list_endpoints(service_name=name.identifier))
-
-
-@app.command(requires_connection=True)
-def suspend(name: FQN = ServiceNameArgument, **options) -> CommandResult:
-    """
-    Suspends the service, shutting down and deleting all its containers.
-    """
-    return SingleQueryResult(ServiceManager().suspend(name))
-
-
-@app.command(requires_connection=True)
-def resume(name: FQN = ServiceNameArgument, **options) -> CommandResult:
-    """
-    Resumes the service from a SUSPENDED state.
-    """
-    return SingleQueryResult(ServiceManager().resume(name))
-
-
-@app.command("set", requires_connection=True)
-def set_property(
-    name: FQN = ServiceNameArgument,
-    min_instances: Optional[int] = MinInstancesOption(default=None, show_default=False),
-    max_instances: Optional[int] = MaxInstancesOption(show_default=False),
-    query_warehouse: Optional[str] = QueryWarehouseOption(show_default=False),
-    auto_resume: Optional[bool] = AutoResumeOption(default=None, show_default=False),
-    comment: Optional[str] = CommentOption(help=_COMMENT_HELP, show_default=False),
-    **options,
-):
-    """
-    Sets one or more properties for the service.
-    """
-    cursor = ServiceManager().set_property(
-        service_name=name.identifier,
-        min_instances=min_instances,
-        max_instances=max_instances,
-        query_warehouse=query_warehouse,
-        auto_resume=auto_resume,
-        comment=comment,
-    )
-    return SingleQueryResult(cursor)
-
-
-@app.command("unset", requires_connection=True)
-def unset_property(
-    name: FQN = ServiceNameArgument,
-    min_instances: bool = MinInstancesOption(
-        default=False,
-        help=f"Reset the MIN_INSTANCES property - {_MIN_INSTANCES_HELP}",
-        show_default=False,
-    ),
-    max_instances: bool = MaxInstancesOption(
-        default=False,
-        help=f"Reset the MAX_INSTANCES property - {_MAX_INSTANCES_HELP}",
-        show_default=False,
-    ),
-    query_warehouse: bool = QueryWarehouseOption(
-        default=False,
-        help=f"Reset the QUERY_WAREHOUSE property - {_QUERY_WAREHOUSE_HELP}",
-        show_default=False,
-    ),
-    auto_resume: bool = AutoResumeOption(
-        default=False,
-        param_decls=["--auto-resume"],
-        help=f"Reset the AUTO_RESUME property - {_AUTO_RESUME_HELP}",
-        show_default=False,
-    ),
-    comment: bool = CommentOption(
-        default=False,
-        help=f"Reset the COMMENT property - {_COMMENT_HELP}",
-        callback=None,
-        show_default=False,
-    ),
-    **options,
-):
-    """
-    Resets one or more properties for the service to their default value(s).
-    """
-    cursor = ServiceManager().unset_property(
-        service_name=name.identifier,
-        min_instances=min_instances,
-        max_instances=max_instances,
-        query_warehouse=query_warehouse,
-        auto_resume=auto_resume,
-        comment=comment,
-    )
-    return SingleQueryResult(cursor)