Redpanda

https://docs.redpanda.com/
Admin
Redpanda is a high-performance, governed data streaming platform that provides serverless, managed,...
Tokens:4,594,309
Snippets:73,307
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### UNION Example Setup

Source: https://docs.redpanda.com/cloud-data-platform/reference/sql/sql-clauses/set-operations/union.md

Creating and populating tables to demonstrate the UNION operator.

```sql
CREATE TABLE employees (
    emp_id INT,
    emp_name TEXT
);

CREATE TABLE contractors (
    contractor_id INT,
    contractor_name TEXT
);

INSERT INTO employees VALUES
(1, 'John'),
(2, 'Alice'),
(3, 'Bob');

INSERT INTO contractors VALUES
(101, 'Alice'),
(102, 'Eve'),
(103, 'Tom');
```

--------------------------------

### UNION ALL Example Setup

Source: https://docs.redpanda.com/cloud-data-platform/reference/sql/sql-clauses/set-operations/union.md

Creating and populating sales tables to demonstrate the UNION ALL operator.

```sql
CREATE TABLE sales_2022 (
    transaction_id INT,
    product_name TEXT,
    sale_amount INT
);

CREATE TABLE sales_2023 (
    transaction_id INT,
    product_name TEXT,
    sale_amount INT
);

INSERT INTO sales_2022 VALUES
(1, 'Product A', 1000),
(2, 'Product B', 500),
(3, 'Product C', 750);

INSERT INTO sales_2023 VALUES
(4, 'Product A', 1200),
(5, 'Product D', 800),
(6, 'Product E', 950);
```

--------------------------------

### Create and Populate petsData Table

Source: https://docs.redpanda.com/cloud-data-platform/reference/sql/sql-functions/string-functions/starts-with.md

Initial setup for the petsData table used in the examples.

```sql
CREATE TABLE petsData (
  petid int,
  petname text,
  species text,
  breed text,
  sex text,
  age int
);
INSERT INTO petsData
    (petid, petname, species, breed, sex, age)
VALUES
    (2021001,'Bartholomeow','cat','persian','m',2),
    (2021004,'Jack','dog','boston terrier','m',1),
    (2022001,'Jesse','hamster','dzungarian','m',1),
    (2022010,'Bella','dog','dobberman','f',3),
    (2022011,'June','cat','american shorthair','f',2);
```

--------------------------------

### Create and Populate Student Table

Source: https://docs.redpanda.com/cloud-data-platform/reference/sql/sql-clauses/having.md

Initial setup for the student table used in the examples.

```sql
CREATE TABLE student (
  stud_id int,
  stud_name text
);
INSERT INTO student
    (stud_id, stud_name)
VALUES
    (992831192, 'Mary'),
    (992811191, 'Bobby'),
    (992311195, 'Sean'),
    (998311193, 'Harry'),
    (998311194, 'William'),
    (928311197, 'Kate'),
    (928311190, 'Tom'),
    (928311199, 'Sully'),
    (998311196, 'Susan');
```

```sql
SELECT * FROM student;
```

```sql
+------------+------------+
| stud_id    | stud_name  |
+------------+------------+
| 992831192  | Mary       |
| 992811191  | Bobby      |
| 992311195  | Sean       |
| 998311193  | Harry      |
| 998311194  | William    |
| 928311197  | Kate       |
| 928311190  | Tom        |
| 928311199  | Sully      |
| 998311196  | Susan      |
+------------+------------+
```

--------------------------------

### Setup table for flag usage examples

Source: https://docs.redpanda.com/llms-full.txt

Creates and populates a table to demonstrate case-insensitive replacement.

```sql
CREATE TABLE quotes (quotes_text text);
INSERT INTO quotes (quotes_text)
VALUES ('Work hard and stay hungry. Lazy people get nowhere in life.'),
       ('An excuse is a way for a LAZY person to feel better.'),
       ('The word LUCKY is how a lazy person describes someone who works hard.');

SELECT quotes_text FROM quotes;
```

--------------------------------

### Create and populate personal_details table

Source: https://docs.redpanda.com/cloud-data-platform/reference/sql/sql-functions/string-functions/lower.md

Setup script for the personal_details table used in column examples.

```sql
CREATE TABLE personal_details (
  id int,
  first_name text,
  last_name text,
  gender text
);
INSERT INTO personal_details
    (id, first_name, last_name, gender)
VALUES
    (1,'Mark','Wheeler','M'),
    (2,'Tom','Hanks','M'),
    (3,'Jane','Hopper','F'),
    (4,'Emily','Byers','F'),
    (5,'Lucas','Sinclair','M');
```

--------------------------------

### SQL Table Creation and Data Insertion

Source: https://docs.redpanda.com/cloud-data-platform/reference/sql/sql-clauses/from/from.md

Setup for the product and category tables used in the examples.

```sql
CREATE TABLE product (
  id int,
  product text,
  category text,
  price int
);
INSERT INTO product
    (id, product, category, price)
VALUES
    (445747,'Court vision women''s shoes nike','Shoes', 8000),
    (445641,'Disney kids h&m','Shirt', 6500),
    (477278,'Defacto adidas','Hat', 8500),
    (481427,'Sophie shopping bag','Bag', 6500),
    (411547,'Candy skirt zara','Skirt', 6500),
    (488198,'Slim cut skirt hush puppies','Skirt', 7600);
```

```sql
CREATE TABLE category (
  categoryName text,
  budget int
);
INSERT INTO category
    (categoryName, budget)
VALUES
    ('Shoes', 7000),
    ('Shirt', 9000),
    ('Bag', 8000),
    ('Skirt', 7500),
    ('Hat', 7000);
```

--------------------------------

### List and get help for -X options

Source: https://docs.redpanda.com/streaming-full.txt

Use these commands to view supported configuration keys or get detailed help regarding -X options.

```bash
rpk -X list
```

```bash
rpk -X help
```

--------------------------------

### Codec Configuration Examples

Source: https://docs.redpanda.com/llms-full.txt

Examples of different codec settings for message framing.

```yaml
codec: lines

# ---

codec: delim:

# ---

codec: delim:foobar
```

--------------------------------

### Query example table

Source: https://docs.redpanda.com/llms-full.txt

Retrieves the raw data from the example table.

```sql
SELECT * FROM timemicro_example;
```

--------------------------------

### Create and Populate Table

Source: https://docs.redpanda.com/cloud-data-platform-full.txt

Setup for demonstrating strpos with table columns.

```sql
CREATE TABLE listofwords (
  words text
);
INSERT INTO listofwords
    (words)
VALUES
    ('corral'),
    ('traditionally'),
    ('real'),
    ('communal'),
    ('challenge'),
    ('fall'),
    ('wall'),
    ('gallop'),
    ('albatross');
```

--------------------------------

### Create and populate sample table

Source: https://docs.redpanda.com/cloud-data-platform-full.txt

Setup for testing pg_typeof on table columns.

```sql
CREATE TABLE timestamp_example (
    id int,
    event_time timestamp,
    description text
);

INSERT INTO timestamp_example (event_time, description)
VALUES
  ('2023-10-20 12:30:00', 'Event 1'),
  (NULL, 'Event 2');
```

--------------------------------

### Benchmark Log Output Examples

Source: https://docs.redpanda.com/connect-full.txt

Example log output for rolling and total throughput statistics.

```bash
INFO rolling stats: 1 msg/sec, 407 B/sec
```

```bash
INFO total stats: 1.00186 msg/sec, 425 B/sec
```

--------------------------------

### Querying the example table

Source: https://docs.redpanda.com/cloud-data-platform-full.txt

Retrieves the raw data from the unix_example table.

```sql
SELECT * FROM unix_example;
```

--------------------------------

### Role Response Examples

Source: https://docs.redpanda.com/api/doc/cloud-controlplane/explorer/operation/operation-roleservice_getrole

Examples of successful and error responses for the get role operation.

```json
{
  "role": {
    "created_at": "2026-05-04T09:42:00Z",
    "description": "Billing Admins have access to billing information.",
    "id": "string",
    "is_builtin": true,
    "name": "billing_admin",
    "permissions": [
      "string"
    ],
    "updated_at": "2026-05-04T09:42:00Z"
  }
}
```

```json
{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string",
          "localized_message": {
            "locale": "string",
            "message": "string"
          },
          "reason": "string"
        }
      ]
    }
  ],
  "message": "string"
}
```

```json
{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string",
          "localized_message": {
            "locale": "string",
            "message": "string"
          },
          "reason": "string"
        }
      ]
    }
  ],
  "message": "string"
}
```

```json
{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string",
          "localized_message": {
            "locale": "string",
            "message": "string"
          },
          "reason": "string"
        }
      ]
    }
  ],
  "message": "string"
}
```

--------------------------------

### Set up the plugin environment

Source: https://docs.redpanda.com/connect/plugins/about.md

Initialize a new directory and install the redpanda_connect dependency using uv.

```shell
# Create a new directory for your plugin
mkdir fizzbuzz_plugin
cd fizzbuzz_plugin

# Initialize with link:https://docs.astral.sh/uv/[uv] (or use pip/conda)
uv init .
uv add redpanda_connect
```

--------------------------------

### Get Resource Group Example

Source: https://docs.redpanda.com/api/doc/cloud-controlplane.yaml

Example response for retrieving a specific resource group by ID.

```json
{
  "resource_group": {
    "created_at": "2023-08-25T00:00:00Z",
    "id": "897e76ad-64d5-4314-9d81-7383fa14100d",
    "name": "my-new-namespace",
    "updated_at": null
  }
}
```

--------------------------------

### Navigate to the Example Directory

Source: https://docs.redpanda.com/labs/clients/cloud-go.md

Change the working directory to the Go chat room example.

```bash
cd clients/chat-room/cloud/go
```

--------------------------------

### Clone and Navigate to Deployment Automation Repository

Source: https://docs.redpanda.com/streaming/24.2/deploy/deployment-option/self-hosted/manual/production/production-deployment-automation.md

Initial setup steps to prepare the environment for automated deployment.

```bash
git clone https://github.com/redpanda-data/deployment-automation.git
```

```bash
cd deployment-automation
```

--------------------------------

### Get Current Organization Response Examples

Source: https://docs.redpanda.com/api/doc/cloud-controlplane/explorer/operation/operation-organizationservice_getcurrentorganization?authentication_id=authentication-auth0

Example JSON responses for successful requests and error scenarios.

```json
{
  "organization": {
    "auth0_id": "string",
    "default_resource_group_id": "string",
    "id": "string",
    "mfa_enforced": true,
    "name": "string",
    "welcome_cluster_id": "string"
  }
}
```

```json
{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string",
          "localized_message": {
            "locale": "string",
            "message": "string"
          },
          "reason": "string"
        }
      ]
    }
  ],
  "message": "string"
}
```

```json
{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string",
          "localized_message": {
            "locale": "string",
            "message": "string"
          },
          "reason": "string"
        }
      ]
    }
  ],
  "message": "string"
}
```

--------------------------------

### Cluster API Response Examples

Source: https://docs.redpanda.com/api/doc/cloud-controlplane/explorer/operation/operation-clusterservice_getcluster

Examples of successful and error responses returned by the Get Cluster endpoint.

```json
{
  "cluster": {
    "ai_gateway": null,
    "api_gateway_access": "NETWORK_ACCESS_MODE_UNSPECIFIED",
    "cloud_provider": "CLOUD_PROVIDER_GCP",
    "cloud_provider_tags": {},
    "cloud_storage": null,
    "cluster_configuration": null,
    "connection_type": "CONNECTION_TYPE_PUBLIC",
    "created_at": "2023-01-01T00:00:00Z",
    "current_redpanda_version": "",
    "customer_managed_resources": null,
    "dataplane_api": null,
    "desired_redpanda_version": "",
    "http_proxy": {
      "all_urls": null,
      "mtls": {
        "ca_certificates_pem": [],
        "enabled": false,
        "principal_mapping_rules": []
      },
      "sasl": null,
      "url": "https://pandaproxy-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com:9092"
    },
    "id": "cjd3r21c4vs870t0ku30",
    "kafka_api": {
      "all_seed_brokers": null,
      "mtls": null,
      "sasl": null,
      "seed_brokers": [
        "seed-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com:9092"
      ]
    },
    "kafka_connect": null,
    "maintenance_window_config": null,
    "name": "my-new-cluster",
    "nat_gateways": [],
    "network_id": "cjb69k1c4vs45df9bee0",
    "oxla": null,
    "prometheus": {
      "url": "https://console-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com/api/cloud/prometheus/public_metrics"
    },
    "read_replica_cluster_ids": [],
    "redpanda_console": {
      "url": "https://console-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com/api"
    },
    "redpanda_node_count": 0,
    "region": "us-west1",
    "resource_group_id": "6c09e47b-f426-4ec7-a7b4-8048caf8ae47",
    "sandbox": null,
    "schema_registry": {
      "all_urls": null,
      "mtls": null,
      "sasl": null,
      "url": "schema-registry-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com:9092"
    },
    "state": "STATE_READY",
    "state_description": null,
    "throughput_tier": "tier-1-gcp-v2-x86",
    "type": "TYPE_DEDICATED",
    "updated_at": "2023-01-01T00:00:00Z",
    "zones": [
      "us-west1-a",
      "us-west1-b",
      "us-west1-c"
    ]
  }
}
```

```json
{
  "code": "NOT_FOUND",
  "details": [],
  "message": "Cluster not found"
}
```

```json
{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string",
          "localized_message": {
            "locale": "string",
            "message": "string"
          },
          "reason": "string"
        }
      ]
    }
  ],
  "message": "string"
}
```

--------------------------------

### Configure string_split processor

Source: https://docs.redpanda.com/connect-full.txt

Basic and advanced configuration examples for the string_split processor.

```yaml
processors:
  label: ""
  string_split:
    delimiter:

    empty_as_null: false
```

```yaml
processors:
  label: ""
  string_split:
    delimiter:

    emit_bytes: false
    empty_as_null: false
```

--------------------------------

### Install Redpanda on Debian/Ubuntu

Source: https://docs.redpanda.com/docs/deploy/deployment-option/self-hosted/kubernetes/kubernetes-tune-workers

Use the setup script and apt to install the Redpanda package on Debian-based distributions.

```bash
# Run the setup script to download and install the repo
curl -1sLf 'https://linux.pkg.redpanda.com/setup-redpanda.deb.sh' | sudo -E bash && \
# Use apt to install redpanda
sudo apt install redpanda -y
```

--------------------------------

### Create sample table and index

Source: https://docs.redpanda.com/cloud-data-platform/reference/sql/sql-functions/other-functions/pg-get-indexdef.md

Setup a table and an index to demonstrate the function.

```sql
CREATE TABLE sample_table(col int);
CREATE INDEX sample_index ON sample_table(col);
```

--------------------------------

### Install Redpanda on Fedora/RedHat

Source: https://docs.redpanda.com/docs/deploy/deployment-option/self-hosted/kubernetes/kubernetes-tune-workers

Use the setup script and yum to install the Redpanda package on RHEL-based distributions.

```bash
# Run the setup script to download and install the repo
curl -1sLf 'https://linux.pkg.redpanda.com/setup-redpanda.rpm.sh' | sudo -E bash && \
# Use yum to install redpanda
sudo yum install redpanda -y
```

--------------------------------

### Serve the documentation site locally

Source: https://docs.redpanda.com/labs/contribute.md

Start a local web server to preview the generated documentation site.

```bash
npm run serve
```

--------------------------------

### Navigate to the example directory

Source: https://docs.redpanda.com/labs/clients/cloud-nodejs.md

Change the working directory to the Node.js chat room example.

```bash
cd clients/chat-room/cloud/nodejs
```

--------------------------------

### Get Role Binding Response Examples

Source: https://docs.redpanda.com/api/doc/cloud-controlplane/explorer/operation/operation-rolebindingservice_getrolebinding

Example JSON responses for successful retrieval and 404 error scenarios.

```json
{
  "role_binding": {
    "account_id": "string",
    "created_at": "2026-05-04T09:42:00Z",
    "id": "string",
    "role_name": "string",
    "scope": {
      "dataplane_id": "string",
      "resource_id": "string",
      "resource_type": "SCOPE_RESOURCE_TYPE_RESOURCE_GROUP"
    },
    "updated_at": "2026-05-04T09:42:00Z"
  }
}
```

```json
{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string",
          "localized_message": {
            "locale": "string",
            "message": "string"
          },
          "reason": "string"
        }
      ]
    }
  ],
  "message": "string"
}
```

--------------------------------

### Start a Three-Node Cluster

Source: https://docs.redpanda.com/streaming/23.3/reference/rpk/rpk-container/rpk-container-start.md

Example of starting a three-node cluster and interacting with it using rpk commands or environment variables.

```bash
$ rpk container start -n 3
Starting cluster
Waiting for the cluster to be ready...
Cluster started!
  NODE-ID  STATUS   KAFKA-ADDRESS    ADMIN-ADDRESS    PROXY-ADDRESS
  0        running  127.0.0.1:45841  127.0.0.1:40705  127.0.0.1:36875
  1        running  127.0.0.1:42467  127.0.0.1:38959  127.0.0.1:37665
  2        running  127.0.0.1:44941  127.0.0.1:46047  127.0.0.1:45783

You can use rpk to interact with this cluster. E.g:

	rpk cluster info --brokers 127.0.0.1:45841,127.0.0.1:42467,127.0.0.1:44941

You may also set an environment variable with the comma-separated list of
broker addresses:

	export REDPANDA_BROKERS="127.0.0.1:45841,127.0.0.1:42467,127.0.0.1:44941"
	rpk cluster info
```

--------------------------------

### Create Config Examples

Source: https://docs.redpanda.com/streaming/24.1/reference/rpk/rpk-connect/rpk-connect-create.md

Examples of generating configurations using specific component expressions.

```bash
rpk connect create stdin/bloblang,awk/nats
```

```bash
rpk connect create file,http_server/protobuf/http_client
```

--------------------------------

### Example Request for Get MCP Server

Source: https://docs.redpanda.com/api/doc/cloud-dataplane/explorer/operation/operation-mcpserverservice_getmcpserver?authentication_id=authentication-auth0

The endpoint uses a GET request with the MCP server ID as a path parameter.

```http
GET /v1/redpanda-connect/mcp-servers/{id}
```

--------------------------------

### Prepare installation directory

Source: https://docs.redpanda.com/streaming/23.3/get-started/rpk-install.md

Create the local bin directory if it does not already exist.

```bash
mkdir -p ~/.local/bin
```

--------------------------------

### rpk cloud byoc install

Source: https://docs.redpanda.com/streaming/23.3/reference/rpk/rpk-cloud/rpk-cloud-byoc-install.md

Installs the BYOC plugin and initiates the agent service setup for a Redpanda BYOC cluster.

```APIDOC
## rpk cloud byoc install

### Description
Installs the BYOC plugin from Redpanda Cloud. This command is used to download the plugin ahead of time, though it is installed automatically by other non-install commands.

### Usage
`rpk cloud byoc install [flags]`

### Flags
- **--redpanda-id** (string) - The redpanda ID of the cluster you are creating.
- **--config** (string) - Redpanda or rpk config file path.
- **-X, --config-opt** (stringArray) - Override rpk configuration settings (e.g., cloud.client_id, cloud.client_secret).
- **--profile** (string) - Profile to use.
- **-v, --verbose** - Enable verbose logging.
- **-h, --help** - Help for install.

### Example
`rpk cloud byoc install -X cloud.client_id=<your-client-id> -X cloud.client_secret=<your-client-secret>`
```

--------------------------------

### Install and Configure rpk

Source: https://docs.redpanda.com/streaming/current/manage/iceberg/iceberg-topics-gcp-biglake.md

Install the rpk CLI tool and initialize a profile from the provided configuration file.

```bash
sudo apt-get install unzip

curl -LO https://github.com/redpanda-data/redpanda/releases/latest/download/rpk-linux-amd64.zip &&
  mkdir -p ~/.local/bin &&
  export PATH="~/.local/bin:$PATH" &&
  unzip rpk-linux-amd64.zip -d ~/.local/bin/

rpk profile create quickstart --from-profile rpk-profile.yaml
```

--------------------------------

### YUM Dependency Error Example

Source: https://docs.redpanda.com/streaming/25.1/deploy/deployment-option/self-hosted/manual/production/dev-deployment.md

Example of the error output encountered when installing an older Redpanda version without specifying all dependencies.

```bash
yum install redpanda=24.3.1~rc1-1
Reading package lists... Done
Building dependency tree... Done
Reading state information... Done
Some packages could not be installed. This may mean that you have
requested an impossible situation or if you are using the unstable
distribution that some required packages have not yet been created
or been moved out of Incoming.
The following information may help to resolve the situation:

The following packages have unmet dependencies:
 redpanda : Depends: redpanda-rpk (= 24.3.1~rc1-1) but it is not going to be installed or
                     redpanda-rpk-fips (= 24.3.1~rc1-1) but it is not going to be installed
            Depends: redpanda-tuner (= 24.3.1~rc1-1) but it is not going to be installed
E: Unable to correct problems, you have held broken packages.
```

--------------------------------

### Create and populate a table

Source: https://docs.redpanda.com/cloud-data-platform/reference/sql/sql-functions/other-functions/pg-total-relation-size.md

Setup a sample users table with data to measure its size.

```sql
CREATE TABLE users (
    username TEXT,
    email TEXT
);
INSERT INTO users (username, email) VALUES
    ('john_doe', 'john.doe@example.com'),
    ('jane_smith', 'jane.smith@example.com'),
    ('alice_smith', 'alice.smith@example.com'),
    ('bob_jones', 'bob.jones@example.com'),
    ('susan_wilson', 'susan.wilson@example.com'),
    ('michael_jackson', 'michael.jackson@example.com'),
    ('lisa_johnson', 'lisa.johnson@example.com'),
    ('david_smith', 'david.smith@example.com');
```
Tokens:
Raw