snow object list

列出给定类型的所有可用 Snowflake 对象。 支持的类型：计算池、数据库、外部访问集成、函数、Git 存储库、镜像仓库、集成、网络规则、过程、角色、架构、密钥、服务、暂存区、流、Streamlit、表、任务、用户、视图、仓库

语法

snow object list
  <object_type>
  --like <like>
  --in <scope>
  --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

实参

object_type

对象类型。例如表、数据库、计算池。

选项

--like, -l TEXT

SQL LIKE 模式用于按名称筛选对象。例如，list function --like "my%" 会列出了所有名称以“my”开头的函数。默认值：%%。

--in <TEXT TEXT>...

使用“--in <scope> <name>”指定此命令的作用域，例如 list table --in database my_db。一些对象类型具有专门的范围（例如，list service --in compute-pool my_pool）。默认值：(None, None)。

--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

显示此命令的帮助文本。

使用说明

--like [-l] < 模式 > 选项允许您指定按名称筛选对象的 SQL LIKE 模式。例如，snow object list function --like "my%" 会列出所有以 my 开头的函数。有关 SQL 模式语法的更多信息，请参阅 SQL LIKE 关键字 (https://www.w3schools.com/sql/sql_ref_like.asp)。

示例

以下示例列出了所有以 public 开头的角色。--like 选项

snow object list role --like public%
Copy
show roles like 'public%'
+-------------------------------------------------------------------------------
| created_on                       | name        | is_default | is_current | ...
|----------------------------------+-------------+------------+------------+----
| 2023-02-01 15:25:04.105000-08:00 | PUBLIC      | N          | N          | ...
| 2024-01-15 12:55:05.840000-08:00 | PUBLIC_TEST | N          | N          | ...
+-------------------------------------------------------------------------------
语言: 中文