> ## Documentation Index
> Fetch the complete documentation index at: https://clickhouse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 如何在 Docker 中设置 ClickHouse，并通过 ODBC 连接到 Microsoft SQL Server (MSSQL) 数据库

> 如何在 Docker 中设置 ClickHouse，并通过 ODBC 连接到 Microsoft SQL Server (MSSQL) 数据库

export const Image = ({img, alt, size = "lg"}) => {
  const normalizedSize = ["sm", "md", "lg"].includes(size) ? size : "lg";
  return <div className={`ch-image-${normalizedSize}`}>
      <Frame>
        <img src={img} alt={alt} />
      </Frame>
    </div>;
};

{frontMatter.description}

<div id="question">
  ## 问题
</div>

如何使用 Docker 镜像部署 ClickHouse 并连接到 Microsoft SQL Server？

<div id="answer">
  ## 答案
</div>

***本示例的说明***

* 使用 ClickHouse Docker Ubuntu 镜像
* 使用 FreeTDS 驱动程序
* 使用 MSSQL Server 2012R2
* 本示例中的 Windows 主机名为 `MARSDB2.marsnet2.local`，IP 地址为：`192.168.1.133` (请替换为你的主机名和/或 IP)
* MSSQL 实例名称为 `MARSDB2`
* MSSQL 登录用户和数据库用户均为 `sql_user`

<div id="example-setup-in-mssql-for-testing-">
  ### MSSQL 测试示例配置
</div>

在 MSSQL 中创建的数据库和表：

<Image img="https://mintcdn.com/private-7c7dfe99/mWK0LIJWA-YNz_kU/images/knowledgebase/ikb273/c8a5492f-5910-4454-bfbc-5c6ceda15ccd.webp?fit=max&auto=format&n=mWK0LIJWA-YNz_kU&q=85&s=176761966adb26eb258e2e5e1d771112" size="md" alt="MSSQL 数据库和表结构" border width="501" height="233" data-path="images/knowledgebase/ikb273/c8a5492f-5910-4454-bfbc-5c6ceda15ccd.webp" />

MSSQL 登录用户 `sql_user`：

<Image img="https://mintcdn.com/private-7c7dfe99/mWK0LIJWA-YNz_kU/images/knowledgebase/ikb273/568f1143-475e-422f-a26a-2c23ac324771.webp?fit=max&auto=format&n=mWK0LIJWA-YNz_kU&q=85&s=a2b9f152ef559e103b35f32f34eefd32" size="md" alt="MSSQL 登录用户配置" border width="706" height="632" data-path="images/knowledgebase/ikb273/568f1143-475e-422f-a26a-2c23ac324771.webp" />

`sql_user` 的数据库成员身份角色：

<Image img="https://mintcdn.com/private-7c7dfe99/mWK0LIJWA-YNz_kU/images/knowledgebase/ikb273/63992978-7078-4985-b661-a3c095099ea7.webp?fit=max&auto=format&n=mWK0LIJWA-YNz_kU&q=85&s=511ec4894b1a20bf800007b56ee2162c" size="md" alt="MSSQL 数据库成员身份角色" border width="703" height="627" data-path="images/knowledgebase/ikb273/63992978-7078-4985-b661-a3c095099ea7.webp" />

具有登录名的数据库用户：

<Image img="https://mintcdn.com/private-7c7dfe99/mWK0LIJWA-YNz_kU/images/knowledgebase/ikb273/15a407ca-53c1-45b1-9beb-ddd8eedde64a.webp?fit=max&auto=format&n=mWK0LIJWA-YNz_kU&q=85&s=72303e872989b7c27ea0920ec5e8c3b5" size="md" alt="具有登录名的 MSSQL 数据库用户" border width="994" height="447" data-path="images/knowledgebase/ikb273/15a407ca-53c1-45b1-9beb-ddd8eedde64a.webp" />

<div id="configuring-clickhouse-with-odbc">
  ### 使用 ODBC 配置 ClickHouse
</div>

创建工作目录：

```sh theme={null}
mkdir ch-odbc-mssql
cd ch-odbc-mssql
```

创建 `odbc.ini` 文件：

```sh theme={null}
vim odbc.ini
```

添加以下条目以更新 DSN 名称和 IP 地址：

```sh theme={null}
[marsdb2_mssql]
Driver = FreeTDS
Server = 192.168.1.133
```

创建 `odbcinst.ini` 文件：

```sh theme={null}
vim odbcinst.ini
```

添加以下条目 (trace 为可选，但有助于调试) ：

```sh theme={null}
[ODBC]
Trace = Yes
TraceFile = /tmp/odbc.log

[FreeTDS]
Description = FreeTDS
Driver = /usr/lib/aarch64-linux-gnu/odbc/libtdsodbc.so
Setup = /usr/lib/x86_64-linux-gnu/odbc/libtdsS.so
UsageCount = 1
```

<div id="configure-a-dockerfile-to-download-the-image-and-add-the-tds-and-required-odbc-libraries">
  ### 配置 Dockerfile 以拉取镜像并添加 TDS 及所需的 ODBC 库
</div>

创建 Dockerfile：

```sh theme={null}
vim Dockerfile
```

在 Dockerfile 中添加以下内容：

```sh theme={null}
FROM clickhouse/clickhouse-server:23.10

# 安装 ODBC 驱动

RUN apt-get update && apt-get install -y --no-install-recommends unixodbc \
    && apt-get install -y freetds-bin freetds-common freetds-dev libct4 libsybdb5 \
	&& apt-get install tdsodbc
```

构建新的 Docker 镜像：

```sh theme={null}
docker build . -t marsnet/clickhouse-odbc:23.10
```

创建 `docker-compose.yml` 文件：

```sh theme={null}
vim docker-compose.yml
```

将以下内容添加到 YAML 中：

```sh theme={null}
version: '3.7'
services:
  clickhouse:
    image: marsnet/clickhouse-odbc:23.10
    container_name: clickhouse-odbc
    hostname: clickhouse-host
    ports:
      - "9000:9000"
      - "8123:8123"
      - "9009:9009"
    volumes:
      - ./odbc.ini:/etc/odbc.ini
      - ./odbcinst.ini:/etc/odbcinst.ini
    restart: always
    ulimits:
      memlock:
        soft: -1
        hard: -1
      nofile:
        soft: 262144
        hard: 262144
    deploy:
      resources:
        limits:
          memory: 4g
```

启动容器：

```sh theme={null}
docker compose up --detach
```

启动容器后，你会看到类似下面的内容：

```sh theme={null}
ch-odbc-mssql % docker compose up --detach
[+] Running 1/1
 ✔ Container clickhouse-odbc  Started
```

检查容器是否正在运行：

```sh theme={null}
ch-odbc-mssql % docker ps
CONTAINER ID   IMAGE                           COMMAND            CREATED          STATUS              PORTS                                                                    NAMES
87a400b803ce   marsnet/clickhouse-odbc:23.10   "/entrypoint.sh"   57 minutes ago   Up About a minute   0.0.0.0:8123->8123/tcp, 0.0.0.0:9000->9000/tcp, 0.0.0.0:9009->9009/tcp   clickhouse-odbc
```

<div id="test-odbc-connection">
  ### 测试 ODBC 连接
</div>

使用 ClickHouse 客户端登录：

```sh theme={null}
./clickhouse client
```

使用 `odbc` 表函数对远程 MSSQL 数据库中的表执行 `SELECT` 测试：

```
clickhouse-host :) SELECT * from odbc('DSN=marsdb2_mssql;port=1433;Uid=sql_user;Pwd=ClickHouse123;Database=db1', 'table1');

SELECT *
FROM odbc('DSN=marsdb2_mssql;port=1433;Uid=sql_user;Pwd=ClickHouse123;Database=db1', 'table1')

Query id: 23494da2-6e12-4ade-95fa-372a0420cac1

┌─id─┬─column1─┐
│  1 │ abc     │
│  2 │ def     │
│  3 │ ghi     │
└────┴─────────┘

3 rows in set. Elapsed: 0.188 sec. 
```

您还可以使用 `odbc` 表引擎来创建远程表：

```sql theme={null}
CREATE TABLE table1_odbc_mssql
(
    `id` Int32,
    `column1` String
)
ENGINE = ODBC('DSN=marsdb2_mssql;port=1433;Uid=sql_user;Pwd=ClickHouse123;Database=db1', 'dbo', 'table1')
```

使用 `SELECT` 查询测试新的远程表：

```
clickhouse-host :) select * from table1_odbc_mssql;

SELECT *
FROM table1_odbc_mssql

Query id: 94724368-485d-4364-ae58-a435a225c37d

┌─id─┬─column1─┐
│  1 │ abc     │
│  2 │ def     │
│  3 │ ghi     │
└────┴─────────┘

3 rows in set. Elapsed: 0.218 sec. 
```

更多信息请参见：

* [https://hub.docker.com/\_/clickhouse](https://hub.docker.com/_/clickhouse)
* [https://clickhouse.com/docs/engines/table-engines/integrations/odbc](/docs/zh/reference/engines/table-engines/integrations/odbc)
* [https://github.com/ClickHouse/clickhouse-odbc](https://github.com/ClickHouse/clickhouse-odbc)