管理 Snowflake 对象¶

snow object 命令可为您提供管理大多数 Snowflake 对象（如暂存区、Snowpark 功能或 Streamlit 应用程序）的便捷方法。您可以使用这些命令来执行常见任务，而不是针对每种类型的对象使用单独的命令，包括以下任务：

创建特定类型的对象
列出指定类型的可用对象。
显示对象的描述。
删除对象。

要查看支持的类型列表，请使用任何 snow object 命令的 --help 选项，例如以下命令：

snow object list --help

Usage: snow object list [OPTIONS] OBJECT_TYPE

Lists all available Snowflake objects of given type.
Supported types: compute-pool, database, function, image-repository, integration, network-rule,
procedure, role, schema, secret, service, stage, stream, streamlit, table, task,
user, view, warehouse

...

对象子命令可让您执行常见操作，而特定服务命令组则专门用于特定服务操作。

创建特定类型的对象¶

snow object create 命令会使用以下语法根据提供的定义创建指定对象：

snow object create TYPE ([OBJECT_ATTRIBUTES]|[--json {OBJECT_DEFINITION}])

其中：

TYPE 是一种 Snowflake 对象类型：
- account
- catalog-integration
- compute-pool
- database
- database-role
- dynamic-table
- event-table
- external-volume
- function
- image-repository
- managed-account
- network-policy
- notebook
- notification-integration
- pipe
- procedure
- role
- schema
- service
- stage
- stream
- table
- task
- user-defined-function
- view
- warehouse

OBJECT_ATTRIBUTES 包含以 <key>=<value> 对列表形式的对象定义，例如：
```
snow object create database name=my_db comment="Created with Snowflake CLI"
```
--json {OBJECT_DEFINITION} 包含 JSON 中的对象定义，例如：
```
snow object create database --json '{"name":"my_db", "comment":"Created with Snowflake CLI"}'
```

备注

以下对象类型需要在连接配置中标识数据库，例如 config.toml，或使用 --database 选项传递给命令。

image-repository
schema
service
table
task

使用 option-attributes 参数创建数据库对象：

snow object create database name=my_db comment='Created with Snowflake CLI'

使用 option-attributes 参数创建表对象：

snow object create table name=my_table columns='[{"name":"col1","datatype":"number", "nullable":false}]' constraints='[{"name":"prim_key", "column_names":["col1"], "constraint_type":"PRIMARY KEY"}]' --database my_db --schema public

使用 --json object-definition 选项创建数据库：

snow object create database --json '{"name":"my_db", "comment":"Created with Snowflake CLI"}'

使用 --json object-definition 选项创建表：

snow object create table --json "$(cat table.json)" --database my_db

其中 table.json 包含以下内容：

{
  "name": "my_table",
  "columns": [
    {
      "name": "col1",
      "datatype": "number",
      "nullable": false
    }
  ],
  "constraints": [
    {
      "name": "prim_key",
      "column_names": ["col1"],
      "constraint_type": "PRIMARY KEY"
    }
  ]
}

列出特定类型的所有对象¶

snow object list 命令可列出所有具有您的权限的给定类型对象。

snow object list TYPE

其中：TYPE 是对象的类型。使用 snow object list --help 以获取受支持类型的完整列表。

要列出所有角色对象，请输入以下命令：

snow object list role

+--------------------------------------------------------------------------------------------------------------------------------+
|            |            |            |            | is_inherit | assigned_t | granted_to | granted_ro |            |           |
| created_on | name       | is_default | is_current | ed         | o_users    | _roles     | les        | owner      | comment   |
|------------+------------+------------+------------+------------+------------+------------+------------+------------+-----------|
| 2023-07-24 | ACCOUNTADM | N          | N          | N          | 2          | 0          | 2          |            | Account   |
| 06:05:49-0 | IN         |            |            |            |            |            |            |            | administr |
| 7:00       |            |            |            |            |            |            |            |            | ator can  |
|            |            |            |            |            |            |            |            |            | manage    |
|            |            |            |            |            |            |            |            |            | all       |
|            |            |            |            |            |            |            |            |            | aspects   |
|            |            |            |            |            |            |            |            |            | of the    |
|            |            |            |            |            |            |            |            |            | account.  |
| 2023-07-24 | PUBLIC     | N          | N          | Y          | 0          | 0          | 0          |            | Public    |
| 06:05:48.9 |            |            |            |            |            |            |            |            | role is   |
| 56000-07:0 |            |            |            |            |            |            |            |            | automatic |
| 0          |            |            |            |            |            |            |            |            | ally      |
|            |            |            |            |            |            |            |            |            | available |
|            |            |            |            |            |            |            |            |            | to every  |
|            |            |            |            |            |            |            |            |            | user in   |
|            |            |            |            |            |            |            |            |            | the       |
|            |            |            |            |            |            |            |            |            | account.  |
| 2023-07-24 | SYSADMIN   | N          | N          | N          | 0          | 1          | 0          |            | System    |
| 06:05:49.0 |            |            |            |            |            |            |            |            | administr |
| 33000-07:0 |            |            |            |            |            |            |            |            | ator can  |
| 0          |            |            |            |            |            |            |            |            | create    |
|            |            |            |            |            |            |            |            |            | and       |
|            |            |            |            |            |            |            |            |            | manage    |
|            |            |            |            |            |            |            |            |            | databases |
|            |            |            |            |            |            |            |            |            | and       |
|            |            |            |            |            |            |            |            |            | warehouse |
|            |            |            |            |            |            |            |            |            | s.        |
| 2023-07-24 | USERADMIN  | N          | N          | N          | 0          | 1          | 0          |            | User      |
| 06:05:49.0 |            |            |            |            |            |            |            |            | administr |
| 45000-07:0 |            |            |            |            |            |            |            |            | ator can  |
| 0          |            |            |            |            |            |            |            |            | create    |
|            |            |            |            |            |            |            |            |            | and       |
|            |            |            |            |            |            |            |            |            | manage    |
|            |            |            |            |            |            |            |            |            | users and |
|            |            |            |            |            |            |            |            |            | roles     |
+--------------------------------------------------------------------------------------------------------------------------------+

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

要仅列出以字符串 public 开头的角色对象，请输入以下命令：

snow object list role --like public%

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

显示指定类型对象的描述¶

snow object describe 命令提供对给定类型的对象的描述。

snow object describe TYPE IDENTIFIER

其中：

TYPE 是对象的类型。使用 snow object describe --help 以获取受支持类型的完整列表。
IDENTIFIER 是对象的名称。对于过程和函数，标识符必须指定实参类型，例如 "hello(int,string)"。

要描述函数对象，请输入类似于以下内容的命令：

snow object describe function "hello_function(string)"

describe function hello_function(string)
+---------------------------------------------------------------------
| property           | value
|--------------------+------------------------------------------------
| signature          | (NAME VARCHAR)
| returns            | VARCHAR(16777216)
| language           | PYTHON
| null handling      | CALLED ON NULL INPUT
| volatility         | VOLATILE
| body               | None
| imports            |
| handler            | functions.hello_function
| runtime_version    | 3.9
| packages           | ['snowflake-snowpark-python']
| installed_packages | ['_libgcc_mutex==0.1','_openmp_mutex==5.1',...
+---------------------------------------------------------------------

删除指定类型的对象¶

snow object drop 命令会删除给定名称和类型的 Snowflake 对象。

snow object drop TYPE IDENTIFIER

其中：

TYPE 是对象的类型。使用 snow object drop --help 以获取受支持类型的完整列表。
IDENTIFIER 是对象的名称。对于过程和函数，标识符必须指定实参类型，例如 "hello(int,string)"。

要删除过程，请输入类似于以下内容的命令：

snow object drop procedure "test_procedure()"

drop procedure test_procedure()
+--------------------------------------+
| status                               |
|--------------------------------------|
| TEST_PROCEDURE successfully dropped. |
+--------------------------------------+