Basin
CloudflareOfficialPublished by Cloudflare
- Skill
- Tool integration
- Data and AI
- Apache-2.0
- No issues found
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
Basin is a suite of tools for ingesting, transforming, and querying data using Apache Iceberg tables stored in Cloudflare R2. It comprises three main components: Basin Pipelines for event ingestion and transformation, Basin Catalog for managing Iceberg metadata and table maintenance, and Basin SQL for performing analytical queries. This skill provides guidance on setting up these components, configuring connections for engines like Spark or Python, and troubleshooting common operational issues.
What it does
- Stream events and transform data rows for delivery to R2 storage.
- Manage Iceberg table metadata, maintenance tasks, and engine access.
- Execute analytical SQL queries against Iceberg tables.
- Configure and authenticate connections for Basin Pipelines, Catalog, and SQL.
- Provide guidance on using Wrangler commands for Basin resource management.
When to use it
- When setting up new data ingestion pipelines that target R2 storage.
- When you need to manage Iceberg table metadata or perform table maintenance.
- When querying large datasets stored in R2 using analytical SQL.
- When migrating from legacy Cloudflare Data Platform or R2 Data Catalog workflows.
Advantages
- Unified management of data ingestion, cataloging, and querying.
- Native integration with Cloudflare R2 and Apache Iceberg standards.
- Supports standard analytical SQL for querying object storage data.
- Provides clear paths for both control-plane administration and engine-specific operations.
Usage examples
- “How do I set up a new Basin Pipeline to ingest events into R2?”
- The agent will guide you through the Basin Pipelines configuration, including defining event transformations and setting up the delivery destination in R2.
- “What are the steps to connect PyIceberg to my Basin Catalog?”
- The agent will provide the necessary configuration steps, including retrieving the Catalog URI and Warehouse name, and setting up the required credentials.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/cloudflare/basin/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip basin.zip -d .agents/skills
Documentation by Cloudflare
Cloudflare Basin
Basin ingests and transforms events, manages Apache Iceberg tables in R2, and queries them with distributed SQL. Start with the Basin overview and retrieve the relevant current docs before implementing changes, especially for limits, pricing, permissions, and CLI syntax. While PR #33850 remains open, use the proposed pages in that PR if the new URLs have not been published.
Rebrand
Cloudflare Data Platform is now Basin. Cloudflare Pipelines, R2 Data Catalog, and R2 SQL are now Basin Pipelines, Basin Catalog, and Basin SQL. Existing resources and configurations continue to work. The prior Wrangler command families also continue to work: wrangler pipelines, wrangler r2 bucket catalog, and wrangler r2 sql. Use the new Basin commands and documentation URLs in new guidance. Legacy API identifiers and metrics names may still use the old terms; check the current docs for deprecation details. The migration is documented in cloudflare-docs PR #33850.
Choose the workflow
| Need | Product | Reference | Current docs |
|---|---|---|---|
| Receive events, transform rows, and deliver to R2 | Basin Pipelines | Pipelines guide | Basin Pipelines |
| Manage Iceberg metadata, table maintenance, and engine access | Basin Catalog | Catalog guide | Basin Catalog |
| Query Iceberg tables with analytical SQL | Basin SQL | SQL guide | Basin SQL |
Typical flow: Basin Pipelines → Basin Catalog tables in R2 → Basin SQL or a compatible external engine. Begin with the Basin getting started guide for an end-to-end setup.
The proposed Wrangler command families are wrangler basin pipelines, wrangler basin catalog, and wrangler basin sql. Basin SQL uses WRANGLER_BASIN_SQL_AUTH_TOKEN; its REST query path is /basin-sql/query/{BUCKET}. Check the installed Wrangler version and current reference pages before running commands because the migration is ongoing.
Skill feedback
If the user reports that this skill gave incorrect or outdated guidance, or is missing information, read references/skill-feedback.md.
Files
- ATTRIBUTION.mdAdded by AutoGineer846 B
- LICENSELicence file added by AutoGineer11.1 KiB
- SKILL.md2.9 KiB
- references/catalog/README.md1.2 KiB
- references/catalog/api.md3.3 KiB
- references/catalog/configuration.md2.1 KiB
- references/catalog/gotchas.md2.2 KiB
- references/catalog/patterns.md1.7 KiB
- references/pipelines/README.md4.5 KiB
- references/pipelines/api.md5.0 KiB
- references/pipelines/configuration.md6.1 KiB
- references/pipelines/gotchas.md3.0 KiB
- references/pipelines/patterns.md4.6 KiB
- references/skill-feedback.md2.7 KiB
- references/sql/README.md3.4 KiB
- references/sql/api.md4.8 KiB
- references/sql/configuration.md1.7 KiB
- references/sql/gotchas.md2.0 KiB
- references/sql/patterns.md4.3 KiB
references/pipelines/README.md
Basin Pipelines
Streaming ingest: receive events over HTTP/Workers/Logpush, transform with SQL, write to R2 as Iceberg tables or Parquet/JSON files.
Documentation
This reference is a fast-start with verified code and gotchas. For limits, settings, full SQL syntax, and pricing, retrieve the live docs — use the Cloudflare MCP docs tool if available, otherwise webfetch the URL. Docs are source of truth over this file.
| Topic | URL |
|---|---|
| Overview / getting started | https://developers.cloudflare.com/basin-pipelines/getting-started/index.md |
| Streams (write, manage, Logpush) | https://developers.cloudflare.com/basin-pipelines/streams/index.md |
| Sinks | https://developers.cloudflare.com/basin-pipelines/sinks/index.md |
| Basin Pipelines & SQL transforms | https://developers.cloudflare.com/basin-pipelines/pipelines/index.md |
| SQL reference (statements, types) | https://developers.cloudflare.com/basin-pipelines/sql-reference/index.md |
| Wrangler commands | https://developers.cloudflare.com/basin-pipelines/reference/wrangler-commands/index.md |
| Terraform | https://developers.cloudflare.com/basin-pipelines/reference/terraform/index.md |
| Limits | https://developers.cloudflare.com/basin-pipelines/platform/limits/index.md |
| Pricing | https://developers.cloudflare.com/basin-pipelines/platform/pricing/index.md |
| Metrics (GraphQL) | https://developers.cloudflare.com/basin-pipelines/observability/metrics/index.md |
Three Components
Sources → Stream → Pipeline (SQL) → Sink → R2
↑ ↓ ↓
HTTP / Workers / Transform Iceberg (Basin Catalog)
Logpush (row-level) or Parquet/JSON files| Component | Purpose |
|---|---|
| Stream | Receives events (HTTP endpoint, Worker binding, or Logpush). Structured (schema-validated) or unstructured. |
| Pipeline | SQL connecting a stream to a sink. Row-level transforms only — no GROUP BY/aggregation. |
| Sink | Writes to R2 — Iceberg via Basin Catalog, or raw Parquet/JSON. |
Status: The linked docs PR proposes Basin general availability. Verify current availability, limits, and pricing in the live docs before making claims or sizing workloads.
Quick Start
# Interactive — creates stream + sink + pipeline, optionally bucket + catalog
npx wrangler basin pipelines setupMinimal Worker producer:
interface Env { MY_STREAM: Pipeline; }
export default {
async fetch(req: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
ctx.waitUntil(env.MY_STREAM.send([{ event_id: crypto.randomUUID(), amount: 29.99 }]));
return new Response("OK");
}
} satisfies ExportedHandler<Env>;Which Sink Type?
Need SQL queries / ACID / time-travel on the data?
→ Basin Catalog (Iceberg) ✅ Basin SQL, schema evolution ❌ more setup
Just archival / external tools (Spark, Athena)?
→ R2 raw files (Parquet/JSON) ✅ simple, partitioned files ❌ no built-in SQLCritical Behaviors (read before building)
These are non-obvious and prevent most failures — see gotchas.md for detail.
Everything is immutable after creation — stream schema, pipeline SQL, sink config. To change, delete and recreate.
Sinks create their own table — they cannot target an existing Iceberg table.
__ingest_tsis added automatically (TIMESTAMP, partitioned by day). Don't define it in your schema.Data isn't queryable immediately — first flush takes 3–7 minutes (warm-up + table creation) even with a short roll interval.
Schema validation is deferred — invalid events are accepted then silently dropped. Monitor via GraphQL error metrics.
Binding field renamed
pipeline→stream(June 2026); old field still accepted.
Reading Order
configuration.md — schema, streams, sinks, pipelines (CLI + REST + Terraform), bindings
api.md —
send(), HTTP ingest, REST API, pipeline SQL, lifecycle statespatterns.md — fire-and-forget, validation, Logpush, observability, end-to-end
gotchas.md — silent drops, immutability, REST≠CLI field names
See Also
Basin Catalog — Iceberg sink destination
Basin SQL — query the ingested data
Requirements and compatibility
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Security
No issues found by our static scan· No issues found
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Published by
- Cloudflare
- Publisher
- Cloudflare (Official)
- Source
- cloudflare/skills · skills/basin · commit 6eb6c78
- Licence
- Apache License 2.0 (redistribution allowed)
- LICENSE (added by AutoGineer from LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by Cloudflare or Cloudflare.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download basin.zip