Skip to content

RisingWave

Installation

pip install "toolfront[risingwave]"

Connection Parameters

Connect using the Database.from_risingwave() method with parameters:

from toolfront import Database

db = Database.from_risingwave(
    host="localhost",
    port=5432,
    database="sales",
    user="user",
    password="pass",
    schema="public"
)

revenue = db.ask("What's our total revenue this month?")
PARAMETER DESCRIPTION
host

Hostname.

TYPE: str DEFAULT: None

user

Username.

TYPE: str DEFAULT: None

password

Password.

TYPE: str DEFAULT: None

port

Port number. Default is 5432.

TYPE: int DEFAULT: 5432

database

Database to connect to.

TYPE: str DEFAULT: None

schema

RisingWave schema to use. If None, use the default search_path.

TYPE: str DEFAULT: None

match_schema

Regex pattern to filter schemas. Mutually exclusive with match_tables.

TYPE: str DEFAULT: None

match_tables

Regex pattern to filter tables. Mutually exclusive with match_schema.

TYPE: str DEFAULT: None

**kwargs

Additional arguments passed to the DBAPI connection call.

TYPE: Any DEFAULT: {}