DuckDB

Run analytical SQL queries with embedded DuckDB.

Data and storageNo credentials1 actionAll integrations

On this page

Connect
Call it from a workflow
Actions (1)
createAndQueryDB
Details

Connect

Auth type: No credentials (none). Nothing to connect: the actions run without credentials.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("duckdb", "createAndQueryDB", {
    "tables": [],
    "query": "<query>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("DuckDB answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "duckdb-createandquerydb",
  name: "DuckDB: Create and Query DB",
  description: "Calls DuckDB when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("duckdb", {
      "action": "createAndQueryDB",
      "tables": [],
      "query": "<query>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/duckdb/createAndQueryDB" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"tables":[],"query":"<query>"}}'

Actions

createAndQueryDBin catalog

Create and Query DB. Create DB from data and run query

Input	Type	Description
`tables`required	array	List of tables to create in the database
`query`required	text	Please use $1, $2, etc. for parameterized queries to avoid SQL injection.
`args`optional	array	Arguments to be used in the query

Details

Id: duckdb
Category: Data and storage
Tags: database, sql, analytics, embedded, olap
Package: @activepieces/piece-duckdb@0.0.5
Tier: Community