Tabular Catalog

This article describes how to create a connection to your Tabular Catalog using a SQL command.

In order to create and work with tables within Upsolver, you first need to establish a connection with a metadata store such as Tabular.io.

Syntax

CREATE TABULAR CONNECTION 
    <connection_identifier> 
    TOKEN = '<token>'
    WAREHOUSE = '<warehouse>'
    DEFAULT_STORAGE_CONNECTION = <identifier>
    DEFAULT_STORAGE_LOCATION = 's3://<bucket>/<folder-path>/'
    [ DATABASE_DISPLAY_FILTER[S] = { '<database_name>' | ('<database_name>' [, ...]) } ]
    [ COMMENT = '<comment>' ] 

Jump to

• TOKEN

• WAREHOUSE

• DEFAULT_STORAGE_CONNECTION

• DEFAULT_STORAGE_LOCATION

• DATABASE_DISPLAY_FILTER[S]

• COMMENT

Connection options

TOKEN

Type: text

Credentials of you Tabular account.

WAREHOUSE

Type: text

The name of the warehouse in Tabular to be used for managing the Iceberg Tables.

DEFAULT_STORAGE_CONNECTION

Type: identifier

An Amazon S3 connection with the appropriate credentials to write to the DEFAULT_STORAGE_LOCATION provided.

DEFAULT_STORAGE_LOCATION

Type: text

The Amazon S3 path that serves as the default storage location for the underlying files associated with tables created under this metastore connection.

DATABASE_DISPLAY_FILTER[S] — editable

Type: text | list

(Optional) A single database or the list of databases to show. If left empty, all databases are visible.

COMMENT — editable

Type: text

(Optional) A description or comment regarding this connection.

Minimum example

CREATE TABULAR CONNECTION my_tabular_connection
    TOKEN = '...'
    WAREHOUSE = '...'
    DEFAULT_STORAGE_CONNECTION = my_s3_storage_connection
    DEFAULT_STORAGE_LOCATION = 's3://sqlake/my_tabular_catalog_table_files/';

This example uses the default credentials from Upsolver's integration with AWS.

See: Deploying Upsolver on AWS

Additionally, this example assumes that you have created the Amazon S3 connection my_s3_storage_connection with proper write permissions to the specified storage location.

Refer to Amazon S3 for more information on creating a connection using SQL.

Full example

CREATE TABULAR CONNECTION my_tabular_connection
    TOKEN = '...'
    WAREHOUSE = '...'
    DEFAULT_STORAGE_CONNECTION = my_s3_storage_connection
    DEFAULT_STORAGE_LOCATION = 's3://sqlake/my_tabular_catalog_table_files/'
    DATABASE_DISPLAY_FILTERS = ('demo_db', 'prod_db')
    COMMENT = 'tabular catalog connection example';