Skip to main content
Version: Next

MySQL Catalog Connector

Connect to a MySQL database as a catalog provider for federated SQL query. The MySQL Catalog Connector automatically discovers schemas and tables within a MySQL server and makes them available for querying in Spice.

For connecting to individual MySQL tables, see the MySQL Data Connector documentation.

Configuration​

catalogs:
  - from: mysql
    name: my_mysql
    include:
      - 'my_database.*' # include all tables from my_database
    params:
      mysql_connection_string: mysql://${secrets:MYSQL_USER}:${secrets:MYSQL_PASS}@localhost:3306/my_database

from​

The from field specifies the catalog provider. For MySQL, use mysql.

name​

The name field specifies the name of the catalog in Spice. Tables from the MySQL server will be available under this catalog name. The schema hierarchy of the MySQL server is preserved in Spice.

include​

Use the include field to specify which tables to include from the catalog. The include field supports glob patterns to match multiple tables. For example, *.my_table_name would include all tables with the name my_table_name from any schema. Multiple include patterns are OR'ed together.

params​

Connection can be configured using a connection string or individual parameters.

Connection string​

Parameter NameDescription
mysql_connection_stringA MySQL connection string. E.g. mysql://user:password@host:port/dbname.

Individual parameters​

Parameter NameDescription
mysql_hostThe MySQL host address. Default: localhost.
mysql_tcp_portThe MySQL port number. Default: 3306.
mysql_dbThe MySQL database name.
mysql_userThe MySQL username for authentication.
mysql_passThe MySQL password for authentication.
mysql_sslmodeThe SSL mode for the connection (disabled, required, or preferred). Default: required.
mysql_sslrootcertPath to the SSL root certificate file.

Authentication​

Connection string​

catalogs:
  - from: mysql
    name: my_mysql
    params:
      mysql_connection_string: mysql://${secrets:MYSQL_USER}:${secrets:MYSQL_PASS}@localhost:3306/my_database

Individual parameters​

catalogs:
  - from: mysql
    name: my_mysql
    params:
      mysql_host: localhost
      mysql_tcp_port: '3306'
      mysql_db: my_database
      mysql_user: ${secrets:MYSQL_USER}
      mysql_pass: ${secrets:MYSQL_PASS}
      mysql_sslmode: required

Secrets​

Spice integrates with multiple secret stores to help manage sensitive data securely. For detailed information on supported secret stores, refer to the secret stores documentation. Additionally, learn how to use referenced secrets in component parameters by visiting the using referenced secrets guide.