CREATE OPENFLOW RUNTIME¶

See also:

ALTER OPENFLOW RUNTIME, DROP OPENFLOW RUNTIME, SHOW OPENFLOW RUNTIMES, DESCRIBE OPENFLOW RUNTIME

Creates a runtime in a gen 2 deployment.

Syntax¶

CREATE OPENFLOW RUNTIME [ IF NOT EXISTS ] [ <database>.<schema>. ]<name>
  IN DEPLOYMENT <deployment_name>
  NODE_TYPE = { SMALL | MEDIUM | LARGE }
  MIN_NODES = <integer>
  MAX_NODES = <integer>
  EXECUTE_AS_ROLE = <role>
  [ EXTERNAL_ACCESS_INTEGRATIONS = ( <eai> [ , <eai> ... ] ) ]
  [ DISPLAY_NAME = <string> ]
  [ COMMENT = <string> ]

Required parameters¶

[ database.schema. ]name

Specifies the identifier for the runtime. Use a fully qualified name or omit database.schema to use the session default. For more information, see Identifier requirements.

IN DEPLOYMENT deployment_name

Gen 2 deployment that hosts this runtime.

NODE_TYPE = { SMALL | MEDIUM | LARGE }

Node size. Cannot be changed after creation.

MIN_NODES = integer

Minimum number of nodes (1–50).

MAX_NODES = integer

Maximum number of nodes (1–50).

EXECUTE_AS_ROLE = role

Role connectors use when reading from and writing to Snowflake. See Create an execute-as role.

Optional parameters¶

IF NOT EXISTS

Creates the runtime only if it does not already exist. If the runtime already exists, the statement does nothing and returns a success message.

EXTERNAL_ACCESS_INTEGRATIONS = ( eai [ , ... ] )

Snowflake deployments only. External access integrations that allow egress to external data sources.

Default: No value

DISPLAY_NAME = string

UI display name. If unset, the SQL name is shown in the Openflow UI.

Default: No value

COMMENT = string

Default: No value

Access control¶

Requires USAGE on the containing database, CREATE OPENFLOW RUNTIME on the target schema (or schema ownership), and USAGE on the parent deployment.

Usage notes¶

• This command returns immediately. Runtime provisioning runs asynchronously and typically takes 3–5 minutes. Use SYSTEM$WAIT_FOR_OPENFLOW_RUNTIME_STATUS or SYSTEM$WAIT_FOR_STABLE_OPENFLOW_RUNTIMES to wait for the runtime to become ACTIVE.
• The optimal node count depends on your connector type and workload. See the setup topic for your connector for recommended values.

Example¶

CREATE OPENFLOW RUNTIME my_db.my_schema.my_runtime
  IN DEPLOYMENT my_deployment
  NODE_TYPE = MEDIUM
  MIN_NODES = 1
  MAX_NODES = 1
  EXECUTE_AS_ROLE = my_execute_as_role
  DISPLAY_NAME = 'My Runtime';