Connect with SQL

curl --request POST https://api.rafflesia.ai/v1/sql-credentials \
  --header "Authorization: Bearer $RAFFLESIA_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"name":"research notebook"}'

{
  "object": "sql_connection",
  "dialect": "clickhouse",
  "endpoint": "https://example.clickhouse.cloud:8443",
  "default_database": "rafflesia_catalog",
  "catalog_database": "rafflesia_catalog",
  "contract_version": "2026-08-04"
}

export RAFFLESIA_SQL_ENDPOINT='https://example.clickhouse.cloud:8443'
export RAFFLESIA_SQL_USERNAME='sqlcred_...'
export RAFFLESIA_SQL_PASSWORD='...'

SELECT * FROM rafflesia_catalog.service;
SELECT * FROM rafflesia_catalog.databases ORDER BY database;
SELECT * FROM rafflesia_catalog.releases ORDER BY database, published_at DESC;
SELECT * FROM rafflesia_catalog.relation_releases
ORDER BY database, release, relation;
SELECT * FROM rafflesia_catalog.current_relations
ORDER BY database, relation;

pip install clickhouse-connect

import os
from urllib.parse import urlparse
import clickhouse_connect

endpoint = urlparse(os.environ["RAFFLESIA_SQL_ENDPOINT"])
client = clickhouse_connect.get_client(
    host=endpoint.hostname,
    port=endpoint.port or 8443,
    username=os.environ["RAFFLESIA_SQL_USERNAME"],
    password=os.environ["RAFFLESIA_SQL_PASSWORD"],
    database="rafflesia_catalog",
    secure=endpoint.scheme == "https",
)

releases = client.query("""
    SELECT database, release, relation, sql_backing, row_count
    FROM relation_releases
    ORDER BY database, release, relation
""")
print(releases.result_rows)

curl --user "$RAFFLESIA_SQL_USERNAME:$RAFFLESIA_SQL_PASSWORD" \
  "$RAFFLESIA_SQL_ENDPOINT/?database=rafflesia_catalog" \
  --data-binary 'SELECT * FROM relation_releases FORMAT JSONEachRow'

[project]
dialect = "clickhouse"

[connectors.rafflesia]
driver = "rafflesia"
dsn_env = "RAFFLESIA_DSN"

export RAFFLESIA_DSN="https://${RAFFLESIA_SQL_USERNAME}:${RAFFLESIA_SQL_PASSWORD}@${RAFFLESIA_SQL_ENDPOINT#https://}/rafflesia_catalog"
requel catalogpin --connector rafflesia
requel execute queries/proteins.rql --params '{}'