snow object create¶

语法¶

snow object create
  <object_type>
  <object_attributes>
  --json <object_json>
  --if-not-exists
  --replace
  --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

实参¶

object_type

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

object_attributes...

对象属性以键值对列表的形式提供，例如 name=my_db comment='created with Snowflake CLI'。 检查文档以获取每个对象可用参数的完整列表。

选项¶

--json TEXT

对象定义的格式为 JSON，例如 '{"name": "my_db", "comment": "created with Snowflake CLI"}'。 检查文档以获取每个对象可用参数的完整列表。

--if-not-exists

仅当指定的对象尚不存在时才应用此操作。默认值：False。

--replace

如果此对象已存在，请将其替换。默认值：False。

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

显示此命令的帮助文本。

使用说明¶

snow object create 命令会根据提供的对象属性或定义创建以下类型的 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"
  

  Copy

• 使用 --json object_definition 选项将对象详细信息指定为 JSON，例如：

  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
  

  Copy

• 有关更多示例，请参阅 示例。

以下部分描述了 Snowflake CLI 支持的所选对象类型的属性。

• 计算池

• 数据库

• 镜像仓库

• 架构

• 服务

• 表

• 任务

• 仓库

您可以通过检查相应的 SQL CREATE 命令引用来查找其他类型对象的属性，例如 CREATE ACCOUNT。

示例¶

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

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

  Copy

• 使用 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
  

  Copy

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

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

  Copy

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

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

  Copy

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

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

  Copy