Tool to create a new Unity Catalog connection to external data sources. Use when you need to establish connections to databases and services such as MySQL, PostgreSQL, Snowflake, etc. Requires metastore admin privileges or CREATE CONNECTION privilege on the metastore.
nameRequiredstringName of the connection. This is the unique identifier for the connection within the metastore
commentstringUser-provided free-form text description of the connection
optionsRequiredobjectA map of key-value properties containing connection-type specific parameters needed to establish the connection. Property keys must be unique and are case-sensitive. Required options vary by connection type: HTTP requires 'host' and 'bearer_token'; MYSQL requires 'host', 'port',…
read_onlybooleanIf true, the connection is read-only and cannot be used for write operations
propertiesobjectA map of key-value properties attached to the securable object for custom metadata
connection_typeRequiredstringThe type of connection to create. Must be one of the supported connection types
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.