Skip to main content

RisingWave setup

Vendor-supported plugin

Certain core functionality may vary. If you would like to report a bug, request a feature, or contribute, you can check out the linked repository and open an issue.

  • Maintained by: RisingWave
  • Authors: Dylan Chen
  • GitHub repo: risingwavelabs/dbt-risingwave
  • PyPI package: dbt-risingwave
  • Slack channel: N/A
  • Supported dbt Core version: v1.6.1 and newer
  • dbt Cloud support: Not Supported
  • Minimum data platform version:

Installing dbt-risingwave

Use pip to install the adapter. Before 1.8, installing the adapter would automatically install dbt-core and any additional dependencies. Beginning in 1.8, installing an adapter does not automatically install dbt-core. This is because adapters and dbt Core versions have been decoupled from each other so we no longer want to overwrite existing dbt-core installations. Use the following command for installation:

Configuring dbt-risingwave

For RisingWave-specific configuration, please refer to RisingWave configs.

Connecting to RisingWave with dbt-risingwave​

Before connecting to RisingWave, ensure that RisingWave is installed and running. For more information about how to get RisingWave up and running, see the RisingWave quick start guide.

To connect to RisingWave with dbt, you need to add a RisingWave profile to your dbt profile file (~/.dbt/profiles.yml). Below is an example RisingWave profile. Revise the field values when necessary.

~/.dbt/profiles.yml
default:
  outputs:
    dev:
      type: risingwave
      host: [host name] 
      user: [user name]
      pass: [password]
      dbname: [database name]
      port: [port]
      schema: [dbt schema]
  target: dev
FieldDescription
hostThe host name or IP address of the RisingWave instance
userThe RisingWave database user you want to use
passThe password of the database user
dbnameThe RisingWave database name
portThe port number that RisingWave listens on
schemaThe schema of the RisingWave database

To test the connection to RisingWave, run:

dbt debug

Materializations​

The dbt models for managing data transformations in RisingWave are similar to typical dbt SQL models. In the dbt-risingwave adapter, we have customized some of the materializations to align with the streaming data processing model of RisingWave.

MaterializationsSupportedNotes
tableYesCreates a table. To use this materialization, add {{ config(materialized='table') }} to your model SQL files.
viewYesCreates a view. To use this materialization, add {{ config(materialized='view') }} to your model SQL files.
ephemeralYesThis materialization uses common table expressions in RisingWave under the hood. To use this materialization, add {{ config(materialized='ephemeral') }} to your model SQL files.
materializedviewTo be deprecated.It is available only for backward compatibility purposes (for v1.5.1 of the dbt-risingwave adapter plugin). If you are using v1.6.0 and later versions of the dbt-risingwave adapter plugin, use materialized_view instead.
materialized_viewYesCreates a materialized view. This materialization corresponds the incremental one in dbt. To use this materialization, add {{ config(materialized='materialized_view') }} to your model SQL files.
incrementalNoPlease use materialized_view instead. Since RisingWave is designed to use materialized view to manage data transformation in an incremental way, you can just use the materialized_view materialization.
sourceYesCreates a source. To use this materialization, add {{ config(materialized='source') }} to your model SQL files. You need to provide your create source statement as a whole in this model. See Example model files for details.
table_with_connectorYesCreates a table with connector settings. In RisingWave, a table with connector settings is similar to a source. The difference is that a table object with connector settings persists raw streaming data in the source, while a source object does not. To use this materialization, add {{ config(materialized='table_with_connector') }} to your model SQL files. You need to provide your create table with connector statement as a whole in this model (see Example model files for details). Because dbt tables have their own semantics, RisingWave use table_with_connector to distinguish itself from a dbt table.
sinkYesCreates a sink. To use this materialization, add {{ config(materialized='sink') }} to your SQL files. You need to provide your create sink statement as a whole in this model. See Example model files for details.

Resources​

0
Edit this page