Rename --data to --variables in snow sql (#1054)

snowflakedb · May 10, 2024 · c426153 · c426153
1 parent 6e5f8b2
commit c426153
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 3 deletions.
diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
@@ -5,7 +5,19 @@
 ## Deprecations
 
 ## New additions
-* `snow sql` command supports now client-side templating of queries.
+
+## Fixes and improvements
+
+
+# v2.3.0
+
+## Backward incompatibility
+
+## Deprecations
+
+## New additions
+* New `snow sql` functionality:
+ * `-D/--variable` allows variable substitutions in a SQL input (client-side query templating)
 * New `snow app deploy` functionality:
  * Passing files and directories as arguments syncs these only: `snow app deploy some-file some-dir`.
  * `--recursive` syncs all files and subdirectories recursively.

diff --git a/src/snowflake/cli/plugins/sql/commands.py b/src/snowflake/cli/plugins/sql/commands.py
@@ -45,7 +45,7 @@ def execute_sql(
  ),
  data_override: List[str] = typer.Option(
  None,
- "--data",
+ "--variable",
  "-D",
  help="String in format of key=value. If provided the SQL content will "
  "be treated as template and rendered using provided data.",

diff --git a/tests/__snapshots__/test_help_messages.ambr b/tests/__snapshots__/test_help_messages.ambr
@@ -5083,7 +5083,7 @@
  │ --filename -f FILE File to execute. [default: None] │
  │ --stdin -i Read the query from standard input. Use it when │
  │ piping input to this command. │
- │ --data  -D TEXT String in format of key=value. If provided the SQL │
+ │ --variable -D TEXT String in format of key=value. If provided the SQL │
  │ content will be treated as template and rendered │
  │ using provided data. │
  │ [default: None] │