# sql

> For the complete documentation index, see [llms.txt](https://docs.redpanda.com/llms.txt). Component-specific: [connect-full.txt](https://docs.redpanda.com/connect-full.txt)

---
title: sql
latest-connect-version: 4.93.0
latest-operator-version: v26.1.4
latest-console-tag: v3.7.3
latest-redpanda-tag: v26.1.9
docname: caches/sql
page-component-name: connect
page-version: master
page-component-version: master
page-component-title: Connect
page-relative-src-path: caches/sql.adoc
page-edit-url: https://github.com/redpanda-data/rp-connect-docs/edit/main/modules/components/pages/caches/sql.adoc
page-git-created-date: "2024-05-24"
page-git-modified-date: "2026-05-26"
---

<!-- Source: https://docs.redpanda.com/connect/components/caches/sql.md -->

**Type:** Cache ▼

[Cache](https://docs.redpanda.com/connect/components/caches/sql/)[Output](https://docs.redpanda.com/connect/components/outputs/sql/)[Processor](https://docs.redpanda.com/connect/components/processors/sql/)

**Available in:** [Cloud](https://docs.redpanda.com/cloud-data-platform/develop/connect/components/caches/sql/%20%22View%20the%20Cloud%20version%20of%20this%20component%22), Self-Managed

Uses an SQL database table as a destination for storing cache key/value items.

Introduced in version 4.26.0.

#### Common

```yml
caches:
  sql:
    driver: "" # No default (required)
    dsn: "" # No default (required)
    table: "" # No default (required)
    key_column: "" # No default (required)
    value_column: "" # No default (required)
    set_suffix: "" # No default (optional)
```

#### Advanced

```yml
caches:
  sql:
    driver: "" # No default (required)
    dsn: "" # No default (required)
    table: "" # No default (required)
    key_column: "" # No default (required)
    value_column: "" # No default (required)
    set_suffix: "" # No default (optional)
    init_files: [] # No default (optional)
    init_statement: "" # No default (optional)
    conn_max_idle_time: "" # No default (optional)
    conn_max_life_time: "" # No default (optional)
    conn_max_idle: 2
    conn_max_open: "" # No default (optional)
```

Each cache key/value pair will exist as a row within the specified table. Currently only the key and value columns are set, and therefore any other columns present within the target table must allow NULL values if this cache is going to be used for set and add operations.

Cache operations are translated into SQL statements as follows:

## [](#get)Get

All `get` operations are performed with a traditional `select` statement.

## [](#delete)Delete

All `delete` operations are performed with a traditional `delete` statement.

## [](#set)Set

The `set` operation is performed with a traditional `insert` statement.

This will behave as an `add` operation by default, and so ideally needs to be adapted in order to provide updates instead of failing on collision s. Since different SQL engines implement upserts differently it is necessary to specify a `set_suffix` that modifies an `insert` statement in order to perform updates on conflict.

## [](#add)Add

The `add` operation is performed with a traditional `insert` statement.

## [](#fields)Fields

### [](#conn_max_idle)`conn_max_idle`

An optional maximum number of connections in the idle connection pool. If conn\_max\_open is greater than 0 but less than the new conn\_max\_idle, then the new conn\_max\_idle will be reduced to match the conn\_max\_open limit. If `value ⇐ 0`, no idle connections are retained. The default max idle connections is currently 2. This may change in a future release.

**Type**: `int`

**Default**: `2`

### [](#conn_max_idle_time)`conn_max_idle_time`

An optional maximum amount of time a connection may be idle. Expired connections may be closed lazily before reuse. If `value ⇐ 0`, connections are not closed due to a connections idle time.

**Type**: `string`

### [](#conn_max_life_time)`conn_max_life_time`

An optional maximum amount of time a connection may be reused. Expired connections may be closed lazily before reuse. If `value ⇐ 0`, connections are not closed due to a connections age.

**Type**: `string`

### [](#conn_max_open)`conn_max_open`

An optional maximum number of open connections to the database. If conn\_max\_idle is greater than 0 and the new conn\_max\_open is less than conn\_max\_idle, then conn\_max\_idle will be reduced to match the new conn\_max\_open limit. If `value ⇐ 0`, then there is no limit on the number of open connections. The default is 0 (unlimited).

**Type**: `int`

### [](#driver)`driver`

A database [driver](#drivers) to use.

**Type**: `string`

**Options**: `mysql`, `postgres`, `pgx`, `clickhouse`, `mssql`, `sqlite`, `oracle`, `snowflake`, `trino`, `gocosmos`, `spanner`, `databricks`

### [](#dsn)`dsn`

A Data Source Name to identify the target database.

#### [](#drivers)Drivers

The following is a list of supported drivers, their placeholder style, and their respective DSN formats:

| Driver | Data Source Name Format |
| --- | --- |
| clickhouse | clickhouse://[username[:password]@][netloc][:port]/dbname[?param1=value1&…​&paramN=valueN] |
| mysql | [username[:password]@][protocol[(address)]]/dbname[?param1=value1&…​&paramN=valueN] |
| postgres and pgx | postgres://[user[:password]@][netloc][:port][/dbname][?param1=value1&…​] |
| mssql | sqlserver://[user[:password]@][netloc][:port][?database=dbname&param1=value1&…​] |
| sqlite | file:/path/to/filename.db[?param&=value1&…​] |
| oracle | oracle://[username[:password]@][netloc][:port]/service_name?server=server2&server=server3 |
| snowflake | username[:password]@account_identifier/dbname/schemaname[?param1=value&…​&paramN=valueN] |
| trino | http[s]://user[:pass]@host[:port][?parameters] |
| gocosmos | AccountEndpoint=<cosmosdb-endpoint>;AccountKey=<cosmosdb-account-key>[;TimeoutMs=<timeout-in-ms>][;Version=<cosmosdb-api-version>][;DefaultDb/Db=<db-name>][;AutoId=<true/false>][;InsecureSkipVerify=<true/false>] |
| spanner | projects/[PROJECT]/instances/[INSTANCE]/databases/[DATABASE] |
| databricks | token:<access-token>@<server-hostname>:<port>/<http-path> |

Please note that the `postgres` and `pgx` drivers enforce SSL by default, you can override this with the parameter `sslmode=disable` if required. The `pgx` driver is an alternative to the standard `postgres` (pq) driver and comes with extra functionality such as support for array insertion.

The `snowflake` driver supports multiple DSN formats. Please consult [the docs](https://pkg.go.dev/github.com/snowflakedb/gosnowflake#hdr-Connection_String) for more details. For [key pair authentication](https://docs.snowflake.com/en/user-guide/key-pair-auth.html#configuring-key-pair-authentication), the DSN has the following format: `<snowflake_user>@<snowflake_account>/<db_name>/<schema_name>?warehouse=<warehouse>&role=<role>&authenticator=snowflake_jwt&privateKey=<base64_url_encoded_private_key>`, where the value for the `privateKey` parameter can be constructed from an unencrypted RSA private key file `rsa_key.p8` using `openssl enc -d -base64 -in rsa_key.p8 | basenc --base64url -w0` (you can use `gbasenc` instead of `basenc` on OSX if you install `coreutils` via Homebrew). If you have a password-encrypted private key, you can decrypt it using `openssl pkcs8 -in rsa_key_encrypted.p8 -out rsa_key.p8`. Also, make sure fields such as the username are URL-encoded.

The [`gocosmos`](https://pkg.go.dev/github.com/microsoft/gocosmos) driver is still experimental, but it has support for [hierarchical partition keys](https://learn.microsoft.com/en-us/azure/cosmos-db/hierarchical-partition-keys) as well as [cross-partition queries](https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/how-to-query-container#cross-partition-query). Please refer to the [SQL notes](https://github.com/microsoft/gocosmos/blob/main/SQL.md) for details.

**Type**: `string`

```yaml
# Examples:
dsn: clickhouse://username:password@host1:9000,host2:9000/database?dial_timeout=200ms&max_execution_time=60

# ---

dsn: foouser:foopassword@tcp(localhost:3306)/foodb

# ---

dsn: postgres://foouser:foopass@localhost:5432/foodb?sslmode=disable

# ---

dsn: oracle://foouser:foopass@localhost:1521/service_name

# ---

dsn: token:dapi1234567890ab@dbc-a1b2345c-d6e7.cloud.databricks.com:443/sql/1.0/warehouses/abc123def456
```

### [](#init_files)`init_files[]`

An optional list of file paths containing SQL statements to execute immediately upon the first connection to the target database. This is a useful way to initialise tables before processing data. Glob patterns are supported, including super globs (double star).

Care should be taken to ensure that the statements are idempotent, and therefore would not cause issues when run multiple times after service restarts. If both `init_statement` and `init_files` are specified the `init_statement` is executed _after_ the `init_files`.

If a statement fails for any reason a warning log will be emitted but the operation of this component will not be stopped.

Requires version 4.10.0 or later.

**Type**: `array`

```yaml
# Examples:
init_files:
  - ./init/*.sql

# ---

init_files:
  - ./foo.sql
  - ./bar.sql
```

### [](#init_statement)`init_statement`

An optional SQL statement to execute immediately upon the first connection to the target database. This is a useful way to initialise tables before processing data. Care should be taken to ensure that the statement is idempotent, and therefore would not cause issues when run multiple times after service restarts.

If both `init_statement` and `init_files` are specified the `init_statement` is executed _after_ the `init_files`.

If the statement fails for any reason a warning log will be emitted but the operation of this component will not be stopped.

Requires version 4.10.0 or later.

**Type**: `string`

```yaml
# Examples:
init_statement: |-

  CREATE TABLE IF NOT EXISTS some_table (
    foo varchar(50) not null,
    bar integer,
    baz varchar(50),
    primary key (foo)
  ) WITHOUT ROWID;
```

### [](#key_column)`key_column`

The name of a column to be used for storing cache item keys. This column should support strings of arbitrary size.

**Type**: `string`

```yaml
# Examples:
key_column: foo
```

### [](#set_suffix)`set_suffix`

An optional suffix to append to each insert query for a cache `set` operation. This should modify an insert statement into an upsert appropriate for the given SQL engine.

**Type**: `string`

```yaml
# Examples:
set_suffix: ON DUPLICATE KEY UPDATE bar=VALUES(bar)

# ---

set_suffix: ON CONFLICT (foo) DO UPDATE SET bar=excluded.bar

# ---

set_suffix: ON CONFLICT (foo) DO NOTHING
```

### [](#table)`table`

The table to insert/read/delete cache items.

**Type**: `string`

```yaml
# Examples:
table: foo
```

### [](#value_column)`value_column`

The name of a column to be used for storing cache item values. This column should support strings of arbitrary size.

**Type**: `string`

```yaml
# Examples:
value_column: bar
```