Skip to content

Commit dde1d62

Browse files
adding wrangler commands
1 parent 5a27768 commit dde1d62

File tree

6 files changed

+52
-1
lines changed

6 files changed

+52
-1
lines changed

src/content/docs/r2-sql/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ description: A distributed SQL engine for R2 Data Catalog
1313

1414

1515
:::note
16-
R2 SQL is in public beta, and any developer with an R2 subscription can start using it. Currently, outside of standard R2 storage and operations, you will not be billed for your use of R2 SQL. We will update [the pricing page](/r2-sql/reference/pricing) and provide at least 30 days notice before enabling billing.
16+
R2 SQL is in public beta, and any developer with an R2 subscription can start using it. Currently, outside of standard R2 storage and operations, you will not be billed for your use of R2 SQL. We will update [the pricing page](/r2-sql/platform/pricing) and provide at least 30 days notice before enabling billing.
1717
:::
1818

1919
R2 SQL is Cloudflare's serverless, distributed, analytics query engine for querying [Apache Iceberg](https://iceberg.apache.org/) tables stored in [R2 data catalog](https://developers.cloudflare.com/r2/data-catalog/). R2 SQL is designed to efficiently query large amounts of data by automatically utilizing file pruning, Cloudflare's distributed compute, and R2 object storage.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Platform
3+
pcx_content_type: navigation
4+
sidebar:
5+
group:
6+
hideIndex: true
7+
---
File renamed without changes.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
pcx_content_type: concept
3+
title: Wrangler commands
4+
sidebar:
5+
order: 80
6+
---
7+
8+
import { Render, Type, MetaInfo } from "~/components";
9+
10+
<Render file="wrangler-commands/r2-sql" product="workers" />
11+
12+
## Global commands
13+
14+
<Render file="wrangler-commands/global-flags" product="workers" />

src/content/docs/workers/wrangler/commands.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ Wrangler offers a number of commands to manage your Cloudflare Workers.
3636
- [`kv bulk`](#kv-bulk) - Manage multiple key-value pairs within a Workers KV namespace in batches.
3737
- [`r2 bucket`](#r2-bucket) - Manage Workers R2 buckets.
3838
- [`r2 object`](#r2-object) - Manage Workers R2 objects.
39+
- [`r2 sql`](#r2-sql) - Query tables in R2 Data Catalog with R2 SQL.
3940
- [`secret`](#secret) - Manage the secret variables for a Worker.
4041
- [`secret bulk`](#secret-bulk) - Manage multiple secret variables for a Worker.
4142
- [`secrets-store secret`](#secrets-store-secret) - Manage account secrets within a secrets store.
@@ -356,6 +357,11 @@ wrangler delete [<SCRIPT>] [OPTIONS]
356357

357358
<Render file="wrangler-commands/r2" product="workers" />
358359

360+
---
361+
## r2 SQL
362+
363+
<Render file="wrangler-commands/r2-sql" product="workers" />
364+
359365
---
360366

361367
## `secret`
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
{}
3+
---
4+
5+
import { Render, AnchorHeading, Type, MetaInfo } from "~/components";
6+
7+
:::note
8+
9+
R2 SQL is currently in open beta. Report R2 SQL bugs in [GitHub](https://github.com/cloudflare/workers-sdk/issues/new/choose). R2 SQL expects there to be a [WRANGLER_R2_SQL_AUTH_TOKEN](/workers/wrangler/system-environment-variables) environment variable to be set.
10+
11+
:::
12+
13+
<AnchorHeading title="`query`" slug="r2-sql-query" depth={3} />
14+
15+
Query a table in R2 Data Catalog using R2 SQL
16+
17+
```txt
18+
wrangler r2 sql query <warehouse> <query>
19+
```
20+
21+
- `warehouse` <Type text="string" /> <MetaInfo text="required" />
22+
- Your R2 Data Catalog warehouse - in the form of ACCOUNT_ID_BUCKET_NAME
23+
- `query` <Type text="string" /> <MetaInfo text="required" />
24+
- The SQL query to execute. Refer to the [SQL reference](/r2-sql/reference/sql-reference/).

0 commit comments

Comments
 (0)