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/api.md
Basin SQL API Reference
Read-only SQL over Iceberg (Apache DataFusion). Query templates only. For the authoritative list of supported syntax, functions, data types, and limitations, pull the SQL reference (sql-reference/, .../aggregate-functions/, .../scalar-functions/, .../complex-types/) and reference/limitations-best-practices/.
Query Endpoint
POST https://api.sql.cloudflarestorage.com/api/v1/accounts/{ACCOUNT_ID}/basin-sql/query/{BUCKET}
Authorization: Bearer <token>
Content-Type: application/json
Body: {"query": "<SQL>"}CLI: npx wrangler basin sql query "{WAREHOUSE}" "<SQL>" (with WRANGLER_BASIN_SQL_AUTH_TOKEN).
Response Format
{
"result": {
"request_id": "dqe-prod-01...",
"schema": [{"name": "cnt", "descriptor": {"type": {"name": "int64"}, "nullable": false}}],
"rows": [{"category": "Electronics", "cnt": 12345}],
"metrics": {"r2_requests_count": 5, "files_scanned": 29, "bytes_scanned": 12345678, "cache_hits": 0}
},
"success": true, "errors": []
}Error: {"result": null, "success": false, "errors": [{"code": 40003, "message": "..."}]}. bytes_scanned ≈ billable data.
Query Structure
SELECT [DISTINCT] columns | expressions | aggregations
FROM namespace.table [alias]
[ [INNER|LEFT|RIGHT|FULL OUTER|CROSS] JOIN namespace.table2 alias2 ON ... ]
[WHERE ...] [GROUP BY ...] [HAVING ...]
[QUALIFY window_predicate]
[ORDER BY expr [ASC|DESC]]
[LIMIT n] -- default 500, max 10,000Schema Discovery
SHOW DATABASES; -- list namespaces (aliases: SHOW NAMESPACES / SHOW SCHEMAS)
SHOW TABLES IN namespace;
DESCRIBE namespace.table; -- columns, types, partition keys
EXPLAIN [FORMAT JSON] SELECT ...; -- execution plan (free; no data scanned)JOINs / Subqueries / CTEs / Set Ops
-- JOINs: all types + multi-way
SELECT z.domain, COUNT(*) AS cnt
FROM ns.zones z
INNER JOIN ns.http_requests h ON z.zone_id = h.zone_id
LEFT JOIN ns.firewall_events f ON z.zone_id = f.zone_id
GROUP BY z.domain ORDER BY cnt DESC LIMIT 20;
-- Subqueries: IN / EXISTS / scalar / derived
SELECT * FROM ns.t1 WHERE id IN (SELECT id FROM ns.t2 WHERE x > 0);
SELECT col, (SELECT COUNT(*) FROM ns.t2 s WHERE s.id = t.id) AS cnt FROM ns.t1 t;
-- Multi-table CTE with JOIN
WITH top AS (SELECT zone_id, COUNT(*) AS req FROM ns.http_requests GROUP BY zone_id ORDER BY req DESC LIMIT 50)
SELECT t.zone_id, t.req FROM top t LEFT JOIN ns.zones z ON t.zone_id = z.zone_id;
-- Set ops: UNION / UNION ALL / INTERSECT / EXCEPT
SELECT zone_id FROM ns.firewall_events WHERE action = 'block'
UNION SELECT zone_id FROM ns.http_requests WHERE risk_score > 0.8;Window Functions
Use inline OVER (...). See the SQL reference for the full list of supported window functions and frame syntax.
SELECT event_id,
ROW_NUMBER() OVER (PARTITION BY mag_type ORDER BY magnitude DESC) AS rn,
LAG(magnitude, 2, 0.0) OVER (ORDER BY occurred_at) AS prev2, -- offset + default
NTH_VALUE(magnitude, 2) OVER (ORDER BY magnitude DESC) AS n2,
SUM(magnitude) OVER (ORDER BY occurred_at) AS running,
AVG(magnitude) OVER (ORDER BY magnitude ROWS BETWEEN 2 PRECEDING AND CURRENT ROW) AS moving_avg
FROM ns.earthquakes;
-- QUALIFY: filter on a window result (top row per partition)
SELECT event_id, mag_type, magnitude FROM ns.earthquakes
QUALIFY ROW_NUMBER() OVER (PARTITION BY mag_type ORDER BY magnitude DESC) = 1;Functions
Aggregate, scalar, JSON, and array/map function catalogs are in the docs — pull sql-reference/aggregate-functions/ and .../scalar-functions/. JSON functions accept variadic paths, e.g. json_get_int(doc, 'user', 'profile', 'level').
Data Types
integer, float, string (single quotes), boolean, timestamp (RFC3339 with timezone), date (ISO 8601), struct, array (1-indexed), map. No implicit conversions — quote strings, include timezone on timestamps, don't quote integers. Full type docs: sql-reference/.
WHERE status = 200 AND method = 'GET' -- not '200', not GET
AND ts >= '2026-01-01T00:00:00Z' -- not '2026-01-01'Complex Types (quick examples; full ref in docs)
SELECT pricing['price'] AS price, get_field(pricing, 'discount') AS disc FROM ns.t; -- struct
SELECT tags[1] AS first_tag, array_length(tags) AS n FROM ns.t; -- array (1-indexed)
SELECT map_keys(meta), map_extract(meta, 'source') FROM ns.t; -- mapErrors
Failed queries return {"success": false, "errors": [{"code": ..., "message": ...}]}. For error codes and troubleshooting, see https://developers.cloudflare.com/basin-sql/troubleshooting/index.md.
See Also
patterns.md — query examples · gotchas.md — limits & workarounds · configuration.md
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