Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

ODBC 字典源

View as MarkdownEdit this pageReport an issueSet up docs MCP

你可以使用此方法连接任何带有 ODBC 驱动程序 的数据库。

设置示例：

SOURCE(ODBC(
    db 'DatabaseName'
    table 'SchemaName.TableName'
    connection_string 'DSN=some_parameters'
    invalidate_query 'SQL_QUERY'
    query 'SELECT id, value_1, value_2 FROM db_name.table_name'
))

设置字段：

Setting Description
db 数据库名称。如果数据库名称已在 <connection_string> 参数中设置，则可省略。
table 表名称，以及 schema (如果有) 。
connection_string connection string。
invalidate_query 用于检查字典状态的查询。可选。更多信息请参见 Refreshing dictionary data using LIFETIME 部分。
background_reconnect 如果 connection 失败，则在后台重新连接到副本。可选。
query 自定义查询。可选。

ClickHouse 会从 ODBC 驱动程序 接收引号符号，并在发送给 driver 的查询中为所有设置加上引号，因此必须按照数据库中的表名大小写正确设置表名。

如果你在使用 Oracle 时遇到编码问题，请参阅相应的 FAQ 条目。

ODBC 字典功能的已知漏洞

不安全用法示例

下面为 PostgreSQL 配置 unixODBC。/etc/odbc.ini 的内容如下：

[gregtest]
Driver = /usr/lib/psqlodbca.so
Servername = localhost
PORT = 5432
DATABASE = test_db
#OPTION = 3
USERNAME = test
PASSWORD = test

如果你随后执行如下查询

SELECT * FROM odbc('DSN=gregtest;Servername=some-server.com', 'test_db');

ODBC 驱动程序会将 odbc.ini 中 USERNAME 和 PASSWORD 的值发送到 some-server.com。

连接 PostgreSQL 的示例

Ubuntu 操作系统。

安装 unixODBC 和 PostgreSQL 的 ODBC 驱动程序：

$ sudo apt-get install -y unixodbc odbcinst odbc-postgresql

配置 /etc/odbc.ini (如果你是以运行 ClickHouse 的用户身份登录，则使用 ~/.odbc.ini) ：

    [DEFAULT]
    Driver = myconnection

    [myconnection]
    Description         = PostgreSQL connection to my_db
    Driver              = PostgreSQL Unicode
    Database            = my_db
    Servername          = 127.0.0.1
    UserName            = username
    Password            = password
    Port                = 5432
    Protocol            = 9.3
    ReadOnly            = No
    RowVersioning       = No
    ShowSystemTables    = No
    ConnSettings        =

ClickHouse 中的字典配置如下：

CREATE DICTIONARY table_name (
    id UInt64,
    some_column UInt64 DEFAULT 0
)
PRIMARY KEY id
SOURCE(ODBC(connection_string 'DSN=myconnection' table 'postgresql_table'))
LAYOUT(HASHED())
LIFETIME(MIN 300 MAX 360)

你可能需要编辑 odbc.ini，通过 DRIVER=/usr/local/lib/psqlodbcw.so 指定驱动库的完整路径。

连接 MS SQL Server 示例

Ubuntu 操作系统。

安装用于连接 MS SQL 的 ODBC 驱动程序：

$ sudo apt-get install tdsodbc freetds-bin sqsh

配置驱动程序：

    $ cat /etc/freetds/freetds.conf
    ...

    [MSSQL]
    host = 192.168.56.101
    port = 1433
    tds version = 7.0
    client charset = UTF-8

    # test TDS connection
    $ sqsh -S MSSQL -D database -U user -P password

    $ cat /etc/odbcinst.ini

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

    $ cat /etc/odbc.ini
    # $ cat ~/.odbc.ini # if you signed in under a user that runs ClickHouse

    [MSSQL]
    Description     = FreeTDS
    Driver          = FreeTDS
    Servername      = MSSQL
    Database        = test
    UID             = test
    PWD             = test
    Port            = 1433

    # (optional) test ODBC connection (to use isql-tool install the [unixodbc](https://packages.debian.org/sid/unixodbc)-package)
    $ isql -v MSSQL "user" "password"

说明：

  • 如需确定某个 SQL Server 版本支持的最早 TDS 版本，请参阅产品文档，或查看 MS-TDS Product Behavior

在 ClickHouse 中配置字典：

CREATE DICTIONARY test (
    k UInt64,
    s String DEFAULT ''
)
PRIMARY KEY k
SOURCE(ODBC(table 'dict' connection_string 'DSN=MSSQL;UID=test;PWD=test'))
LAYOUT(FLAT())
LIFETIME(MIN 300 MAX 360)
Navigation