snow app validate¶

验证已部署的 Snowflake Native App 的安装脚本。

语法¶

snow app validate
  --package-entity-id <package_entity_id>
  --app-entity-id <app_entity_id>
  --project <project_definition>
  --env <env_overrides>
  --connection <connection>
  --host <host>
  --port <port>
  --account <account>
  --user <user>
  --password <password>
  --authenticator <authenticator>
  --private-key-file <private_key_file>
  --token-file-path <token_file_path>
  --database <database>
  --schema <schema>
  --role <role>
  --warehouse <warehouse>
  --temporary-connection
  --mfa-passcode <mfa_passcode>
  --enable-diag
  --diag-log-path <diag_log_path>
  --diag-allowlist-path <diag_allowlist_path>
  --format <format>
  --verbose
  --debug
  --silent

Copy

实参¶

无

选项¶

--package-entity-id TEXT: 当 definition_version 为 2 或更高时，要操作的包实体的 ID。
--app-entity-id TEXT: 当 definition_version 为 2 或更高时，要操作的应用程序实体的 ID。
-p, --project TEXT: Snowflake 项目所在的路径。默认为当前工作目录。
--env TEXT: key=value 格式的字符串。覆盖用于模板的 env 部分的变量。默认值：[]。
--connection, -c, --environment TEXT: 连接名称，如您在 config.toml 文件中所定义。默认值：default。
--host TEXT: 连接的主机地址。替换为连接指定的值。
--port INTEGER: 连接的端口。替换为连接指定的值。
--account, --accountname TEXT: 分配给 Snowflake 账户的名称。替换为连接指定的值。
--user, --username TEXT: 连接到 Snowflake 的用户名。替换为连接指定的值。
--password TEXT: Snowflake 密码。替换为连接指定的值。
--authenticator TEXT: Snowflake 身份验证器。替换为连接指定的值。
--private-key-file, --private-key-path TEXT: Snowflake 私钥文件路径。替换为连接指定的值。
--token-file-path TEXT: 连接到 Snowflake 时应使用的带有 OAuth 令牌的文件路径。
--database, --dbname TEXT: 要使用的数据库。替换为连接指定的值。
--schema, --schemaname TEXT: 要使用的数据库架构。替换为连接指定的值。
--role, --rolename TEXT: 要使用的角色。替换为连接指定的值。
--warehouse TEXT: 要使用的仓库。替换为连接指定的值。
--temporary-connection, -x: 使用用命令行参数定义的连接，而不是在配置中定义的连接。默认值：False。
--mfa-passcode TEXT: 用于多重身份验证的令牌 (MFA)。
--enable-diag: 运行 Python 连接器诊断测试。默认值：False。
--diag-log-path TEXT: 诊断报告路径。默认：<temporary_directory>。
--diag-allowlist-path TEXT: 可选允许列表的诊断报告路径。
--format [TABLE|JSON]: 指定输出格式。默认：TABLE。
--verbose, -v: 显示日志级别 info 及更高级别的日志条目。默认值：False。
--debug: 显示日志级别 debug 及更高级别的日志条目；调试日志包含其他信息。默认值：False。
--silent: 关闭到控制台的中间输出。默认值：False。

--help: 显示此命令的帮助文本。

使用说明¶

为了避免影响应用程序源暂存区中的文件，此命令使用 应用程序包 实体的 scratch_stage 来创建空白暂存区、将项目文件上传到此暂存区、运行验证以及删除该暂存区。

验证会分别返回错误和警告。错误会导致命令退出，退出代码为 1，但警告不会。

示例¶

以下示例显示了成功验证的输出：

snow app validate

Copy

Validating Snowflake Native App setup script.
  Checking if stage st_version_pkg_<user>.app_src.stage_snowflake_cli_scratch exists, or creating a new one if none exists.
  Performing a diff between the Snowflake stage and your local deploy_root ('<APP_PATH>/apps/st-version/output/deploy') directory.
  There are no new files that exist only on the stage.
There are no existing files that have been modified, or their status is unknown.
There are no existing files that are identical to the ones on the stage.
New files only on your local:
README.md
manifest.yml
setup_script.sql
streamlit/environment.yml
streamlit/ui.py
  Uploading diff-ed files from your local <APP_PATH>/apps/st-version/output/deploy directory to the Snowflake stage.
  Dropping stage st_version_pkg_<user>.app_src.stage_snowflake_cli_scratch.
Snowflake Native App validation succeeded.

以下示例显示了成功验证的输出，该输出使用 JSON 输出格式：

snow app validate --format json

Copy

{
    "errors": [],
    "warnings": [],
    "status": "SUCCESS"
}

以下示例显示了验证遇到错误和警告时的输出，该输出使用 JSON 输出格式：

snow app validate --format json

Copy

{
    "errors": [
        {
            "message": "Error in file '@STAGE_SNOWFLAKE_CLI_SCRATCH/empty.sql': Empty SQL statement.",
            "cause": "Empty SQL statement.",
            "errorCode": "000900",
            "fileName": "@STAGE_SNOWFLAKE_CLI_SCRATCH/empty.sql",
            "line": -1,
            "column": -1
        },
        {
            "message": "Error in file '@STAGE_SNOWFLAKE_CLI_SCRATCH/second.sql': Unsupported feature 'CREATE VERSIONED SCHEMA without OR ALTER'.",
            "cause": "Unsupported feature 'CREATE VERSIONED SCHEMA without OR ALTER'.",
            "errorCode": "000002",
            "fileName": "@STAGE_SNOWFLAKE_CLI_SCRATCH/second.sql",
            "line": -1,
            "column": -1
        },
        {
            "message": "Error in file '@STAGE_SNOWFLAKE_CLI_SCRATCH/setup_script.sql': File '/does-not-exist.sql' cannot be found in the same stage as the setup script is located.",
            "cause": "File '/does-not-exist.sql' cannot be found in the same stage as the setup script is located.",
            "errorCode": "093159",
            "fileName": "@STAGE_SNOWFLAKE_CLI_SCRATCH/setup_script.sql",
            "line": -1,
            "column": -1
        }
    ],
    "warnings": [
        {
            "message": "Warning in file '@STAGE_SNOWFLAKE_CLI_SCRATCH/setup_script.sql' on line 11 at position 35: APPLICATION ROLE should be created with IF NOT EXISTS.",
            "cause": "APPLICATION ROLE should be created with IF NOT EXISTS.",
            "errorCode": "093352",
            "fileName": "@STAGE_SNOWFLAKE_CLI_SCRATCH/setup_script.sql",
            "line": 11,
            "column": 35
        },
        {
            "message": "Warning in file '@STAGE_SNOWFLAKE_CLI_SCRATCH/setup_script.sql' on line 15 at position 13: CREATE Table statement in the setup script should have \"IF NOT EXISTS\", \"OR REPLACE\", or \"OR ALTER\".",
            "cause": "CREATE Table statement in the setup script should have \"IF NOT EXISTS\", \"OR REPLACE\", or \"OR ALTER\".",
            "errorCode": "093351",
            "fileName": "@STAGE_SNOWFLAKE_CLI_SCRATCH/setup_script.sql",
            "line": 15,
            "column": 13
        },
        {
            "message": "Warning in file '@STAGE_SNOWFLAKE_CLI_SCRATCH/setup_script.sql' on line 15 at position 13: Table identifier 'MY_TABLE' should include its parent schema name.",
            "cause": "Table identifier 'MY_TABLE' should include its parent schema name.",
            "errorCode": "093353",
            "fileName": "@STAGE_SNOWFLAKE_CLI_SCRATCH/setup_script.sql",
            "line": 15,
            "column": 13
        }
    ],
    "status": "FAIL"
}