Load Yjs data to DuckDB

Yhub is a server implementation for Yjs that provides REST endpoints for reading, updating, and querying the history of Yjs documents. Everything needed to build a working Yjs → DuckDB pipeline is on this page: the API's base URL, authentication, endpoints, pagination and incremental field — plus a prompt that hands the whole job to your coding agent.

---

Build your Yjs to DuckDB pipeline

Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.

PromptCopy prompt
Run uvx dlthub-init@latest to build a pipeline from Yjs to DuckDB and run it on dltHub

That scaffolds a dltHub workspace and installs the dltHub AI harness — the project rules, the secrets-management skill, and the dlt MCP server your agent needs to work safely. From there it reads the Yjs API, proposes the endpoints to load, then writes, runs and validates the pipeline while you review rather than type. Credentials are inspected through MCP tools, so your agent never reads secrets.toml itself. How the LLM-native workflow works →

Prefer to write it yourself? Every fact the agent uses is below.

---

Yjs API at a glance

These values come from the Yjs API reference — the authoritative source if anything here looks out of date.

---

How do I authenticate with the Yjs API?

All endpoints require an auth-cookie, which is checked via the configured PERM CALLBACK mechanism.

1. Get your credentials

Yjs is a protocol, not a hosted service. However, providers (like Liveblocks) that offer Yjs-compatible REST APIs manage authentication via their respective dashboards. To obtain credentials for such services: 1. Log in to your provider's dashboard (e.g., liveblocks.io/dashboard). 2. Navigate to the 'API Keys' section (often under 'Settings' or 'Developers'). 3. Generate or copy your 'Secret Key'. Note: Self-hosted solutions like 'yhub' manage authentication via custom implemented auth servers (e.g., using JWTs) and environment variables rather than a dashboard-managed API key.

2. Add them to .dlt/secrets.toml

Copy
[sources.yjs_source]
liveblocks_api_key = "sk_prod_xxxxxxxxxxxxxxxxxxxxxxxx"

dlt reads this file automatically at runtime. With the harness, the setup-secrets skill prompts you for the values and never handles the raw credential in chat. For production, see setting up credentials with dlt.

---

What Yjs data can I load into DuckDB?

These are the Yjs endpoints dlt can load into DuckDB:

---

How do I load only new Yjs records?

The Yjs API reference does not document a timestamp or sequence field for these endpoints, so there is nothing to advertise here as verified. Pick a field from the endpoints table above that increases with every write, then set it as the cursor_path.

Copy
{"name": "documents", "endpoint": {
    "path": "api/documents",
    # Replace with a field that increases on every write.
    "incremental": {"cursor_path": "REPLACE_ME", "initial_value": "2024-01-01T00:00:00Z"},
}}

On the first run dlt loads everything from initial_value; on every run after that it requests only what changed and appends with write_disposition="merge" if you set a primary key. See incremental loading.

---

What does the generated Yjs pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading /rooms/{roomId}/ydoc and /rooms/{roomId}/ydoc-binary from the Yjs API into DuckDB:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def yjs_source(auth_cookie=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "/ydoc/{org}/{docid}",
            "auth": {"type": "api_key", "api_key": auth_cookie, "name": "auth-cookie", "location": "header"},
        },
        "resources": [
            {"name": "documents", "endpoint": {"path": "api/documents"}},
            {"name": "document", "endpoint": {"path": "api/documents/:identifier"}}
        ],
    }
    yield from rest_api_resources(config)


def load_yjs_to_duckdb() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="yjs_pipeline",
        destination="duckdb",
        dataset_name="yjs_data",
    )
    load_info = pipeline.run(yjs_source())
    print(load_info)


if __name__ == "__main__":
    load_yjs_to_duckdb()

Run it with python yjs_pipeline.py. The agent iterates on this until it loads cleanly — you review and approve, rather than write it from scratch.

---

How do I query Yjs data in DuckDB?

dlt creates one table per resource. Query the loaded data with Python or SQL — or ask your agent to, through the MCP server's execute_sql_query tool.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("yjs_pipeline").dataset()
df = data.documents.df()
print(df.head())

SQL:

Copy
SELECT * FROM yjs_data.documents LIMIT 10;

See querying your data with dataset and exploring it in marimo notebooks.

---

How do I deploy the Yjs to DuckDB pipeline in production?

The pipeline runs locally, which is ideal for prototyping and one-off analysis. When you need it on a schedule, monitored on every load, and shared with your team, deploy the same dlt code on the dltHub platform — no infrastructure to maintain. The prompt above already ends with "run it on dltHub", so your agent can take it there directly.

• Deploy & schedule — run the pipeline as a managed job with automatic retries.
• Monitor — observable job queues, alerting, and load metrics for every run.
• Transform — promote raw Yjs loads into governed, documented models.
• Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.

Book a demo →

---

What other destinations can I load Yjs data to?

dlt loads into any of these — only the destination argument changes:

Set dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. On the dltHub platform the same pipeline runs against a managed Iceberg lakehouse. See the full destinations list.

---

Next steps

• Ready for production? Book a demo of the dltHub platform →
• dlt LLM-native workflow docs
• REST API source reference
• Join the dlt community on Slack