USE CATALOG Statement¶
Important
Confluent Cloud for Apache Flink®️ is currently available for Preview. A Preview feature is a Confluent Cloud component that is being introduced to gain early feedback from developers. Preview features can be used for evaluation and non-production testing purposes or to provide feedback to Confluent. The warranty, SLA, and Support Services provisions of your agreement with Confluent do not apply to Preview features. Confluent may discontinue providing Preview releases of the Preview features at any time in Confluent’s sole discretion. Check out Getting Help for questions, feedback and requests.
For Flink SQL features and limitations in the preview program, see Notable Limitations in Public Preview.
Confluent Cloud for Apache Flink®️ enables setting the active environment with the SQL USE statement.
Syntax¶
USE CATALOG catalog_name;
Description¶
Set the current catalog (Confluent Cloud environment). All subsequent commands that
don’t specify a catalog use catalog_name.
Flink interprets your Confluent Cloud environments as catalogs. Flink can access various databases (Kafka clusters) in a catalog.
The catalog_name parameter is case-sensitive.
The default current catalog is named default.
If catalog_name doesn’t exist, Flink SQL throws an exception on the next
DML or DDL statement.
Important
USE CATALOG is a client-side setting statement and sets corresponding properties that are attached to future requests.
By itself, a USE CATALOG statement is a no-op. To see its effect, you must follow it with one or more DML or DDL statements, for example:
-- Set the current catalog (environment).
USE CATALOG my_env;
-- Set the current database (Kafka cluster).
USE cluster_0;
-- Submit a DDL statement.
SELECT * FROM my_table;
Use the USE DATABASE statement to set the current Flink database (Kafka cluster).
USE CATALOG in Cloud Console workspaces¶
When you run the USE CATALOG statement in a Cloud Console workspace, it sets the catalog that will be used in any subsequent CREATE statement requests for the specific editor cell. Different cells can use different catalogs within the same workspace.
The catalog parameter is unquoted, for example, USE CATALOG catalog1;.
Any USE statements within an editor cell take precedence over the settings in the workspace’s global catalog and database dropdown controls.