> For the complete documentation index, see [llms.txt](https://upsolver.gitbook.io/content/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://upsolver.gitbook.io/content/reference-1/sql-commands/connections/create-connection/clickhouse.md).

# ClickHouse

A ClickHouse connection is used to support exporting/loading data from your Upsolver tables into ClickHouse.&#x20;

## Syntax

```sql
CREATE CLICKHOUSE <connection_identifier> 
    CONNECTION_STRING = '<connection_string>' 
    USER_NAME = '<user_name>'
    PASSWORD = '<password>' 
    [ COMMENT = '<comment>' ]
```

#### Jump to

* [`CONNECTION_STRING`](#connection_string-editable)
* [`USER_NAME`](#user_name-editable-with-password)
* [`PASSWORD`](#password-editable-with-user_name)
* [`COMMENT`](#comment-editable)

## Connection options

#### `CONNECTION_STRING` — editable

Type: `text`

The connection string to use when connecting to ClickHouse. Syntax should be as follows:

`protocol://host[:port][/database][?param[=value][&param[=value]][#tag[,tag]]`

The ClickHouse documentation for creating a connection string can be found [here](https://clickhouse.com/docs/en/integrations/java#connect-to-clickhouse).

#### `USER_NAME` — editable

Type: `text`

The user for authenticating to the database.

#### `PASSWORD` — editable

Type: `text`

The password to use for authentication.&#x20;

#### `COMMENT` — editable

Type: `text`

(Optional) A description or comment regarding this connection.

## &#x20;Example

```sql
CREATE CLICKHOUSE CONNECTION my_clickhouse_connection
    CONNECTION_STRING = 'http://<host_name>:8123/<db_name>'
    USER_NAME = 'your username'
    PASSWORD = 'your password';
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://upsolver.gitbook.io/content/reference-1/sql-commands/connections/create-connection/clickhouse.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
