Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Note
This information applies to Databricks CLI versions 0.205 and above. The Databricks CLI is in Public Preview.
Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.
The online-tables
command group within the Databricks CLI allows you to create, online tables, which provide lower latency and higher QPS access to data from Delta tables.
databricks online-tables create
Create a new online table.
databricks online-tables create [flags]
Options
--json JSON
The inline JSON string or the @path to the JSON file with the request body
--name string
Full three-part (catalog, schema, table) name of the table.
--no-wait
Do not wait to reach ACTIVE
state
--timeout duration
Maximum amount of time to reach ACTIVE
state (default 20ms)
Examples
The following example creates an online table:
databricks online-tables create --name main.my_schema.my_table
The following example creates an online table without waiting for it to reach ACTIVE
state:
databricks online-tables create --name main.my_schema.my_table --no-wait
databricks online-tables delete
Delete an online table.
Important
This will delete all the data in the online table. If the source Delta table was deleted or modified since this online table was created, this will lose the data forever.
databricks online-tables delete NAME [flags]
Arguments
NAME
Full three-part (catalog, schema, table) name of the table.
Options
Examples
The following example deletes an online table:
databricks online-tables delete main.my_schema.my_table
databricks online-tables get
Get information about an existing online table and its status.
databricks online-tables get NAME [flags]
Arguments
NAME
Full three-part (catalog, schema, table) name of the table.
Options
Examples
The following example gets information about an online table:
databricks online-tables get main.my_schema.my_table
Global flags
--debug
Whether to enable debug logging.
-h
or --help
Display help for the Databricks CLI or the related command group or the related command.
--log-file
string
A string representing the file to write output logs to. If this flag is not specified then the default is to write output logs to stderr.
--log-format
format
The log format type, text
or json
. The default value is text
.
--log-level
string
A string representing the log format level. If not specified then the log format level is disabled.
-o, --output
type
The command output type, text
or json
. The default value is text
.
-p, --profile
string
The name of the profile in the ~/.databrickscfg
file to use to run the command. If this flag is not specified then if it exists, the profile named DEFAULT
is used.
--progress-format
format
The format to display progress logs: default
, append
, inplace
, or json
-t, --target
string
If applicable, the bundle target to use