Configure a catalog #
Before you can connect to your data sources with Starburst Enterprise platform (SEP) you
must define them in a catalog. Each catalog connects to a single data source,
such as a specific instance of a PostgreSQL or Oracle database. Catalogs are
defined in your Helm chart under the
catalogs: node, or if you are not using
our K8s deployment, in its own properties file the
etc/catalog directory of
The name of the catalog YAML entry or catalog file becomes the name used to access the data in a query. There is a small set of required properties for every catalog. While properties can vary, they minimally define the connection to the data source. Depending on your data source type, there are a number of different configuration properties available.
This document teaches you how to create a minimum catalog configuration.
Gather your connection information #
You will need the following minimum information to connect to a data source:
- Connection URL
Create your catalog properties #
The catalog properties file content consists of
key=value pairs. Every catalog
must include the
connector.name property, and the
connector name must match
the data source.
values.yaml file in your K8s deployment, you must create a catalog
entry under the
catalogs: top-level node. The following example assumes that
salesdata catalog resides in a PostgreSQL database:
catalogs: salesdata: |- connector.name=postgresql connection-url=jdbc:postgresql://example.net:5432/database connection-user=root connection-password=secret
If you are not using K8s, you must create the minimum content
for a PostgreSQL catalog file. In the following example, the contents are
connector.name=postgresql connection-url=jdbc:postgresql://example.net:5432/database connection-user=root connection-password=secret
Apply changes #
To use the a newly-defined catalog, you must restart SEP for the changes to take effect. Refer to the documentation for your deployment type for restart instructions.
Next steps #
To learn more about catalogs and connectors in SEP:
- Read our data engineering guide to creating catalogs.
- Familiarize yourself with the available SEP connectors
Is the information on this page helpful?