snow dcm 预览版¶

语法¶

snow dcm preview
  <identifier>
  --object <object_identifier>
  --from <from_location>
  --variable <variables>
  --limit <limit>
  --target <target>
  --connection <connection>
  --host <host>
  --port <port>
  --account <account>
  --user <user>
  --password <password>
  --authenticator <authenticator>
  --workload-identity-provider <workload_identity_provider>
  --private-key-file <private_key_file>
  --token <token>
  --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>
  --oauth-client-id <oauth_client_id>
  --oauth-client-secret <oauth_client_secret>
  --oauth-authorization-url <oauth_authorization_url>
  --oauth-token-request-url <oauth_token_request_url>
  --oauth-redirect-uri <oauth_redirect_uri>
  --oauth-scope <oauth_scope>
  --oauth-disable-pkce
  --oauth-enable-refresh-tokens
  --oauth-enable-single-use-refresh-tokens
  --client-store-temporary-credential
  --format <format>
  --verbose
  --debug
  --silent
  --enhanced-exit-codes
  --decimal-precision <decimal_precision>

实参¶

identifier

DCM 项目的标识符。示例：MY_DB.MY_SCHEMA.MY_PROJECT。支持完全限定名称（推荐）或简单名称。如果未限定，则默认为连接的数据库和架构。如果在清单中定义了 --target 或 default_target，则为可选。

选项¶

--object TEXT

要预览的表/视图/动态表的 FQN。

--from PATH

包含 DCM 项目文件的本地目录路径。省略则可使用当前目录。

--variable, -D TEXT

执行上下文的变量；例如：-D "<key>=<value>"。

--limit INTEGER

要返回的最大行数。

--target TEXT

从 manifest.yml 中获取要使用的目标配置。如果未指定，则使用 default_target。

--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 身份验证器。替换为连接指定的值。

--workload-identity-provider TEXT

工作负载身份提供商（AWS、AZURE、GCP、OIDC）。替换为连接指定的值。

--private-key-file, --private-key-path TEXT

Snowflake 私钥文件路径。替换为连接指定的值。

--token TEXT

连接到 Snowflake 时使用的 OAuth 令牌。

--token-file-path TEXT

连接到 Snowflake 时使用的带有 OAuth 令牌的文件路径。

--database, --dbname TEXT

要使用的数据库。替换为连接指定的值。

--schema, --schemaname TEXT

要使用的数据库架构。替换为连接指定的值。

--role, --rolename TEXT

要使用的角色。替换为连接指定的值。

--warehouse TEXT

要使用的仓库。替换为连接指定的值。

--temporary-connection, -x

使用命令行参数定义的连接，而不是在配置中定义的连接。默认值：None。False。

--mfa-passcode TEXT

用于多重身份验证的令牌 (MFA)。

--enable-diag

是否生成连接诊断报告。默认值：False。

--diag-log-path TEXT

生成的报告的路径。默认为系统临时目录。默认：<system_temporary_directory>。

--diag-allowlist-path TEXT

包含允许列表参数的 JSON 文件的路径。

--oauth-client-id TEXT

身份提供商为 Snowflake 集成提供的客户端 ID 的值。

--oauth-client-secret TEXT

身份提供商为 Snowflake 集成提供的客户端密钥的值。

--oauth-authorization-url TEXT

向驱动程序提供授权码的身份提供商端点。

--oauth-token-request-url TEXT

向驱动程序提供访问令牌的身份提供商端点。

--oauth-redirect-uri TEXT

URI 用于授权码重定向。

--oauth-scope TEXT

身份提供商授权请求中请求的范围。

--oauth-disable-pkce

禁用代码交换证明密钥 (PKCE)。默认值：False。

--oauth-enable-refresh-tokens

在实际访问令牌过期时启用静默重新身份验证。默认值：False。

--oauth-enable-single-use-refresh-tokens

是否选择启用一次性刷新令牌语义。默认值：False。

--client-store-temporary-credential

存储临时凭据。

--format [TABLE|JSON| JSON_EXT|CSV]

指定输出格式。默认：TABLE。

--verbose, -v

显示日志级别 info 及更高级别的日志条目。默认值：False。

--debug

显示日志级别 debug 及更高级别的日志条目；调试日志包含其他信息。默认值：False。

--silent

关闭到控制台的中间输出。默认值：False。

--enhanced-exit-codes

根据错误类型区分退出错误代码。默认值：False。

--decimal-precision INTEGER

小数值要显示的小数位数。如果未指定，则使用 Python 的默认精度。[环境变量：SNOWFLAKE_DECIMAL_PRECISION]。

--help

显示此命令的帮助文本。

使用说明¶

snow dcm preview 命令可返回 DCM project 对象中定义的任何表、视图或动态表中的行。此命令适用于：

• 在部署前测试您的定义

• 在部署后验证数据

• 预览引用模板化表名的视图

--object 选项为必填项，用于指定要预览的 DCM project 对象的完全限定名称。您可以使用 --limit 选项来限制返回的行数。

示例¶

• 预览 DCM project 对象中名为 MY_DB.PUBLIC.MY_TABLE 的表中的数据，其中项目名称在清单中的 default_target 属性中指定：

  CopyExpand

  snow dcm preview --object MY_DB.PUBLIC.MY_TABLE
  

  Show lessSee more

  Scroll to top

• 预览数据，其中项目名称在清单中的 DEV target 中指定：

  CopyExpand

  snow dcm preview --target DEV --object MY_DB.PUBLIC.MY_TABLE
  

  Show lessSee more

  Scroll to top

• 使用显式的完全限定名称预览 DCM project 项目对象中的数据：

  CopyExpand

  snow dcm preview MY_DB.MY_SCHEMA.MY_PROJECT --object MY_DB.PUBLIC.MY_TABLE
  

  Show lessSee more

  Scroll to top

• 带行数限制的预览：

  CopyExpand

  snow dcm preview --object MY_DB.PUBLIC.MY_VIEW --limit 10
  

  Show lessSee more

  Scroll to top

• 带变量替换的预览：

  CopyExpand

  snow dcm preview --object MY_DB.PUBLIC.MY_VIEW -D "source_table='MY_DB.PUBLIC.SOURCE'"
  

  Show lessSee more

  Scroll to top