Generated banner for Basin
Generated logo for Basin

Basin

CloudflareOfficialPublished by Cloudflare

  • Skill
  • Tool integration
  • Data and AI
  • Apache-2.0
  • No issues found

From the author

Build and troubleshoot Cloudflare Basin analytics workflows with Basin Pipelines, Basin Catalog, and Basin SQL. Use for streaming data into R2 Iceberg tables, managing catalogs, or querying those tables; also use for requests using the former Data Platform, Pipelines, R2 Data Catalog, or R2 SQL names.
— the description by Cloudflare

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

  1. Download the skill as a ZIP:

    https://mp-staging.autogineer.com/agent-skills/cloudflare/basin/download
  2. Unzip 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

NeedProductReferenceCurrent docs
Receive events, transform rows, and deliver to R2Basin PipelinesPipelines guideBasin Pipelines
Manage Iceberg metadata, table maintenance, and engine accessBasin CatalogCatalog guideBasin Catalog
Query Iceberg tables with analytical SQLBasin SQLSQL guideBasin 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

references/sql/README.md

Basin SQL

Serverless, distributed, read-only query engine (Apache DataFusion) for Apache Iceberg tables in Basin Catalog.

Documentation

For full function lists, data types, and pricing, retrieve the live docs — use the Cloudflare MCP docs tool if available, otherwise webfetch.

TopicURL
Overview / get startedhttps://developers.cloudflare.com/basin-sql/get-started/index.md
Query datahttps://developers.cloudflare.com/basin-sql/query-data/index.md
SQL referencehttps://developers.cloudflare.com/basin-sql/sql-reference/index.md
Aggregate functionshttps://developers.cloudflare.com/basin-sql/sql-reference/aggregate-functions/index.md
Scalar functionshttps://developers.cloudflare.com/basin-sql/sql-reference/scalar-functions/index.md
Complex typeshttps://developers.cloudflare.com/basin-sql/sql-reference/complex-types/index.md
Limitations & best practiceshttps://developers.cloudflare.com/basin-sql/reference/limitations-best-practices/index.md
Wrangler commandshttps://developers.cloudflare.com/basin-sql/reference/wrangler-commands/index.md
Pricinghttps://developers.cloudflare.com/basin-sql/platform/pricing/index.md

Connection Values

ValueFormat
REST endpointhttps://api.sql.cloudflarestorage.com/api/v1/accounts/{ACCOUNT_ID}/basin-sql/query/{BUCKET}
Wranglernpx wrangler basin sql query "{WAREHOUSE}" "<SQL>" with WRANGLER_BASIN_SQL_AUTH_TOKEN set
Warehouse{ACCOUNT_ID}_{BUCKET}

The REST endpoint is api.sql.cloudflarestorage.com — not the account API host. The legacy /r2-sql/query/ path may still work, but use /basin-sql/query/ for new integrations.

Quick Start

npx wrangler basin catalog enable my-bucket           # 1. enable catalog
export WRANGLER_BASIN_SQL_AUTH_TOKEN=<r2-token>              # 2. auth (Admin R&W + Basin SQL Read)
npx wrangler basin sql query "$ACCOUNT_ID"_my-bucket \
  "SELECT * FROM default.my_table LIMIT 10"                # 3. query

SQL Surface

Basin SQL is read-only and supports a broad analytical SQL surface (SELECT, JOINs, subqueries, CTEs, set operations, window functions, and aggregate/scalar/JSON functions over complex types). For the authoritative, current list of supported syntax, functions, and limitations, see the SQL reference and limitations docs linked above. api.md has query templates.

When to Use

Use for: SQL analytics over Iceberg (logs, BI, fraud, ad-hoc), multi-cloud queries without egress, dashboards (query from a Worker via HTTP).

Don't use for: writes (use PySpark/PyIceberg) or real-time OLTP (<100 ms).

No Workers Binding

There is no env.R2_SQL binding. Query from a Worker via fetch() to the REST endpoint with the token as a secret (see patterns.md).

Reading Order

  1. configuration.md — enable catalog, tokens, env setup

  2. api.md — SQL syntax templates, JOIN/window examples, response format, data types

  3. patterns.md — CLI/REST/Worker queries, use cases, pagination, performance

  4. gotchas.md — what works vs. not, performance, troubleshooting

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.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download basin.zip