> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-fix-nav-issues.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> 返回通过 ODBC 连接的表。

# odbc

返回通过 [ODBC](https://en.wikipedia.org/wiki/Open_Database_Connectivity) 连接的表。

<div id="syntax">
  ## 语法
</div>

```sql theme={null}
odbc(datasource, external_database, external_table)
odbc(datasource, external_table)
odbc(named_collection)
```

<div id="arguments">
  ## 参数
</div>

| 参数                  | 描述                         |
| ------------------- | -------------------------- |
| `datasource`        | `odbc.ini` 文件中包含连接设置的节名称。  |
| `external_database` | 外部 DBMS 中的数据库名称。           |
| `external_table`    | `external_database` 中的表名称。 |

这些参数也可以通过[命名集合](/zh/concepts/features/configuration/server-config/named-collections)传入。

为安全地实现 ODBC 连接，ClickHouse 使用独立程序 `clickhouse-odbc-bridge`。如果直接由 `clickhouse-server` 加载 ODBC 驱动，驱动问题可能会导致 ClickHouse 服务器崩溃。ClickHouse 会在需要时自动启动 `clickhouse-odbc-bridge`。ODBC bridge 程序与 `clickhouse-server` 来自同一个安装包。

外部表中值为 `NULL` 的字段会被转换为其基础数据类型的默认值。例如，如果远程 MySQL 表字段的类型为 `INT NULL`，则会被转换为 0 (即 ClickHouse `Int32` 数据类型的默认值) 。

<div id="usage-example">
  ## 使用示例
</div>

**通过 ODBC 从本地安装的 MySQL 获取数据**

此示例已在 Ubuntu Linux 18.04 和 MySQL 服务器 5.7 环境中验证。

请确保已安装 unixODBC 和 MySQL Connector。

默认情况下 (如果是通过软件包安装) ，ClickHouse 会以用户 `clickhouse` 的身份启动。因此，你需要在 MySQL 服务器中创建并配置该用户。

```bash theme={null}
$ sudo mysql
```

```sql theme={null}
mysql> CREATE USER 'clickhouse'@'localhost' IDENTIFIED BY 'clickhouse';
mysql> GRANT ALL PRIVILEGES ON *.* TO 'clickhouse'@'clickhouse' WITH GRANT OPTION;
```

然后在 `/etc/odbc.ini` 中配置连接信息。

```bash theme={null}
$ cat /etc/odbc.ini
[mysqlconn]
DRIVER = /usr/local/lib/libmyodbc5w.so
SERVER = 127.0.0.1
PORT = 3306
DATABASE = test
USERNAME = clickhouse
PASSWORD = clickhouse
```

您可以使用 unixODBC 安装包中的 `isql` 工具来检查连接。

```bash theme={null}
$ isql -v mysqlconn
+-------------------------+
| Connected!                            |
|                                       |
...
```

MySQL 中的表：

```text theme={null}
mysql> CREATE TABLE `test`.`test` (
    ->   `int_id` INT NOT NULL AUTO_INCREMENT,
    ->   `int_nullable` INT NULL DEFAULT NULL,
    ->   `float` FLOAT NOT NULL,
    ->   `float_nullable` FLOAT NULL DEFAULT NULL,
    ->   PRIMARY KEY (`int_id`));
Query OK, 0 rows affected (0,09 sec)

mysql> insert into test (`int_id`, `float`) VALUES (1,2);
Query OK, 1 row affected (0,00 sec)

mysql> select * from test;
+------+----------+-----+----------+
| int_id | int_nullable | float | float_nullable |
+------+----------+-----+----------+
|      1 |         NULL |     2 |           NULL |
+------+----------+-----+----------+
1 row in set (0,00 sec)
```

在 ClickHouse 中从 MySQL 表检索数据：

```sql theme={null}
SELECT * FROM odbc('DSN=mysqlconn', 'test', 'test')
```

```text theme={null}
┌─int_id─┬─int_nullable─┬─float─┬─float_nullable─┐
│      1 │            0 │     2 │              0 │
└────────┴──────────────┴───────┴────────────────┘
```

<div id="see-also">
  ## 另请参见
</div>

* [ODBC 字典](/zh/reference/statements/create/dictionary/sources/odbc)
* [ODBC 表引擎](/zh/reference/engines/table-engines/integrations/odbc)。