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/sql/patterns.md
Basin SQL Patterns
Code templates for CLI, REST, and Worker access. For performance/partitioning best practices, pull https://developers.cloudflare.com/basin-sql/reference/limitations-best-practices/index.md.
Wrangler CLI
export WRANGLER_BASIN_SQL_AUTH_TOKEN=$API_TOKEN
npx wrangler basin sql query "${ACCOUNT_ID}_my-bucket" "
SELECT category, COUNT(*) AS cnt, round(AVG(amount), 2) AS avg_amount
FROM analytics.events
WHERE __ingest_ts >= '2026-01-01T00:00:00Z'
GROUP BY category ORDER BY cnt DESC LIMIT 100"REST API (Python)
import requests
API = f"https://api.sql.cloudflarestorage.com/api/v1/accounts/{ACCOUNT_ID}/basin-sql/query/{BUCKET}"
HEADERS = {"Authorization": f"Bearer {TOKEN}", "Content-Type": "application/json"}
def r2sql(query):
body = requests.post(API, headers=HEADERS, json={"query": query}, timeout=180).json()
if body["success"]:
return body["result"]["rows"], body["result"]["metrics"]
raise RuntimeError(body["errors"])
rows, metrics = r2sql("SELECT category, COUNT(*) AS cnt FROM analytics.events GROUP BY category LIMIT 10")REST API (curl)
curl -X POST \
"https://api.sql.cloudflarestorage.com/api/v1/accounts/$ACCOUNT_ID/basin-sql/query/$BUCKET" \
-H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
-d '{"query": "SELECT COUNT(*) AS total FROM analytics.events"}'Dashboard Worker
No Basin SQL binding exists — query the REST endpoint via fetch().
interface Env { ACCOUNT_ID: string; BUCKET: string; R2_SQL_TOKEN: string; }
async function queryR2SQL(env: Env, query: string) {
const url = `https://api.sql.cloudflarestorage.com/api/v1/accounts/${env.ACCOUNT_ID}/basin-sql/query/${env.BUCKET}`;
const resp = await fetch(url, {
method: "POST",
headers: { Authorization: `Bearer ${env.R2_SQL_TOKEN}`, "Content-Type": "application/json" },
body: JSON.stringify({ query }),
});
if (!resp.ok) throw new Error(`Basin SQL ${resp.status}: ${await resp.text()}`);
return (await resp.json() as any).result;
}
export default {
async fetch(req: Request, env: Env): Promise<Response> {
if (new URL(req.url).pathname === "/api/analytics") {
const result = await queryR2SQL(env, `
SELECT category, COUNT(*) AS cnt FROM analytics.events
GROUP BY category ORDER BY cnt DESC LIMIT 10`);
return Response.json(result.rows);
}
return new Response("Not found", { status: 404 });
},
};npx wrangler secret put R2_SQL_TOKENExample Queries
-- Error rate by endpoint
SELECT path, COUNT(*) AS total, SUM(CASE WHEN status >= 400 THEN 1 ELSE 0 END) AS errors
FROM logs.http_requests WHERE __ingest_ts >= '2026-01-01T00:00:00Z'
GROUP BY path ORDER BY errors DESC LIMIT 20;
-- Top-3 slowest requests per method (window + QUALIFY)
SELECT method, path, response_time_ms FROM logs.http_requests
QUALIFY ROW_NUMBER() OVER (PARTITION BY method ORDER BY response_time_ms DESC) <= 3;
-- Cross-table analytics with approx distinct
SELECT z.domain, COUNT(*) AS requests, approx_distinct(h.client_ip) AS uniques
FROM ns.zones z INNER JOIN ns.http_requests h ON z.zone_id = h.zone_id
WHERE h.__ingest_ts >= '2026-06-01T00:00:00Z'
GROUP BY z.domain ORDER BY requests DESC LIMIT 25;Cursor-Based Pagination
Paginate on a sortable (ideally partition) column rather than OFFSET:
SELECT * FROM logs.requests ORDER BY __ingest_ts DESC LIMIT 500; -- page 1
SELECT * FROM logs.requests WHERE __ingest_ts < '<last_ts>' ORDER BY __ingest_ts DESC LIMIT 500; -- page 2Performance (essentials)
Always
LIMIT(early termination); filter on partition keys first (__ingest_tsrange), then add predicates.Narrow time ranges; compact tables (file count dominates latency — enable automatic compaction in Basin Catalog).
Read response
metrics(files_scanned,bytes_scanned) to tune. Full guidance: limitations-best-practices doc.
Basin Pipelines → Basin SQL
After npx wrangler basin pipelines setup (Basin Catalog destination), wait for first flush (3–7 min), then query the table. See pipelines/patterns.md.
See Also
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