You can use a SQL Server catalog to configure access to a SQL Server or compatible database in the following deployments:
Amazon RDS on Amazon Web Services:
Azure SQL Database on Microsoft Azure:
SQL Server on Google Cloud:
Follow these steps to begin creating a catalog for SQL Server:
On the Select a data source pane, click the SQL Server icon.
The Cloud provider configuration is necessary to allow Starburst Galaxy to correctly match catalogs and clusters.
The data source configured in a catalog, and the cluster must operate in the same cloud provider and region for performance and cost reasons.
The Catalog name is visible in the query editor and other clients. It is used to identify the catalog when writing SQL or showing the catalog and its nested schemas and tables in client applications.
The name is displayed in the query editor, and in the output of a SHOW
CATALOGS command. It is used to fully
qualify the name of any table in SQL queries following the
catalogname.schemaname.tablename syntax. For example, you can run the
following query in the sample cluster without first setting the catalog or
SELECT * FROM tpch.sf1.nation;.
The Description is a short, optional paragraph that provides further details about the catalog. It appears in the Starburst Galaxy user interface and can help other users determine what data can be accessed with the catalog.
The connection to the database requires username and password authentication and details to connect to the database server, typically hostname or IP address and port. The following sections detail the setup for the supported cloud providers.
A connection to the database can be established directly, if the Starburst Galaxy IP range/CIDR is allowed to connect.
If the database is only accessible inside the virtual private cloud (VPC) of the cloud provider, you can use an SSH tunnel with a bastion host in the VPC.
Starburst Galaxy supports AWS PrivateLink for SQL Server catalogs.
To configure the connection to your database on Amazon RDS you must provide the following details:
The database on Amazon RDS needs to fulfill the following requirements:
Database authentication set to Password authentication.
The database on Azure Database needs to fulfill the following requirements:
The database on Cloud SQL needs to fulfill the following requirements from the Connection security section of the Settings for the database:
Configure the database on Google Cloud SQL by filling in the following required fields:
The database on Google Cloud SQL must fulfill the following requirements:
Once you have configured the connection details, click Test connection to confirm data access is working. If the test is successful, you can save the catalog.
If the test fails, look over your entries in the configuration fields, correct any errors, and try again. If the test continues to fail, Galaxy provides diagnostic information that you can use to fix the data source configuration in the cloud provider system.
Click Connect catalog, and proceed to set permissions where you can grant access to certain roles.
This optional step allows you to configure read-only access or full read and write access to the catalog.
Use the following steps to assign read-only access to all roles:
You can specify read-only access and read-write access separately for different sets of roles. That is, one set of roles can get full read and write access to all schemas, tables, and views in the catalog, while another set of roles gets read-only access.
Use the following steps to assign read/write access to some or all roles:
You can add your catalog to a cluster later by editing a cluster. Click Skip to proceed to the catalogs page.
Use the following steps to add your catalog to an existing cluster or create a new cluster in the same cloud region:
Click Add to cluster to view your new catalog’s configuration.
The Pending changes to clusters dialog appears when you try to add a catalog to a running cluster.
On the Clusters page, click the Update icon beside the running cluster, to add the catalog.
The catalog provides read access and write access to data and metadata in SQL Server. It supports the following features:
The following sections provide SQL Server catalog-specific information regarding SQL support.
WHERE clause is specified, the
DELETE operation only works if the
predicate in the clause can be fully pushed down to the data source.
The catalog does not support renaming tables across multiple schemas. For example, the following statement is supported:
ALTER TABLE catalog.schema_one.table_one RENAME TO catalog.schema_one.table_two
The following statement attempts to rename a table across schemas, and therefore is not supported:
ALTER TABLE catalog.schema_one.table_one RENAME TO catalog.schema_two.table_two
The catalog supports renaming a schema with the
ALTER SCHEMA RENAME
ALTER SCHEMA SET AUTHORIZATION is not supported.
The catalog includes the following performance improvement:
The catalog is able to read data from SQL Server using multiple parallel connections for tables partitioned as described in the SQL Server partitioning documentation.
set session sqlserver.parallel_connections_count session
enable parallelism in your catalog and to set the number of splits for tables
with a large number of partitions. Setting an integer limits the number of
connections. The default value of 1 disables parallelism.
set session catalogName.parallel_connections_count = 3
Is the information on this page helpful?
Is the information on this page helpful?