### Clone and setup Confluent examples repository

Source: https://docs.confluent.io/platform/current/clients/examples/kotlin.html

Clone the confluentinc/examples repository and navigate to the Kotlin client examples directory.

```bash
git clone https://github.com/confluentinc/examples
cd examples
git checkout latest
```

```bash
cd clients/cloud/kotlin/
```

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

### Start Schema Registry service

Source: https://docs.confluent.io/platform/current/installation/upgrade.html

Start the Schema Registry service after installation with the configuration file.

```bash
schema-registry-start SR.properties
```

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

### Example output after starting Confluent Platform

Source: https://docs.confluent.io/platform/current/get-started/platform-quickstart.html

This shows the expected output after successfully starting Confluent Platform services using Docker Compose.

```text
✔ Network cp-all-in-one_default  Created       0.0s
✔ Container prometheus           Started       0.7s
✔ Container broker               Started       0.7s
✔ Container flink-jobmanager     Started       0.7s
✔ Container flink-sql-client     Started       0.7s
✔ Container flink-taskmanager    Started       0.7s
✔ Container alertmanager         Started       0.7s
✔ Container schema-registry      Started       0.7s
✔ Container connect              Started       0.7s
✔ Container rest-proxy           Started       0.7s
✔ Container ksqldb-server        Started       0.7s
✔ Container control-center       Started       0.8s
```

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

### Create examples directory

Source: https://docs.confluent.io/platform/current/multi-dc-deployments/cluster-linking/topic-data-sharing.html

Create a new directory to store all example configuration files for the clusters.

```bash
mkdir my-examples
```

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

### Change to Confluent Home Directory

Source: https://docs.confluent.io/platform/current/clusters/sbc/sbc-tutorial.html

Navigate to the Confluent Platform installation directory. This step is required before running any KRaft setup or server start commands.

```bash
cd $CONFLUENT_HOME
```

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

### BEGINNING Keyword Example

Source: https://docs.confluent.io/platform/current/ksqldb/reference/sql/keywords-and-operators.html

Print records from the start of a topic using the FROM BEGINNING clause.

```ksqlDB SQL
PRINT <topic-name> FROM BEGINNING;
```

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

### ksql-server-start Command Line Help

Source: https://docs.confluent.io/platform/current/ksqldb/installing.html

Displays the command-line options and usage for "ksql-server-start", including how to specify a configuration file and an optional queries file.

```text
NAME
        server - KSQL Cluster

SYNOPSIS
        server [ {-h | --help} ] [ --queries-file <queriesFile> ] [--]
                <config-file>

OPTIONS
        -h, --help
            Display help information

        --queries-file <queriesFile>
            Path to the query file on the local machine.

        --
            This option can be used to separate command-line options from the
            list of arguments (useful when arguments might be mistaken for
            command-line options)

        <config-file>
            A file specifying configs for the KSQL Server, KSQL, and its
            underlying Kafka Streams instance(s). Refer to KSQL documentation
            for a list of available configs.

```

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

### Standalone FileSink Connector Configuration

Source: https://docs.confluent.io/platform/current/connect/configuring.html

Properties file configuration for a standalone FileSink connector. This file should be passed to the Connect process via command line as described in the Getting Started guide.

```properties
name=local-file-sink
connector.class=FileStreamSinkConnector
tasks.max=1
file=test.sink.txt
topics=connect-test
```

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

### Guid

Source: https://docs.confluent.io/platform/current/clients/confluent-kafka-dotnet/_site/api/Confluent.SchemaRegistry.SchemaId.html

Gets or sets the schema GUID.

```APIDOC
## Property Guid

### Description
The schema GUID.

### Declaration
```csharp
public Guid? Guid { readonly get; set; }
```

### Property Value
- **Guid?** -
```

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

### Example: Initialize a new ksqlDB migrations project

Source: https://docs.confluent.io/platform/current/ksqldb/operate-and-deploy/migrations-tool.html

Demonstrates how to create a new migrations project at a specified path and connect it to a ksqlDB server running locally.

```bash
ksql-migrations new-project /my/migrations/project/path http://localhost:8088
```

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

### Navigate to Examples Directory

Source: https://docs.confluent.io/platform/current/multi-dc-deployments/multi-region-tutorial.html

Changes the current directory to the newly cloned 'examples' repository.

```bash
cd examples
```

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

### Example: Create a new ksqlDB migration file

Source: https://docs.confluent.io/platform/current/ksqldb/operate-and-deploy/migrations-tool.html

Demonstrates how to create a new migration file with a given description, using a specified configuration file for the project.

```bash
ksql-migrations --config-file /my/migrations/project/ksql-migrations.properties create Add_users
```

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

### Start ZooKeeper

Source: https://docs.confluent.io/platform/current/kafka/configure-mds/mutual-tls-auth-rbac.html

Command to start ZooKeeper server using the default configuration file from the Confluent Platform installation directory.

```bash
sudo zookeeper-server-start ${CONFLUENT_HOME}/etc/kafka/zookeeper.properties
```

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

### Example: Create a Kafka cluster on AWS

Source: https://docs.confluent.io/platform/current/schema-registry/fundamentals/serdes-develop/serdes-protobuf.html

An example command demonstrating how to create a Kafka cluster named 'quickstart_cluster' on AWS in the 'us-west-2' region.

```bash
confluent kafka cluster create quickstart_cluster --cloud "aws" --region "us-west-2"
```

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

### Topic v3: Get Topic Request

Source: https://docs.confluent.io/platform/current/api-javadoc/krest-redirect.html

Example HTTP GET request to retrieve a topic by its cluster ID and name.

```HTTP
GET /clusters/{cluster_id}/topics/{topic_name} HTTP/1.1
Host: example.com

```

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

### Example: Listing and Showing Tables

Source: https://docs.confluent.io/platform/current/ksqldb/developer-guide/ksqldb-reference/show-tables.html

Demonstrates how to use `LIST TABLES` to view currently registered tables and `SHOW TABLES EXTENDED` to retrieve detailed information about them.

```ksql
-- See the list of tables currently registered:
LIST TABLES;
```

```ksql
-- See extended information about currently registered tables:
SHOW TABLES EXTENDED;
```

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

### Navigate to Tutorial Directory and Checkout Branch

Source: https://docs.confluent.io/platform/current/streams/microservices-orders.html

Change into the microservices-orders directory and switch to the specified Confluent Platform release branch for the tutorial.

```bash
cd examples/microservices-orders
git checkout 8.2.0-post
```

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

### Get Environment by Name API Request

Source: https://docs.confluent.io/platform/current/api-javadoc/flink-redirect.html

Example HTTP GET request to retrieve details for a specific environment by its name.

```HTTP
GET /cmf/api/v1/environments/{envName} HTTP/1.1
Host: example.com

```

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

### Get Audit Log Configuration Request

Source: https://docs.confluent.io/platform/current/api-javadoc/mds-redirect.html

Example HTTP GET request to retrieve the entire audit log configuration.

```HTTP
GET /security/1.0/audit/config HTTP/1.1
Host: example.com

```

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

### Example: Initialize ksqlDB migrations metadata

Source: https://docs.confluent.io/platform/current/ksqldb/operate-and-deploy/migrations-tool.html

Demonstrates how to initialize the migrations metadata stream and table using a specified configuration file for the project.

```bash
ksql-migrations --config-file /my/migrations/project/ksql-migrations.properties initialize-metadata
```

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

### Start ksqlDB Server with Configuration File

Source: https://docs.confluent.io/platform/current/ksqldb/operate-and-deploy/installation/server-config.html

Command to start the ksqlDB server using a specified properties file.

```bash
<path-to-confluent>/bin/ksql-server-start <path-to-confluent>/etc/ksqldb/ksql-server.properties
```

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

### INSTR Function Examples in ksqlDB

Source: https://docs.confluent.io/platform/current/ksqldb/developer-guide/ksqldb-reference/scalar-functions.html

Examples demonstrating the INSTR function with various parameters for substring, start position, and occurrence count.

```ksql
-- returns  2
SELECT INSTR('CORPORATE FLOOR', 'OR');
```

```ksql
-- returns 5
SELECT INSTR('CORPORATE FLOOR', 'OR', 3);
```

```ksql
-- returns 14
SELECT INSTR('CORPORATE FLOOR', 'OR', 3, 2);
```

```ksql
-- returns 5
SELECT INSTR('CORPORATE FLOOR', 'OR', -3);
```

```ksql
-- returns 2
SELECT INSTR('CORPORATE FLOOR', 'OR', -3, 2);
```

```ksql
-- returns 0
SELECT INSTR('CORPORATE FLOOR', 'MISSING');
```

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

### Concrete Go Program Command-Line Example

Source: https://docs.confluent.io/platform/current/clients/app-development.html

Provides a specific example of running the Go Kafka consumer program with concrete server addresses and topic names.

```Shell
go run myprogram.go localhost:9092 http://localhost:8081 consumer-group-name my-topic

```

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

### GET Rolebindings by Principal Request

Source: https://docs.confluent.io/platform/current/security/rbac/mds-api.html

Example HTTP GET request to retrieve all rolebindings for a specified principal across all scopes and clusters.

```HTTP
GET /security/1.0/lookup/rolebindings/principal/{principal} HTTP/1.1
Host: example.com

```

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

### Get Share Group Consumer Request

Source: https://docs.confluent.io/platform/current/api-javadoc/krest-redirect.html

Example HTTP GET request to retrieve a specific consumer within a share group.

```HTTP
GET /clusters/{cluster_id}/share-groups/{group_id}/consumers/{consumer_id} HTTP/1.1
Host: example.com

```

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

### Get Cluster Link Configurations HTTP Request

Source: https://docs.confluent.io/platform/current/api-javadoc/krest-redirect.html

Example HTTP GET request to list all configurations for a specified cluster link.

```http
GET /clusters/{cluster_id}/links/{link_name}/configs HTTP/1.1
Host: example.com
```

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

### Navigate to Rust client example directory

Source: https://docs.confluent.io/platform/current/clients/examples/rust.html

Change to the Rust client example directory after cloning the repository.

```bash
cd clients/cloud/rust/
```

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

### Start ksqlDB Server

Source: https://docs.confluent.io/platform/current/clusters/sbc/sbc-tutorial.html

Run this command to start the ksqlDB server, specifying its configuration properties file.

```bash
ksql-server-start $CONFLUENT_HOME/etc/ksqldb/ksql-server.properties
```

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

### Get Specific Broker Configuration (HTTP)

Source: https://docs.confluent.io/platform/current/api-javadoc/krest-redirect.html

Example HTTP GET request to retrieve a specific configuration parameter for a Kafka broker.

```HTTP
GET /clusters/{cluster_id}/brokers/{broker_id}/configs/{name} HTTP/1.1
Host: example.com
```

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

### Navigate to Multi-Datacenter Example Directory

Source: https://docs.confluent.io/platform/current/multi-dc-deployments/replicator/replicator-docker-tutorial.html

Changes the current directory to the `multi-datacenter` examples folder after cloning the repository.

```bash
cd multi-datacenter/
```

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

### Retrieve Savepoints HTTP GET Request

Source: https://docs.confluent.io/platform/current/api-javadoc/flink-redirect.html

Example HTTP GET request to retrieve a paginated list of savepoints for a Flink statement.

```HTTP
GET /cmf/api/v1/environments/{envName}/statements/{stmtName}/savepoints HTTP/1.1
Host: example.com
```

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

### Retrieve All Kafka Catalogs (HTTP GET)

Source: https://docs.confluent.io/platform/current/api-javadoc/flink-redirect.html

Example HTTP GET request to retrieve a paginated list of all configured Kafka Catalogs.

```HTTP
GET /cmf/api/v1/catalogs/kafka HTTP/1.1
Host: example.com
```

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

### Example ksqlDB Server Configuration File

Source: https://docs.confluent.io/platform/current/ksqldb/operate-and-deploy/installation/server-config.html

Shows how to configure Kafka bootstrap servers and ksqlDB listeners in the server properties file.

```properties
bootstrap.servers=localhost:9092
listeners=http://localhost:8088
```

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

### Start ksqlDB CLI and Connect to Server

Source: https://docs.confluent.io/platform/current/ksqldb/installing.html

Launches the ksqlDB CLI, connects to a specified ksqlDB server, and overrides the default log directory to prevent potential permission errors.

```bash
LOG_DIR=./ksql_logs ${CONFLUENT_HOME}/bin/ksql http://localhost:8088
```

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

### Retrieve Statements GET Request

Source: https://docs.confluent.io/platform/current/api-javadoc/flink-redirect.html

Example HTTP GET request to fetch a paginated list of statements within a specified environment.

```http
GET /cmf/api/v1/environments/{envName}/statements HTTP/1.1
Host: example.com

```

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

### Get All Schema Exporters Request

Source: https://docs.confluent.io/platform/current/api-javadoc/sr-redirect.html

Example HTTP GET request to retrieve a list of all configured schema exporters from the Schema Registry.

```HTTP
GET /exporters HTTP/1.1
Host: schemaregistry.example.com
Accept: application/vnd.schemaregistry.v1+json, application/vnd.schemaregistry+json, application/json
```

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

### Example: Running a ksqlDB Script File

Source: https://docs.confluent.io/platform/current/ksqldb/developer-guide/ksqldb-reference/run-script.html

Demonstrates how to execute a ksqlDB script file located at a specific local path using `RUN SCRIPT`.

```sql
RUN SCRIPT '/local/path/to/queries.sql';
```

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

### GET Broker Tasks Request Example

Source: https://docs.confluent.io/platform/current/api-javadoc/krest-redirect.html

Example HTTP request to list broker tasks of a specific type for a given cluster.

```http
GET /clusters/{cluster_id}/brokers/-/tasks/{task_type} HTTP/1.1
Host: example.com

```

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

### Start ksqlDB CLI in Docker

Source: https://docs.confluent.io/platform/current/ksqldb/operate-and-deploy/installation/install-ksqldb-with-docker.html

Launch the ksqlDB interactive CLI and connect to a server instance. Specify the server URL as an argument.

```bash
# Start the CLI and connect to a KSQLDB server
docker run -it confluentinc/cp-ksqldb-server ksqldb-cli [ksql-server-url]
```

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

### Navigate to Multi-Region Tutorial Directory

Source: https://docs.confluent.io/platform/current/multi-dc-deployments/multi-region-tutorial.html

Changes the current directory to the 'multiregion' subdirectory within the examples.

```bash
cd multiregion
```

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

### Property: Guid

Source: https://docs.confluent.io/platform/current/clients/confluent-kafka-dotnet/_site/api/Confluent.SchemaRegistry.Association.html

Gets or sets the globally unique identifier.

```APIDOC
## Property: Guid

### Description
The globally unique identifier.

### Declaration
```csharp
[JsonProperty("guid")]
public string Guid { get; set; }
```

### Property Value
- **Type**: string
```

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

### Example Usage of SHOW STREAMS and LIST STREAMS

Source: https://docs.confluent.io/platform/current/ksqldb/developer-guide/ksqldb-reference/show-streams.html

Illustrates how to list all currently registered streams and how to retrieve extended information for them.

```ksqlDB
-- See the list of streams currently registered:
SHOW STREAMS;

-- See extended information about currently registered streams:
LIST STREAMS EXTENDED;
```

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

### Example Request to Get Statement Status

Source: https://docs.confluent.io/platform/current/ksqldb/developer-guide/ksqldb-rest-api/status-endpoint.html

This HTTP GET request demonstrates how to query the status of a ksqlDB statement using its command ID.

```HTTP
GET /status/stream/PAGEVIEWS/create HTTP/1.1
Accept: application/vnd.ksql.v1+json
Content-Type: application/vnd.ksql.v1+json

```

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

### Navigate to Scala client example directory

Source: https://docs.confluent.io/platform/current/clients/examples/scala.html

Change to the Scala client example directory within the cloned repository.

```bash
cd clients/cloud/scala/
```

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

### Get Specific Kafka Cluster HTTP Request

Source: https://docs.confluent.io/platform/current/api-javadoc/krest-redirect.html

Example HTTP GET request to retrieve details for a specific Kafka cluster by its ID.

```HTTP
GET /clusters/{cluster_id} HTTP/1.1
Host: example.com

```

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

### Navigate to kcat example directory (Bash)

Source: https://docs.confluent.io/platform/current/clients/examples/kcat.html

Change the current directory to the specific kcat example folder within the cloned `examples` repository.

```bash
cd clients/cloud/kcat/
```

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

### Navigate to Ruby Client Example Directory

Source: https://docs.confluent.io/platform/current/clients/examples/ruby.html

Change the current directory to the Ruby client example folder within the cloned repository.

```bash
cd clients/cloud/ruby/
```

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

### GET Kafka Database Request

Source: https://docs.confluent.io/platform/current/api-javadoc/flink-redirect.html

Example HTTP GET request line to retrieve a specific Kafka Database by catalog and database name.

```HTTP
GET /cmf/api/v1/catalogs/kafka/{catName}/databases/{dbName} HTTP/1.1
Host: example.com
```

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

### GET /security/1.0/lookup/rolebindings/principal/{principal} Request

Source: https://docs.confluent.io/platform/current/api-javadoc/mds-redirect.html

Example HTTP GET request to list all rolebindings for a specified principal across all scopes and clusters that have any rolebindings.

```HTTP
GET /security/1.0/lookup/rolebindings/principal/{principal} HTTP/1.1
Host: example.com
```

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

### Navigate to Clickstream Directory and Checkout Branch

Source: https://docs.confluent.io/platform/current/ksqldb/tutorials/clickstream.html

Change into the `examples/clickstream` directory and switch to the specified Confluent Platform release branch for the tutorial.

```bash
cd examples/clickstream
git checkout 8.2.0-post
```

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

### Initialize ksqlDB Java Client with Connection Options

Source: https://docs.confluent.io/platform/current/ksqldb/developer-guide/java-client/java-client.html

Basic example application that creates a Client instance with host and port configuration. Call client.close() to terminate connections when done.

```java
package my.ksqldb.app;

import io.confluent.ksql.api.client.Client;
import io.confluent.ksql.api.client.ClientOptions;

public class ExampleApp {

  public static String KSQLDB_SERVER_HOST = "localhost";
  public static int KSQLDB_SERVER_HOST_PORT = 8088;

  public static void main(String[] args) {
    ClientOptions options = ClientOptions.create()
        .setHost(KSQLDB_SERVER_HOST)
        .setPort(KSQLDB_SERVER_HOST_PORT);
    Client client = Client.create(options);

    // Send requests with the client by following the other examples

    // Terminate any open connections and close the client
    client.close();
  }
}
```

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

### Start Kafka Server (TAR/ZIP Upgrade)

Source: https://docs.confluent.io/platform/current/installation/upgrade.html

Command to start the Kafka server daemon after a TAR/ZIP archive upgrade, specifying the new installation path.

```bash
sudo confluent-8.2.0/bin/kafka-server-start -daemon /etc/kafka/server.properties
```

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

### Get DEK Subjects API Request

Source: https://docs.confluent.io/platform/current/schema-registry/develop/api.html

This example shows how to send a GET request to retrieve a list of all Data Encryption Keys for a specified KEK.

```HTTP
GET /dek-registry/v1/keks/my-kek/deks HTTP/1.1
Host: schemaregistry.example.com
Accept: application/vnd.schemaregistry.v1+json, application/vnd.schemaregistry+json, application/json

```

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

### Navigate to Avro client examples directory

Source: https://docs.confluent.io/platform/current/schema-registry/schema_registry_tutorial.html

Change the current directory to the 'clients/avro' subdirectory within the cloned examples repository.

```bash
cd examples/clients/avro
```

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

### Get Broker Request (HTTP)

Source: https://docs.confluent.io/platform/current/api-javadoc/krest-redirect.html

Example HTTP GET request to retrieve details for a specific Kafka broker using its cluster and broker IDs.

```HTTP
GET /clusters/{cluster_id}/brokers/{broker_id} HTTP/1.1
Host: example.com
```

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

### Navigate to Connect Streams Pipeline Example Directory

Source: https://docs.confluent.io/platform/current/streams/connect-streams-pipeline.html

Change the current directory to the specific `connect-streams-pipeline` example folder.

```bash
cd connect-streams-pipeline
```

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

### Start Schema Registry Server

Source: https://docs.confluent.io/platform/current/clusters/sbc/sbc-tutorial.html

Use this command to start the Schema Registry server with its specified configuration file.

```bash
schema-registry-start $CONFLUENT_HOME/etc/schema-registry/schema-registry.properties
```

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

### Get Specific Topic Metadata (Request)

Source: https://docs.confluent.io/platform/current/api-javadoc/krest-redirect.html

Example HTTP GET request to retrieve metadata for a specific Kafka topic, 'test', from the REST Proxy.

```HTTP
GET /topics/test HTTP/1.1
Accept: application/vnd.kafka.v2+json

```

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

### Run Clickstream Tutorial Script

Source: https://docs.confluent.io/platform/current/ksqldb/tutorials/clickstream.html

Execute the `start.sh` script to automate all steps of the clickstream tutorial end-to-end.

```bash
./start.sh
```

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

### Get Environment by Name API 200 OK Response

Source: https://docs.confluent.io/platform/current/api-javadoc/flink-redirect.html

Example JSON response for a successful request to get a specific environment, showing its details.

```JSON
HTTP/1.1 200 OK
Content-Type: application/json

{
    "name": "string",
    "created_time": "2026-05-03T22:38:56.512832",
    "updated_time": "2026-05-03T22:38:56.512832",
    "flinkApplicationDefaults": {},
    "kubernetesNamespace": "string",
    "kubernetesClusterName": "string",
    "computePoolDefaults": {},
    "statementDefaults": {
        "detached": {
            "flinkConfiguration": {}
        },
        "interactive": {
            "flinkConfiguration": {}
        }
    },
    "metadata": {
        "name": "string",
        "creationTimestamp": "string",
        "updateTimestamp": "string",
        "labels": {},
        "annotations": {}
    }
}

```

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

### Run Avro Producer Example

Source: https://docs.confluent.io/platform/current/schema-registry/schema_registry_tutorial.html

Execute the ProducerExample class to produce Avro-formatted messages to the transactions topic, passing the configuration file path as an argument.

```bash
mvn exec:java -Dexec.mainClass=io.confluent.examples.clients.basicavro.ProducerExample \
  -Dexec.args="$HOME/.confluent/java.config"
```

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

### start(Map<String,String> props)

Source: https://docs.confluent.io/platform/current/connect/javadocs/javadoc/org/apache/kafka/connect/sink/SinkTask.html

Starts the Task, handling configuration parsing and one-time setup. This method is invoked when the task is first launched.

```APIDOC
## start(Map<String,String> props)

### Description
Start the Task. This should handle any configuration parsing and one-time setup of the task.

### Method
public abstract void

### Parameters
#### Path Parameters
- **props** (Map<String,String>) - initial configuration
```

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

### EXPLAIN Keyword Example

Source: https://docs.confluent.io/platform/current/ksqldb/reference/sql/keywords-and-operators.html

Show the execution plan for a ksqlDB query or expression.

```ksqlDB SQL
EXPLAIN <query-name>;
```

```ksqlDB SQL
EXPLAIN <expression>;
```

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

### Get Consumer Group Assignments HTTP Request

Source: https://docs.confluent.io/platform/current/api-javadoc/krest-redirect.html

Example HTTP GET request to retrieve the partition assignments for a specific consumer within a consumer group.

```HTTP
GET /clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers/{consumer_id}/assignments HTTP/1.1
Host: example.com

```

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

### Get Specific Topic Configuration (v3) Request

Source: https://docs.confluent.io/platform/current/api-javadoc/krest-redirect.html

Example HTTP GET request to retrieve a single configuration parameter for a Kafka topic using its name.

```http
GET /clusters/{cluster_id}/topics/{topic_name}/configs/{name} HTTP/1.1
Host: example.com
```

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

### Start Confluent Cloud microservices example

Source: https://docs.confluent.io/platform/current/streams/microservices-orders.html

Execute the startup script to deploy the microservices stack using ccloud-stack utility, which automatically creates managed services in Confluent Cloud.

```bash
./start-ccloud.sh
```

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

### Syntax for new-project command

Source: https://docs.confluent.io/platform/current/ksqldb/operate-and-deploy/migrations-tool.html

Shows the general syntax for initializing a new ksqlDB migrations project, specifying the project path and ksqlDB server URL.

```bash
ksql-migrations new-project [--] <project-path> <ksql-server-url>
```

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

### Retrieve Flink Statement HTTP GET Request

Source: https://docs.confluent.io/platform/current/api-javadoc/flink-redirect.html

Example HTTP GET request to retrieve a specific Flink statement using its environment and statement names.

```http
GET /cmf/api/v1/environments/{envName}/statements/{stmtName} HTTP/1.1
Host: example.com

```

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

### Retrieve Environment Secret Mappings Request (GET)

Source: https://docs.confluent.io/platform/current/api-javadoc/flink-redirect.html

Example HTTP GET request to retrieve a paginated list of Environment Secret Mappings for a given environment.

```http
GET /cmf/api/v1/environments/{envName}/secret-mappings HTTP/1.1
Host: example.com
```

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

### Navigate to schema translation example directory

Source: https://docs.confluent.io/platform/current/multi-dc-deployments/replicator/replicator-schema-translation.html

Change to the replicator-schema-translation example directory.

```bash
cd examples/replicator-schema-translation
```

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

### Start Kafka brokers

Source: https://docs.confluent.io/platform/current/schema-registry/schema-linking-cp.html

Start both Kafka broker instances with their respective configuration files.

```bash
kafka-server-start $CONFLUENT_CONFIG/server0.properties
```

```bash
kafka-server-start $CONFLUENT_CONFIG/server1.properties
```

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

### Get Subject-Level Compatibility Configuration (HTTP Request)

Source: https://docs.confluent.io/platform/current/api-javadoc/sr-redirect.html

This example demonstrates an HTTP GET request to fetch the compatibility level for a specific subject in the Schema Registry.

```HTTP
GET /config/test HTTP/1.1
Host: schemaregistry.example.com
Accept: application/vnd.schemaregistry.v1+json, application/vnd.schemaregistry+json, application/json

```

```HTTP
HTTP/1.1 200 OK
Content-Type: application/vnd.schemaregistry.v1+json

{
   "compatibilityLevel": "FULL"
}

```

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

### List Topic Configs: Example Request

Source: https://docs.confluent.io/platform/current/api-javadoc/krest-redirect.html

This example shows how to construct an HTTP GET request to retrieve the list of configuration parameters for a specific Kafka topic.

```HTTP
GET /clusters/{cluster_id}/topics/{topic_name}/configs HTTP/1.1
Host: example.com

```

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

### Connect ksqlDB CLI to Local and Remote Servers

Source: https://docs.confluent.io/platform/current/ksqldb/operate-and-deploy/installation/install-ksqldb-with-docker.html

Examples showing how to connect the CLI to localhost or a remote ksqlDB server instance.

```bash
# Start the CLI and connect to localhost server
docker run -it confluentinc/cp-ksqldb-server ksqldb-cli http://localhost:8088
```

```bash
# Start the CLI and connect to a remote server
docker run -it confluentinc/cp-ksqldb-server ksqldb-cli http://ksqldb-server:8088
```

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

### Build Groovy Kafka client examples with Gradle

Source: https://docs.confluent.io/platform/current/clients/examples/groovy.html

Command to clean and build the Groovy Kafka client examples using Gradle.

```bash
./gradlew clean build
```

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

### GET Environment Secret Mapping Example Request

Source: https://docs.confluent.io/platform/current/api-javadoc/flink-redirect.html

Example HTTP request to retrieve a specific environment secret mapping by its name within a given environment.

```HTTP
GET /cmf/api/v1/environments/{envName}/secret-mappings/{name} HTTP/1.1
Host: example.com

```

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

### Go Program Command-Line Usage Example

Source: https://docs.confluent.io/platform/current/clients/app-development.html

Illustrates the general command-line format for running the Go Kafka consumer program with placeholders for configuration.

```Shell
go run myprogram.go <bootstrap-servers> <schema-registry> <group> <topic>

```