본문으로 건너뛰기
최종 수정: 에

Paimon JDBC Catalog

This document describes the supported parameters when connecting to and accessing Paimon Catalog metadata services using the JDBC interface through the CREATE CATALOG statement.

Note

This is an experimental feature, supported since version 4.1.0.

Parameter Overview​

Property NameDescriptionDefault ValueRequired
paimon.jdbc.uriSpecifies the JDBC connection URI-Yes
paimon.jdbc.userJDBC connection username-Yes
paimon.jdbc.passwordJDBC connection password-Yes
warehouseSpecifies the Paimon warehouse-Yes
paimon.jdbc.driver_classJDBC driver class name, such as org.postgresql.Driver, com.mysql.cj.jdbc.Driver, etc.-No
paimon.jdbc.driver_urlPath to JDBC driver JAR file-No

Note:

  1. Paimon JDBC Catalog supports various relational databases as backend storage, including PostgreSQL, MySQL, etc.

  2. Ensure the JDBC driver JAR file is accessible. You can specify the driver location via paimon.jdbc.driver_url.

Since 4.1.5, creating or altering a Catalog validates JDBC driver locations consistently. A value without a URI scheme must be a file name matching [A-Za-z0-9._-]+.jar; use file:///... for an absolute path. The URL-decoded path must not contain a .. parent-directory segment. Existing secure driver-path and URL allowlist restrictions still apply.

Example Configurations​

PostgreSQL as Metadata Storage​

Using PostgreSQL database to store Paimon metadata:

CREATE CATALOG paimon_jdbc_postgresql PROPERTIES (
    'type' = 'paimon',
    'paimon.catalog.type' = 'jdbc',
    'paimon.jdbc.uri' = 'jdbc:postgresql://127.0.0.1:5432/paimon_db',
    'paimon.jdbc.user' = 'paimon_user',
    'paimon.jdbc.password' = 'password',
    'paimon.jdbc.driver_class' = 'org.postgresql.Driver',
    'paimon.jdbc.driver_url' = '<jdbc_driver_jar>',
    'warehouse' = 's3://bucket/warehouse',
    's3.access_key' = '<ak>',
    's3.secret_key' = '<sk>',
    's3.endpoint' = 'https://s3.us-east-1.amazonaws.com',
    's3.region' = 'us-east-1'
);

MySQL as Metadata Storage​

Using MySQL database to store Paimon metadata:

CREATE CATALOG paimon_jdbc_mysql PROPERTIES (
    'type' = 'paimon',
    'paimon.catalog.type' = 'jdbc',
    'paimon.jdbc.uri' = 'jdbc:mysql://127.0.0.1:3306/paimon_db',
    'paimon.jdbc.user' = 'paimon_user',
    'paimon.jdbc.password' = 'password',
    'paimon.jdbc.driver_class' = 'com.mysql.cj.jdbc.Driver',
    'paimon.jdbc.driver_url' = '<jdbc_driver_jar>',
    'warehouse' = 's3://bucket/warehouse',
    's3.access_key' = '<ak>',
    's3.secret_key' = '<sk>',
    's3.endpoint' = 'https://s3.us-east-1.amazonaws.com',
    's3.region' = 'us-east-1'
);
Report issue