snowflake-cli-labs 2.5.0rc3__py3-none-any.whl → 2.6.0.dev0__py3-none-any.whl

snowflake/cli/plugins/object/commands.py

@@ -14,14 +14,14 @@
 
 from __future__ import annotations
 
-from typing import Tuple
+from typing import List, Optional, Tuple
 
 import typer
 from click import ClickException
-from snowflake.cli.api.commands.flags import like_option
+from snowflake.cli.api.commands.flags import like_option, parse_key_value_variables
 from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
 from snowflake.cli.api.constants import SUPPORTED_OBJECTS, VALID_SCOPES
-from snowflake.cli.api.output.types import QueryResult
+from snowflake.cli.api.output.types import MessageResult, QueryResult
 from snowflake.cli.api.project.util import is_valid_identifier
 from snowflake.cli.plugins.object.manager import ObjectManager
 
@@ -35,6 +35,30 @@ NameArgument = typer.Argument(help="Name of the object")
 ObjectArgument = typer.Argument(
     help="Type of object. For example table, procedure, streamlit.",
     case_sensitive=False,
+    show_default=False,
+)
+# TODO: add documentation link
+ObjectAttributesArgument = typer.Argument(
+    None,
+    help="""Object attributes provided as a list of key=value pairs,
+for example name=my_db comment='created with Snowflake CLI'.
+
+Check documentation for the full list of available parameters
+for every object.
+""",
+    show_default=False,
+)
+# TODO: add documentation link
+ObjectDefinitionJsonOption = typer.Option(
+    None,
+    "--json",
+    help="""Object definition in JSON format, for example
+\'{"name": "my_db", "comment": "created with Snowflake CLI"}\'.
+
+Check documentation for the full list of available parameters
+for every object.
+""",
+    show_default=False,
 )
 LikeOption = like_option(
     help_example='`list function --like "my%"` lists all functions that begin with “my”',
@@ -106,3 +130,45 @@ def describe(
     return QueryResult(
         ObjectManager().describe(object_type=object_type, name=object_name)
     )
+
+
+@app.command(name="create", requires_connection=True)
+def create(
+    object_type: str = ObjectArgument,
+    object_attributes: Optional[List[str]] = ObjectAttributesArgument,
+    object_json: str = ObjectDefinitionJsonOption,
+    **options,
+):
+    """
+    Create an object of a given type. Check documentation for the list of supported objects
+    and parameters.
+    """
+    import json
+
+    if object_attributes and object_json:
+        raise ClickException(
+            "Conflict: both object attributes and JSON definition are provided"
+        )
+
+    if object_json:
+        object_data = json.loads(object_json)
+    elif object_attributes:
+
+        def _parse_if_json(value: str):
+            try:
+                return json.loads(value)
+            except json.JSONDecodeError:
+                return value
+
+        object_data = {
+            v.key: _parse_if_json(v.value)
+            for v in parse_key_value_variables(object_attributes)
+        }
+
+    else:
+        raise ClickException(
+            "Provide either list of object attributes, or object definition in JSON format"
+        )
+
+    result = ObjectManager().create(object_type=object_type, object_data=object_data)
+    return MessageResult(result)

snowflake/cli/plugins/object/manager.py

@@ -14,13 +14,19 @@
 
 from __future__ import annotations
 
-from typing import Optional, Tuple, Union
+from textwrap import dedent
+from typing import Any, Dict, Optional, Tuple, Union
 
 from click import ClickException
-from snowflake.cli.api.constants import OBJECT_TO_NAMES, ObjectNames
+from snowflake.cli.api.constants import (
+    OBJECT_TO_NAMES,
+    ObjectNames,
+)
+from snowflake.cli.api.rest_api import RestApi
 from snowflake.cli.api.sql_execution import SqlExecutionMixin
 from snowflake.connector import ProgrammingError
 from snowflake.connector.cursor import SnowflakeCursor
+from snowflake.connector.errors import BadRequest
 
 
 def _get_object_names(object_type: str) -> ObjectNames:
@@ -30,6 +36,16 @@ def _get_object_names(object_type: str) -> ObjectNames:
     return OBJECT_TO_NAMES[object_type]
 
 
+def _pluralize_object_type(object_type: str) -> str:
+    """
+    Pluralize object type without depending on OBJECT_TO_NAMES.
+    """
+    if object_type.endswith("y"):
+        return object_type[:-1].lower() + "ies"
+    else:
+        return object_type.lower() + "s"
+
+
 class ObjectManager(SqlExecutionMixin):
     def show(
         self,
@@ -47,7 +63,7 @@ class ObjectManager(SqlExecutionMixin):
             query += f" in {scope[0].replace('-', ' ')} {scope[1]}"
         return self._execute_query(query, **kwargs)
 
-    def drop(self, *, object_type, name: str) -> SnowflakeCursor:
+    def drop(self, *, object_type: str, name: str) -> SnowflakeCursor:
         object_name = _get_object_names(object_type).sf_name
         return self._execute_query(f"drop {object_name} {name}")
 
@@ -66,3 +82,28 @@ class ObjectManager(SqlExecutionMixin):
             return True
         except ProgrammingError:
             return False
+
+    def create(self, object_type: str, object_data: Dict[str, Any]) -> str:
+        rest = RestApi(self._conn)
+        url = rest.determine_url_for_create_query(
+            plural_object_type=_pluralize_object_type(object_type)
+        )
+        if not url:
+            return f"Create operation for type {object_type} is not supported. Try using `sql -q 'CREATE ...'` command"
+        try:
+            response = rest.send_rest_request(url=url, method="post", data=object_data)
+            # workaround as SnowflakeRestful class ignores some errors, dropping their info and returns {} instead.
+            if not response:
+                raise ClickException(
+                    dedent(
+                        """                An unexpected error occurred while creating the object. Try again with --debug for more info.
+                Most probable reasons:
+                  * object you are trying to create already exists
+                  * role you are using do not have permissions to create this object"""
+                    )
+                )
+            return response["status"]
+        except BadRequest:
+            raise ClickException(
+                "Incorrect object definition (arguments misspelled or malformatted)."
+            )

snowflake/cli/plugins/snowpark/commands.py

@@ -128,7 +128,7 @@ def deploy(
     By default, if any of the objects exist already the commands will fail unless `--replace` flag is provided.
     All deployed objects use the same artifact which is deployed only once.
     """
-    snowpark = cli_context.project_definition
+    snowpark = cli_context.project_definition.snowpark
     paths = SnowparkPackagePaths.for_snowpark_project(
         project_root=SecurePath(cli_context.project_root),
         snowpark_project_definition=snowpark,
@@ -400,7 +400,7 @@ def build(
         ignore_anaconda = True
     snowpark_paths = SnowparkPackagePaths.for_snowpark_project(
         project_root=SecurePath(cli_context.project_root),
-        snowpark_project_definition=cli_context.project_definition,
+        snowpark_project_definition=cli_context.project_definition.snowpark,
     )
     log.info("Building package using sources from: %s", snowpark_paths.source.path)
 

snowflake/cli/plugins/sql/commands.py

@@ -18,9 +18,9 @@ from pathlib import Path
 from typing import List, Optional
 
 import typer
+from snowflake.cli.api.commands.decorators import with_project_definition
 from snowflake.cli.api.commands.flags import (
     parse_key_value_variables,
-    project_definition_option,
 )
 from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
 from snowflake.cli.api.output.types import CommandResult, MultipleResults, QueryResult
@@ -30,15 +30,8 @@ from snowflake.cli.plugins.sql.manager import SqlManager
 app = SnowTyperFactory()
 
 
-def _parse_key_value(key_value_str: str):
-    parts = key_value_str.split("=")
-    if len(parts) < 2:
-        raise ValueError("Passed key-value pair does not comform with key=value format")
-
-    return parts[0], "=".join(parts[1:])
-
-
 @app.command(name="sql", requires_connection=True, no_args_is_help=True)
+@with_project_definition(is_optional=True)
 def execute_sql(
     query: Optional[str] = typer.Option(
         None,
@@ -69,7 +62,6 @@ 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:
     """

snowflake/cli/plugins/sql/manager.py

@@ -23,7 +23,7 @@ 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.sql_execution import SqlExecutionMixin, VerboseCursor
 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
@@ -87,4 +87,6 @@ class SqlManager(SqlExecutionMixin):
         )
         single_statement = len(statements) == 1
 
-        return single_statement, self._execute_string("\n".join(statements))
+        return single_statement, self._execute_string(
+            "\n".join(statements), cursor_class=VerboseCursor
+        )

snowflake/cli/plugins/stage/commands.py

@@ -21,6 +21,7 @@ from typing import List, Optional
 
 import click
 import typer
+from snowflake.cli.api.cli_global_context import cli_context
 from snowflake.cli.api.commands.flags import (
     OnErrorOption,
     PatternOption,
@@ -30,6 +31,7 @@ from snowflake.cli.api.commands.flags import (
 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.output.formats import OutputFormat
 from snowflake.cli.api.output.types import (
     CollectionResult,
     CommandResult,
@@ -42,7 +44,11 @@ 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.diff import (
+    DiffResult,
+    compute_stage_diff,
+    print_diff_to_console,
+)
 from snowflake.cli.plugins.stage.manager import OnErrorType, StageManager
 
 app = SnowTyperFactory(
@@ -96,6 +102,10 @@ def copy(
         False,
         help="Copy files recursively with directory structure.",
     ),
+    auto_compress: bool = typer.Option(
+        default=False,
+        help="Specifies whether Snowflake uses gzip to compress files during upload. Ignored when downloading.",
+    ),
     **options,
 ) -> CommandResult:
     """
@@ -127,6 +137,7 @@ def copy(
         destination_path=destination_path,
         parallel=parallel,
         overwrite=overwrite,
+        auto_compress=auto_compress,
     )
 
 
@@ -168,12 +179,18 @@ def stage_diff(
         show_default=False,
     ),
     **options,
-) -> ObjectResult:
+) -> Optional[CommandResult]:
     """
     Diffs a stage with a local folder.
     """
-    diff: DiffResult = compute_stage_diff(Path(folder_name), stage_name)
-    return ObjectResult(str(diff))
+    diff: DiffResult = compute_stage_diff(
+        local_root=Path(folder_name), stage_fqn=stage_name
+    )
+    if cli_context.output_format == OutputFormat.JSON:
+        return ObjectResult(diff.to_dict())
+    else:
+        print_diff_to_console(diff)
+        return None  # don't print any output
 
 
 @app.command("execute", requires_connection=True)
@@ -226,6 +243,7 @@ def _put(
     destination_path: str,
     parallel: int,
     overwrite: bool,
+    auto_compress: bool,
 ):
     if recursive:
         raise click.ClickException("Recursive flag for upload is not supported.")
@@ -238,5 +256,6 @@ def _put(
         stage_path=destination_path,
         overwrite=overwrite,
         parallel=parallel,
+        auto_compress=auto_compress,
     )
     return QueryResult(cursor)

snowflake/cli/plugins/stage/diff.py

@@ -19,12 +19,14 @@ import logging
 import re
 from dataclasses import dataclass, field
 from pathlib import Path, PurePosixPath
-from typing import Collection, Dict, List, Optional
+from typing import Collection, Dict, List, Optional, Tuple
 
+from snowflake.cli.api.console import cli_console as cc
 from snowflake.cli.api.exceptions import (
     SnowflakeSQLExecutionError,
 )
 from snowflake.cli.api.secure_path import UNLIMITED, SecurePath
+from snowflake.cli.plugins.nativeapp.artifacts import BundleMap
 from snowflake.connector.cursor import DictCursor
 
 from .manager import StageManager
@@ -62,56 +64,12 @@ class DiffResult:
             or len(self.only_on_stage) > 0
         )
 
-    def __str__(self) -> str:
-        """
-        Method override for the standard behavior of string representation for this class.
-        """
-        components: List[
-            str
-        ] = (
-            []
-        )  # py3.8 does not support subscriptions for builtin list, hence using List
-
-        # The specific order of conditionals is for an aesthetically pleasing output and ease of readability.
-        if not self.only_local:
-            components.append(
-                "There are no new files that exist only in your local directory."
-            )
-        if not self.only_on_stage:
-            components.append("There are no new files that exist only on the stage.")
-        if not self.different:
-            components.append(
-                "There are no existing files that have been modified, or their status is unknown."
-            )
-        if not self.identical:
-            components.append(
-                "There are no existing files that are identical to the ones on the stage."
-            )
-
-        if self.only_local:
-            components.extend(
-                ["New files only on your local:", *[str(p) for p in self.only_local]]
-            )
-        if self.only_on_stage:
-            components.extend(
-                ["New files only on the stage:", *[str(p) for p in self.only_on_stage]]
-            )
-        if self.different:
-            components.extend(
-                [
-                    "Existing files modified or status unknown:",
-                    *[str(p) for p in self.different],
-                ]
-            )
-        if self.identical:
-            components.extend(
-                [
-                    "Existing files identical to the stage:",
-                    *[str(p) for p in self.identical],
-                ]
-            )
-
-        return "\n".join(components)
+    def to_dict(self) -> dict:
+        return {
+            "modified": [str(p) for p in sorted(self.different)],
+            "added": [str(p) for p in sorted(self.only_local)],
+            "deleted": [str(p) for p in sorted(self.only_on_stage)],
+        }
 
 
 def is_valid_md5sum(checksum: str) -> bool:
@@ -331,3 +289,75 @@ def sync_local_diff_with_stage(
         # Could be ProgrammingError or IntegrityError from SnowflakeCursor
         log.error(err)
         raise SnowflakeSQLExecutionError()
+
+
+def _to_src_dest_pair(
+    stage_path: StagePath, bundle_map: Optional[BundleMap]
+) -> Tuple[Optional[str], str]:
+    if not bundle_map:
+        return None, str(stage_path)
+
+    dest_path = to_local_path(stage_path)
+    src = bundle_map.to_project_path(dest_path)
+    if src:
+        return str(src), str(stage_path)
+
+    return "?", str(stage_path)
+
+
+def _to_diff_line(status: str, src: Optional[str], dest: str) -> str:
+    if src is None:
+        src_prefix = ""
+    else:
+        src_prefix = f"{src} -> "
+
+    longest_status = "modified"
+    padding = " " * (len(longest_status) - len(status))
+    status_prefix = f"[red]{status}[/red]: {padding}"
+
+    return f"{status_prefix}{src_prefix}{dest}"
+
+
+def print_diff_to_console(
+    diff: DiffResult,
+    bundle_map: Optional[BundleMap] = None,
+):
+    if not diff.has_changes():
+        cc.message("Your stage is up-to-date with your local deploy root.")
+        return
+
+    blank_line_needed = False
+    if diff.only_local or diff.different:
+        cc.message("Local changes to be deployed:")
+        messages_to_output = []
+        for p in diff.different:
+            src_dest_pair = _to_src_dest_pair(p, bundle_map)
+            messages_to_output.append(
+                (
+                    src_dest_pair,
+                    _to_diff_line("modified", src_dest_pair[0], src_dest_pair[1]),
+                )
+            )
+        for p in diff.only_local:
+            src_dest_pair = _to_src_dest_pair(p, bundle_map)
+            messages_to_output.append(
+                (
+                    src_dest_pair,
+                    _to_diff_line("added", src_dest_pair[0], src_dest_pair[1]),
+                )
+            )
+
+        with cc.indented():
+            for key, message in sorted(messages_to_output, key=lambda pair: pair[0]):
+                cc.message(message)
+
+        blank_line_needed = True
+
+    if diff.only_on_stage:
+        if blank_line_needed:
+            cc.message("")
+        cc.message(f"Deleted paths to be removed from your stage:")
+        with cc.indented():
+            for p in sorted(diff.only_on_stage):
+                diff_line = _to_diff_line("deleted", src=None, dest=str(p))
+                cc.message(diff_line)

snowflake/cli/plugins/stage/manager.py

@@ -161,6 +161,7 @@ class StageManager(SqlExecutionMixin):
         parallel: int = 4,
         overwrite: bool = False,
         role: Optional[str] = None,
+        auto_compress: bool = False,
     ) -> SnowflakeCursor:
         """
         This method will take a file path from the user's system and put it into a Snowflake stage,
@@ -174,7 +175,7 @@ class StageManager(SqlExecutionMixin):
             log.info("Uploading %s to %s", local_resolved_path, stage_path)
             cursor = self._execute_query(
                 f"put {self._to_uri(local_resolved_path)} {self.quote_stage_name(stage_path)} "
-                f"auto_compress=false parallel={parallel} overwrite={overwrite}"
+                f"auto_compress={str(auto_compress).lower()} parallel={parallel} overwrite={overwrite}"
             )
         return cursor
 

snowflake/cli/plugins/streamlit/commands.py

@@ -122,7 +122,7 @@ def streamlit_deploy(
     environment.yml and any other pages or folders, if present. If you don’t specify a stage name, the `streamlit`
     stage is used. If the specified stage does not exist, the command creates it.
     """
-    streamlit: Streamlit = cli_context.project_definition
+    streamlit: Streamlit = cli_context.project_definition.streamlit
     if not streamlit:
         return MessageResult("No streamlit were specified in project definition.")
 
@@ -149,6 +149,7 @@ def streamlit_deploy(
         replace=replace,
         query_warehouse=streamlit.query_warehouse,
         additional_source_files=streamlit.additional_source_files,
+        title=streamlit.title,
         **options,
     )
 

snowflake/cli/plugins/streamlit/manager.py

@@ -78,6 +78,7 @@ class StreamlitManager(SqlExecutionMixin):
         experimental: Optional[bool] = None,
         query_warehouse: Optional[str] = None,
         from_stage_name: Optional[str] = None,
+        title: Optional[str] = None,
     ):
         query = []
         if replace:
@@ -98,6 +99,8 @@ class StreamlitManager(SqlExecutionMixin):
 
         if query_warehouse:
             query.append(f"QUERY_WAREHOUSE = {query_warehouse}")
+        if title:
+            query.append(f"TITLE = '{title}'")
 
         self._execute_query("\n".join(query))
 
@@ -111,6 +114,7 @@ class StreamlitManager(SqlExecutionMixin):
         query_warehouse: Optional[str] = None,
         replace: Optional[bool] = False,
         additional_source_files: Optional[List[str]] = None,
+        title: Optional[str] = None,
         **options,
     ):
         # for backwards compatibility - quoted stage path might be case-sensitive
@@ -134,6 +138,7 @@ class StreamlitManager(SqlExecutionMixin):
                 replace=replace,
                 query_warehouse=query_warehouse,
                 experimental=True,
+                title=title,
             )
             try:
                 self._execute_query(f"ALTER streamlit {fully_qualified_name} CHECKOUT")
@@ -187,6 +192,7 @@ class StreamlitManager(SqlExecutionMixin):
                 query_warehouse=query_warehouse,
                 from_stage_name=root_location,
                 experimental=False,
+                title=title,
             )
 
         return self.get_url(fully_qualified_name)

{snowflake_cli_labs-2.5.0rc3.dist-info → snowflake_cli_labs-2.6.0.dev0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: snowflake-cli-labs
-Version: 2.5.0rc3
+Version: 2.6.0.dev0
 Summary: Snowflake CLI
 Project-URL: Source code, https://github.com/snowflakedb/snowflake-cli
 Project-URL: Bug Tracker, https://github.com/snowflakedb/snowflake-cli/issues
@@ -207,7 +207,7 @@ License:                                  Apache License
            See the License for the specific language governing permissions and
            limitations under the License.
 License-File: LICENSE
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Information Technology
@@ -222,19 +222,19 @@ Requires-Dist: jinja2==3.1.4
 Requires-Dist: packaging
 Requires-Dist: pip
 Requires-Dist: pluggy==1.5.0
-Requires-Dist: pydantic==2.7.3
+Requires-Dist: pydantic==2.8.0
 Requires-Dist: pyyaml==6.0.1
 Requires-Dist: requests==2.32.3
 Requires-Dist: requirements-parser==0.9.0
 Requires-Dist: rich==13.7.1
-Requires-Dist: setuptools==70.0.0
-Requires-Dist: snowflake-connector-python[secure-local-storage]==3.10.1
+Requires-Dist: setuptools==70.1.1
+Requires-Dist: snowflake-connector-python[secure-local-storage]==3.11.0
 Requires-Dist: snowflake-core==0.8.0; python_version < '3.12'
 Requires-Dist: tomlkit==0.12.5
 Requires-Dist: typer==0.12.3
-Requires-Dist: urllib3<2.3,>=1.21.1
+Requires-Dist: urllib3<2.3,>=1.24.3
 Provides-Extra: development
-Requires-Dist: coverage==7.5.3; extra == 'development'
+Requires-Dist: coverage==7.5.4; extra == 'development'
 Requires-Dist: pre-commit>=3.5.0; extra == 'development'
 Requires-Dist: pytest-randomly==3.15.0; extra == 'development'
 Requires-Dist: pytest==8.2.2; extra == 'development'
@@ -270,7 +270,13 @@ Snowflake CLI is an open-source command-line tool explicitly designed for develo
 With Snowflake CLI, developers can create, manage, update, and view apps running on Snowflake across workloads such as Streamlit in Snowflake, the Snowflake Native App Framework, Snowpark Container Services, and Snowpark. It supports a range of Snowflake features, including user-defined functions, stored procedures, Streamlit in Snowflake, and SQL execution.
 
 
-**Note**: Snowflake CLI is in Public Preview (PuPr). Docs at https://docs.snowflake.com/en/developer-guide/snowflake-cli-v2/index
+**Note**: Snowflake CLI is in Public Preview (PuPr).
+
+Docs: https://docs.snowflake.com/en/developer-guide/snowflake-cli-v2/index.
+
+Quick start: https://quickstarts.snowflake.com/guide/getting-started-with-snowflake-cli
+
+Cheatsheet: https://github.com/Snowflake-Labs/sf-cheatsheets/blob/main/snowflake-cli.md
 
 
 ## Install Snowflake CLI
@@ -289,7 +295,7 @@ snow --help
 Requires [Homebrew](https://brew.sh/).
 
 ```bash
-brew tap Snowflake-Labs/snowflake-cli
+brew tap snowflakedb/snowflake-cli
 brew install snowflake-cli
 snow --help
 ```