snowflake-cli-labs 2.3.1__py3-none-any.whl → 2.4.0rc0__py3-none-any.whl

snowflake/cli/plugins/snowpark/commands.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import logging
 from enum import Enum
-from typing import Dict, List, Optional, Set
+from typing import Dict, List, Optional, Set, Tuple
 
 import typer
 from click import ClickException
@@ -14,6 +14,8 @@ from snowflake.cli.api.commands.flags import (
     ReplaceOption,
     deprecated_flag_callback_enum,
     execution_identifier_argument,
+    identifier_argument,
+    like_option,
 )
 from snowflake.cli.api.commands.project_initialisation import add_init_command
 from snowflake.cli.api.commands.snow_typer import SnowTyper
@@ -25,6 +27,7 @@ from snowflake.cli.api.constants import (
 from snowflake.cli.api.exceptions import (
     SecretsWithoutExternalAccessIntegrationError,
 )
+from snowflake.cli.api.identifiers import FQN
 from snowflake.cli.api.output.types import (
     CollectionResult,
     CommandResult,
@@ -32,11 +35,22 @@ from snowflake.cli.api.output.types import (
     SingleQueryResult,
 )
 from snowflake.cli.api.project.schemas.snowpark.callable import (
-    Callable,
     FunctionSchema,
     ProcedureSchema,
 )
 from snowflake.cli.api.secure_path import SecurePath
+from snowflake.cli.plugins.object.commands import (
+    describe as object_describe,
+)
+from snowflake.cli.plugins.object.commands import (
+    drop as object_drop,
+)
+from snowflake.cli.plugins.object.commands import (
+    list_ as object_list,
+)
+from snowflake.cli.plugins.object.commands import (
+    scope_option,
+)
 from snowflake.cli.plugins.object.manager import ObjectManager
 from snowflake.cli.plugins.snowpark import package_utils
 from snowflake.cli.plugins.snowpark.common import (
@@ -73,8 +87,15 @@ app = SnowTyper(
 ObjectTypeArgument = typer.Argument(
     help="Type of Snowpark object",
     case_sensitive=False,
+    show_default=False,
+)
+IdentifierArgument = identifier_argument(
+    "function/procedure",
+    example="hello(int, string)",
+)
+LikeOption = like_option(
+    help_example='`list function --like "my%"` lists all functions that begin with “my”',
 )
-
 add_init_command(app, project_type="Snowpark", template="default_snowpark")
 
 
@@ -132,7 +153,7 @@ def deploy(
     # Create stage
     stage_name = snowpark.stage_name
     stage_manager = StageManager()
-    stage_name = stage_manager.to_fully_qualified_name(stage_name)
+    stage_name = FQN.from_string(stage_name).using_context()
     stage_manager.create(
         stage_name=stage_name, comment="deployments managed by Snowflake CLI"
     )
@@ -181,7 +202,7 @@ def deploy(
 
 
 def _assert_object_definitions_are_correct(
-    object_type, object_definitions: List[Callable]
+    object_type, object_definitions: List[FunctionSchema | ProcedureSchema]
 ):
     for definition in object_definitions:
         database = definition.database
@@ -256,7 +277,7 @@ def get_app_stage_path(stage_name: Optional[str], project_name: str) -> str:
 def _deploy_single_object(
     manager: FunctionManager | ProcedureManager,
     object_type: ObjectType,
-    object_definition: Callable,
+    object_definition: FunctionSchema | ProcedureSchema,
     existing_objects: Dict[str, Dict],
     snowflake_dependencies: List[str],
     stage_artifact_path: str,
@@ -275,6 +296,7 @@ def _deploy_single_object(
     handler = object_definition.handler
     returns = object_definition.returns
     imports = object_definition.imports
+    external_access_integrations = object_definition.external_access_integrations
     replace_object = False
 
     object_exists = identifier in existing_objects
@@ -285,6 +307,7 @@ def _deploy_single_object(
             handler=handler,
             return_type=returns,
             snowflake_dependencies=snowflake_dependencies,
+            external_access_integrations=external_access_integrations,
             imports=imports,
             stage_artifact_file=stage_artifact_path,
         )
@@ -463,3 +486,36 @@ def execute(
         "execute", object_type=object_type, execution_identifier=execution_identifier
     )
     return SingleQueryResult(cursor)
+
+
+@app.command("list", requires_connection=True)
+def list_(
+    object_type: _SnowparkObject = ObjectTypeArgument,
+    like: str = LikeOption,
+    scope: Tuple[str, str] = scope_option(
+        help_example="`list function --in database my_db`"
+    ),
+    **options,
+):
+    """Lists all available procedures or functions."""
+    object_list(object_type=object_type.value, like=like, scope=scope, **options)
+
+
+@app.command("drop", requires_connection=True)
+def drop(
+    object_type: _SnowparkObject = ObjectTypeArgument,
+    identifier: str = IdentifierArgument,
+    **options,
+):
+    """Drop procedure or function."""
+    object_drop(object_type=object_type.value, object_name=identifier, **options)
+
+
+@app.command("describe", requires_connection=True)
+def describe(
+    object_type: _SnowparkObject = ObjectTypeArgument,
+    identifier: str = IdentifierArgument,
+    **options,
+):
+    """Provides description of a procedure or function."""
+    object_describe(object_type=object_type.value, object_name=identifier, **options)

snowflake/cli/plugins/snowpark/common.py

@@ -4,6 +4,7 @@ import re
 from typing import Dict, List, Optional, Set
 
 from snowflake.cli.api.constants import ObjectType
+from snowflake.cli.api.identifiers import FQN
 from snowflake.cli.api.project.schemas.snowpark.argument import Argument
 from snowflake.cli.api.sql_execution import SqlExecutionMixin
 from snowflake.cli.plugins.snowpark.models import Requirement
@@ -21,6 +22,7 @@ def check_if_replace_is_required(
     handler: str,
     return_type: str,
     snowflake_dependencies: List[str],
+    external_access_integrations: List[str],
     imports: List[str],
     stage_artifact_file: str,
 ) -> bool:
@@ -42,6 +44,15 @@ def check_if_replace_is_required(
         )
         return True
 
+    if set(external_access_integrations) != set(
+        resource_json.get("external_access_integrations", [])
+    ):
+        log.info(
+            "Found difference of external access integrations. Replacing the %s.",
+            object_type,
+        )
+        return True
+
     if (
         resource_json["handler"].lower() != handler.lower()
         or _sql_to_python_return_type_mapper(resource_json["returns"]).lower()
@@ -189,12 +200,12 @@ def build_udf_sproc_identifier(
             result += f" default {val}"
         return result
 
-    arguments = ", ".join(format_arg(arg) for arg in udf_sproc.signature)
-    name = slq_exec_mixin.to_fully_qualified_name(
-        udf_sproc.name,
-        database=udf_sproc.database,
-        schema=udf_sproc.schema_name,
-    )
+    if udf_sproc.signature and udf_sproc.signature != "null":
+        arguments = ", ".join(format_arg(arg) for arg in udf_sproc.signature)
+    else:
+        arguments = ""
+
+    name = FQN.from_identifier_model(udf_sproc).using_context().identifier
     return f"{name}({arguments})"
 
 

snowflake/cli/plugins/spcs/compute_pool/commands.py

@@ -1,11 +1,21 @@
+from __future__ import annotations
+
 from typing import Optional
 
 import typer
 from click import ClickException
-from snowflake.cli.api.commands.flags import IfNotExistsOption, OverrideableOption
+from snowflake.cli.api.commands.flags import (
+    IfNotExistsOption,
+    OverrideableOption,
+    like_option,
+)
 from snowflake.cli.api.commands.snow_typer import SnowTyper
+from snowflake.cli.api.constants import ObjectType
 from snowflake.cli.api.output.types import CommandResult, SingleQueryResult
 from snowflake.cli.api.project.util import is_valid_object_name
+from snowflake.cli.plugins.object.command_aliases import (
+    add_object_command_aliases,
+)
 from snowflake.cli.plugins.object.common import CommentOption
 from snowflake.cli.plugins.spcs.common import (
     validate_and_set_instances,
@@ -69,6 +79,16 @@ AutoSuspendSecsOption = OverrideableOption(
 
 _COMMENT_HELP = "Comment for the compute pool."
 
+add_object_command_aliases(
+    app=app,
+    object_type=ObjectType.COMPUTE_POOL,
+    name_argument=ComputePoolNameArgument,
+    like_option=like_option(
+        help_example='`list --like "my%"` lists all compute pools that begin with “my”.'
+    ),
+    scope_option=None,
+)
+
 
 @app.command(requires_connection=True)
 def create(
@@ -77,6 +97,7 @@ def create(
         ...,
         "--family",
         help="Name of the instance family. For more information about instance families, refer to the SQL CREATE COMPUTE POOL command.",
+        show_default=False,
     ),
     min_nodes: int = MinNodesOption(),
     max_nodes: Optional[int] = MaxNodesOption(),

snowflake/cli/plugins/spcs/compute_pool/manager.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import List, Optional
 
 from snowflake.cli.api.constants import ObjectType

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

@@ -1,18 +1,29 @@
+from __future__ import annotations
+
 import json
 from typing import Optional
 
 import requests
 import typer
 from click import ClickException
-from snowflake.cli.api.commands.flags import IfNotExistsOption, ReplaceOption
+from snowflake.cli.api.commands.flags import (
+    IfNotExistsOption,
+    ReplaceOption,
+    like_option,
+)
 from snowflake.cli.api.commands.snow_typer import SnowTyper
 from snowflake.cli.api.console import cli_console
+from snowflake.cli.api.constants import ObjectType
 from snowflake.cli.api.output.types import (
     CollectionResult,
     MessageResult,
     SingleQueryResult,
 )
 from snowflake.cli.api.project.util import is_valid_object_name
+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
 
@@ -34,6 +45,18 @@ def _repo_name_callback(name: str):
 REPO_NAME_ARGUMENT = typer.Argument(
     help="Name of the image repository.",
     callback=_repo_name_callback,
+    show_default=False,
+)
+
+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"],
 )
 
 
@@ -106,6 +129,7 @@ def list_tags(
         "--image_name",
         "-i",
         help="Fully qualified name of the image as shown in the output of list-images",
+        show_default=False,
     ),
     **options,
 ) -> CollectionResult:

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

@@ -1,6 +1,7 @@
 from urllib.parse import urlparse
 
 from snowflake.cli.api.constants import ObjectType
+from snowflake.cli.api.identifiers import FQN
 from snowflake.cli.api.sql_execution import SqlExecutionMixin
 from snowflake.cli.plugins.spcs.common import handle_object_already_exists
 from snowflake.connector.errors import ProgrammingError
@@ -22,8 +23,9 @@ class ImageRepositoryManager(SqlExecutionMixin):
             "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 '{self.to_fully_qualified_name(repo_name)}' does not exist or not authorized."
+                f"Image repository '{fqn.identifier}' does not exist or not authorized."
             )
         if with_scheme:
             return f"https://{repo_row['repository_url']}"

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

@@ -1,11 +1,18 @@
+from __future__ import annotations
+
 import sys
 from pathlib import Path
 from typing import List, Optional
 
 import typer
 from click import ClickException
-from snowflake.cli.api.commands.flags import IfNotExistsOption, OverrideableOption
+from snowflake.cli.api.commands.flags import (
+    IfNotExistsOption,
+    OverrideableOption,
+    like_option,
+)
 from snowflake.cli.api.commands.snow_typer import SnowTyper
+from snowflake.cli.api.constants import ObjectType
 from snowflake.cli.api.output.types import (
     CommandResult,
     QueryJsonValueResult,
@@ -13,6 +20,10 @@ from snowflake.cli.api.output.types import (
     SingleQueryResult,
 )
 from snowflake.cli.api.project.util import is_valid_object_name
+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,
@@ -36,7 +47,10 @@ def _service_name_callback(name: str) -> str:
 
 
 ServiceNameArgument = typer.Argument(
-    ..., help="Name of the service.", callback=_service_name_callback
+    ...,
+    help="Name of the service.",
+    callback=_service_name_callback,
+    show_default=False,
 )
 
 SpecPathOption = typer.Option(
@@ -46,6 +60,7 @@ SpecPathOption = typer.Option(
     file_okay=True,
     dir_okay=False,
     exists=True,
+    show_default=False,
 )
 
 _MIN_INSTANCES_HELP = "Minimum number of service instances to run."
@@ -74,12 +89,25 @@ AutoResumeOption = OverrideableOption(
 
 _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: str = ServiceNameArgument,
     compute_pool: str = typer.Option(
-        ..., "--compute-pool", help="Compute pool to run the service on."
+        ...,
+        "--compute-pool",
+        help="Compute pool to run the service on.",
+        show_default=False,
     ),
     spec_path: Path = SpecPathOption,
     min_instances: int = MinInstancesOption(),
@@ -131,10 +159,16 @@ def status(name: str = ServiceNameArgument, **options) -> CommandResult:
 def logs(
     name: str = ServiceNameArgument,
     container_name: str = typer.Option(
-        ..., "--container-name", help="Name of the container."
+        ...,
+        "--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."
+        ...,
+        "--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."

snowflake/cli/plugins/spcs/services/manager.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import json
 from pathlib import Path
 from typing import List, Optional

snowflake/cli/plugins/sql/commands.py

@@ -1,8 +1,13 @@
+from __future__ import annotations
+
 from pathlib import Path
 from typing import List, Optional
 
 import typer
-from snowflake.cli.api.commands.flags import parse_key_value_variables
+from snowflake.cli.api.commands.flags import (
+    parse_key_value_variables,
+    project_definition_option,
+)
 from snowflake.cli.api.commands.snow_typer import SnowTyper
 from snowflake.cli.api.output.types import CommandResult, MultipleResults, QueryResult
 from snowflake.cli.plugins.sql.manager import SqlManager
@@ -19,7 +24,7 @@ def _parse_key_value(key_value_str: str):
     return parts[0], "=".join(parts[1:])
 
 
-@app.command(name="sql", requires_connection=True)
+@app.command(name="sql", requires_connection=True, no_args_is_help=True)
 def execute_sql(
     query: Optional[str] = typer.Option(
         None,
@@ -27,7 +32,7 @@ def execute_sql(
         "-q",
         help="Query to execute.",
     ),
-    file: Optional[Path] = typer.Option(
+    files: Optional[List[Path]] = typer.Option(
         None,
         "--filename",
         "-f",
@@ -50,22 +55,25 @@ def execute_sql(
         help="String in format of key=value. If provided the SQL content will "
         "be treated as template and rendered using provided data.",
     ),
+    _: Optional[str] = project_definition_option(optional=True),
     **options,
 ) -> CommandResult:
     """
     Executes Snowflake query.
 
+    Use either query, filename or input option.
+
     Query to execute can be specified using query option, filename option (all queries from file will be executed)
     or via stdin by piping output from other command. For example `cat my.sql | snow sql -i`.
 
-    The command supports variable substitution that happens on client-side. Both $VARIABLE or ${ VARIABLE }
+    The command supports variable substitution that happens on client-side. Both &VARIABLE or &{ VARIABLE }
     syntax are supported.
     """
     data = {}
     if data_override:
         data = {v.key: v.value for v in parse_key_value_variables(data_override)}
 
-    single_statement, cursors = SqlManager().execute(query, file, std_in, data=data)
+    single_statement, cursors = SqlManager().execute(query, files, std_in, data=data)
     if single_statement:
         return QueryResult(next(cursors))
     return MultipleResults((QueryResult(c) for c in cursors))

snowflake/cli/plugins/sql/manager.py

@@ -2,31 +2,31 @@ from __future__ import annotations
 
 import sys
 from io import StringIO
+from itertools import chain
 from pathlib import Path
-from typing import Dict, Iterable, Optional, Tuple
+from typing import Dict, Iterable, List, Tuple
 
 from click import ClickException, UsageError
 from jinja2 import UndefinedError
 from snowflake.cli.api.secure_path import UNLIMITED, SecurePath
 from snowflake.cli.api.sql_execution import SqlExecutionMixin
-from snowflake.cli.api.utils.rendering import snowflake_cli_jinja_render
+from snowflake.cli.api.utils.rendering import snowflake_sql_jinja_render
 from snowflake.cli.plugins.sql.snowsql_templating import transpile_snowsql_templates
 from snowflake.connector.cursor import SnowflakeCursor
 from snowflake.connector.util_text import split_statements
 
+IsSingleStatement = bool
+
 
 class SqlManager(SqlExecutionMixin):
     def execute(
         self,
-        query: Optional[str],
-        file: Optional[Path],
+        query: str | None,
+        files: List[Path] | None,
         std_in: bool,
         data: Dict | None = None,
-    ) -> Tuple[int, Iterable[SnowflakeCursor]]:
-        inputs = [query, file, std_in]
-        if not any(inputs):
-            raise UsageError("Use either query, filename or input option.")
-
+    ) -> Tuple[IsSingleStatement, Iterable[SnowflakeCursor]]:
+        inputs = [query, files, std_in]
         # Check if any two inputs were provided simultaneously
         if len([i for i in inputs if i]) > 1:
             raise UsageError(
@@ -35,16 +35,37 @@ class SqlManager(SqlExecutionMixin):
 
         if std_in:
             query = sys.stdin.read()
-        elif file:
-            query = SecurePath(file).read_text(file_size_limit_mb=UNLIMITED)
-
-        if data:
-            # Do rendering if any data was provided
-            try:
-                query = transpile_snowsql_templates(query)
-                query = snowflake_cli_jinja_render(content=query, data=data)
-            except UndefinedError as err:
-                raise ClickException(f"SQL template rendering error: {err}")
+        if query:
+            return self._execute_single_query(query=query, data=data)
+
+        if files:
+            # Multiple files
+            results = []
+            single_statement = False
+            for file in files:
+                query_from_file = SecurePath(file).read_text(
+                    file_size_limit_mb=UNLIMITED
+                )
+                single_statement, result = self._execute_single_query(
+                    query=query_from_file, data=data
+                )
+                results.append(result)
+
+            # Use single_statement if there's only one, otherwise this is multi statement result
+            single_statement = len(files) == 1 and single_statement
+            return single_statement, chain.from_iterable(results)
+
+        # At that point, no stdin, query or files were provided
+        raise UsageError("Use either query, filename or input option.")
+
+    def _execute_single_query(
+        self, query: str, data: Dict | None = None
+    ) -> Tuple[IsSingleStatement, Iterable[SnowflakeCursor]]:
+        try:
+            query = transpile_snowsql_templates(query)
+            query = snowflake_sql_jinja_render(content=query, data=data)
+        except UndefinedError as err:
+            raise ClickException(f"SQL template rendering error: {err}")
 
         statements = tuple(
             statement

snowflake/cli/plugins/stage/commands.py

@@ -11,9 +11,11 @@ from snowflake.cli.api.commands.flags import (
     OnErrorOption,
     PatternOption,
     VariablesOption,
+    like_option,
 )
 from snowflake.cli.api.commands.snow_typer import SnowTyper
 from snowflake.cli.api.console import cli_console
+from snowflake.cli.api.constants import ObjectType
 from snowflake.cli.api.output.types import (
     CollectionResult,
     CommandResult,
@@ -22,6 +24,10 @@ from snowflake.cli.api.output.types import (
     SingleQueryResult,
 )
 from snowflake.cli.api.utils.path_utils import is_stage_path
+from snowflake.cli.plugins.object.command_aliases import (
+    add_object_command_aliases,
+    scope_option,
+)
 from snowflake.cli.plugins.stage.diff import DiffResult, compute_stage_diff
 from snowflake.cli.plugins.stage.manager import OnErrorType, StageManager
 
@@ -32,6 +38,16 @@ app = SnowTyper(
 
 StageNameArgument = typer.Argument(..., help="Name of the stage.", show_default=False)
 
+add_object_command_aliases(
+    app=app,
+    object_type=ObjectType.STAGE,
+    name_argument=StageNameArgument,
+    like_option=like_option(
+        help_example='`list --like "my%"` lists all stages that begin with “my”',
+    ),
+    scope_option=scope_option(help_example="`list --in database my_db`"),
+)
+
 
 @app.command("list-files", requires_connection=True)
 def stage_list_files(
@@ -112,7 +128,11 @@ def stage_create(stage_name: str = StageNameArgument, **options) -> CommandResul
 @app.command("remove", requires_connection=True)
 def stage_remove(
     stage_name: str = StageNameArgument,
-    file_name: str = typer.Argument(..., help="Name of the file to remove."),
+    file_name: str = typer.Argument(
+        ...,
+        help="Name of the file to remove.",
+        show_default=False,
+    ),
     **options,
 ) -> CommandResult:
     """
@@ -125,8 +145,14 @@ def stage_remove(
 
 @app.command("diff", hidden=True, requires_connection=True)
 def stage_diff(
-    stage_name: str = typer.Argument(help="Fully qualified name of a stage"),
-    folder_name: str = typer.Argument(help="Path to local folder"),
+    stage_name: str = typer.Argument(
+        help="Fully qualified name of a stage",
+        show_default=False,
+    ),
+    folder_name: str = typer.Argument(
+        help="Path to local folder",
+        show_default=False,
+    ),
     **options,
 ) -> ObjectResult:
     """

snowflake/cli/plugins/stage/diff.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import hashlib
 import logging
 import re