# sql_insert

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

---
title: sql_insert
latest-operator-version: v26.1.4
latest-console-tag: v3.7.3
latest-connect-version: 4.93.0
latest-redpanda-tag: v26.1.9
docname: connect/components/processors/sql_insert
page-component-name: cloud-data-platform
page-version: master
page-component-version: master
page-component-title: Cloud
page-relative-src-path: connect/components/processors/sql_insert.adoc
page-edit-url: https://github.com/redpanda-data/cloud-docs/edit/main/modules/develop/pages/connect/components/processors/sql_insert.adoc
page-git-created-date: "2024-09-09"
page-git-modified-date: "2026-05-26"
---

<!-- Source: https://docs.redpanda.com/cloud-data-platform/develop/connect/components/processors/sql_insert.md -->

**Type:** Processor ▼

[Processor](https://docs.redpanda.com/cloud-data-platform/develop/connect/components/processors/sql_insert/)[Output](https://docs.redpanda.com/cloud-data-platform/develop/connect/components/outputs/sql_insert/)

**Available in:** Cloud, [Self-Managed](https://docs.redpanda.com/connect/components/processors/sql_insert/%20%22View%20the%20Self-Managed%20version%20of%20this%20component%22)

Inserts rows into an SQL database for each message, and leaves the message unchanged.

#### Common

```yml
processors:
  label: ""
  sql_insert:
    driver: "" # No default (required)
    dsn: "" # No default (required)
    table: "" # No default (required)
    columns: [] # No default (required)
    args_mapping: "" # No default (required)
```

#### Advanced

```yml
processors:
  label: ""
  sql_insert:
    driver: "" # No default (required)
    dsn: "" # No default (required)
    table: "" # No default (required)
    columns: [] # No default (required)
    args_mapping: "" # No default (required)
    prefix: "" # No default (optional)
    suffix: "" # No default (optional)
    options: [] # 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)
```

If the insert fails to execute then the message will still remain unchanged and the error can be caught using [error handling methods](https://docs.redpanda.com/cloud-data-platform/develop/connect/configuration/error_handling/).

## [](#examples)Examples

### [](#table-insert-mysql)Table Insert (MySQL)

Here we insert rows into a database by populating the columns id, name and topic with values extracted from messages and metadata:

```yaml
pipeline:
  processors:
    - sql_insert:
        driver: mysql
        dsn: foouser:foopassword@tcp(localhost:3306)/foodb
        table: footable
        columns: [ id, name, topic ]
        args_mapping: |
          root = [
            this.user.id,
            this.user.name,
            meta("kafka_topic"),
          ]
```

## [](#dynamic-sql-operations)Dynamic SQL operations

The `table` and `columns` fields are static strings that do not support Bloblang interpolation. For dynamic table names, dynamic column lists, DELETE operations, or any other SQL that `sql_insert` cannot express, use the [`sql_raw` processor](https://docs.redpanda.com/cloud-data-platform/develop/connect/components/processors/sql_raw/) instead. To use Bloblang interpolation inside ``sql_raw’s `query`` field, you must enable `unsafe_dynamic_query: true`.

> ⚠️ **CAUTION**
>
> Interpolating unsanitized values into a query can introduce SQL injection risks. Always validate or sanitize the interpolated value beforehand.

## [](#fields)Fields

### [](#args_mapping)`args_mapping`

A [Bloblang mapping](https://docs.redpanda.com/cloud-data-platform/develop/connect/guides/bloblang/about/) which should evaluate to an array of values matching in size to the number of columns specified.

**Type**: `string`

```yaml
# Examples:
args_mapping: root = [ this.cat.meow, this.doc.woofs[0] ]

# ---

args_mapping: root = [ meta("user.id") ]
```

### [](#columns)`columns[]`

A list of columns to insert.

**Type**: `array`

```yaml
# Examples:
columns:
  - foo
  - bar
  - baz
```

### [](#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.

**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.

**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;
```

### [](#options)`options[]`

A list of keyword options to add before the INTO clause of the query.

**Type**: `array`

```yaml
# Examples:
options:
  - DELAYED
  - IGNORE
```

### [](#prefix)`prefix`

An optional prefix to prepend to the insert query (before INSERT).

**Type**: `string`

### [](#suffix)`suffix`

An optional suffix to append to the insert query.

**Type**: `string`

```yaml
# Examples:
suffix: ON CONFLICT (name) DO NOTHING
```

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

The table to insert to.

**Type**: `string`

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