Catalog parameters
You specify the catalog configuration in theWITH
clause of a CREATE SOURCE
, CREATE SINK
, or CREATE CONNECTION
statement.
Parameter | Description |
---|---|
catalog.type | The type of catalog. Supported values: 'storage' , 'rest' , 'hive' , 'jdbc' , 'glue' , and 'snowflake' . Defaults to 'storage' if not specified. |
catalog.uri | The URI for the catalog service. Required for rest , hive , jdbc , and snowflake catalog types. |
catalog.name | A user-defined name for the catalog. Required for all types except storage . |
hosted_catalog | Set to true when using a hosted catalog with an internal Iceberg table. See Hosted Iceberg catalogs. |
catalog.jdbc.user | Username for the JDBC catalog. |
catalog.jdbc.password | Password for the JDBC catalog. |
catalog.credential | Credentials for the REST catalog’s OAuth2 flow. |
catalog.token | A bearer token for the REST catalog. |
catalog.oauth2_server_uri | The token endpoint URI for the REST catalog’s OAuth2 flow. |
catalog.scope | The OAuth2 scope for the REST catalog. |
Hosted catalogs
A hosted catalog is a built-in service managed by RisingWave that simplifies the setup for internal Iceberg tables by removing the need to manage an external catalog. This is the recommended approach for getting started. For a complete guide, see Hosted Iceberg catalogs.External catalogs
External catalogs are required when you need to connect to Iceberg tables that are managed by other systems. RisingWave supports several types of external catalogs.Glue catalog
Integrates with AWS Glue Data Catalog.JDBC catalog
Stores metadata in a relational database like PostgreSQL.REST catalog
Uses a RESTful API to manage table metadata.Amazon S3 Tables
Amazon S3 Tables is an AWS-native Iceberg catalog service that uses the REST protocol with AWS SigV4 authentication. To connect, you usecatalog.type = 'rest'
and provide additional parameters for authentication.
Required REST parameters for S3 Tables:
Parameter | Description | Value for S3 Tables |
---|---|---|
catalog.uri | The S3 Tables REST endpoint for your region. | https://s3tables.<your-region>.amazonaws.com/iceberg |
catalog.rest.signing_region | The AWS region for signing requests. | e.g., us-east-1 |
catalog.rest.signing_name | The service name for signing requests. | s3tables |
catalog.rest.sigv4_enabled | Enables SigV4 signing. Must be true . | true |
CREATE SINK
with S3 Tables: