:orphan:
ODBC 驱动程序
开放数据库连接（ODBC）驱动程序是一个用于 Windows 和 macOS 的只读 ODBC 驱动程序，它允许您将商业智能（BI）和数据可视化应用程序（如 Microsoft Excel(文档可联系售前工作人员获取) 和 Power BI(文档可联系售前工作人员获取)连接到 SQL 插件。
有关下载和使用该驱动程序的信息，请参阅 GitHub 上的 SQL 仓库(文档可联系售前工作人员获取)。
规范
ODBC 驱动程序兼容 ODBC 版本 3.51。
支持的操作系统版本
支持以下操作系统：
| 操作系统 | 版本 |
|---|---|
| Windows | Windows 10, Windows 11 |
| macOS | Catalina 10.15.4, Mojave 10.14.6, Big Sur 11.6.7, Monterey 12.4 |
概念
| 术语 | 定义 |
|---|---|
| DSN | DSN（数据源名称）用于在系统中存储驱动程序信息。通过将信息存储在系统中，每次驱动程序连接时就不需要重复指定这些信息。 |
.tdc 文件 |
TDC 文件包含配置信息，Tableau 会将这些信息应用于与文件中定义的数据库供应商名称和驱动程序名称匹配的任何连接。此配置允许您微调 ODBC 数据连接的部分设置，并启用或禁用数据源不支持的功能。 |
安装驱动程序
要安装驱动程序，请从此处(文档可联系售前工作人员获取)下载捆绑的发行版安装程序，或从源代码构建。
Windows
打开下载的
UDB-SX SQL ODBC Driver-<version>-Windows.msi安装程序。该安装程序未签名，会显示安全对话框。选择更多信息，然后选择仍要运行。
选择下一步继续安装。
接受协议，然后选择下一步。
安装程序捆绑了文档和用于连接到各种 BI 工具的有用资源文件（例如，用于 Tableau 的
.tdc文件）。您可以选择保留或删除这些资源。选择下一步。选择安装和完成。
以下连接信息已设置为默认 DSN 的一部分：
Host: localhost
Port: 10200
Auth: NONE
要自定义 DSN，请使用 Windows 10 上预装的 ODBC 数据源管理器。
macOS
在 macOS 上安装 ODBC 驱动程序之前，请先安装 iODBC 驱动程序管理器。
打开下载的
UDB-SX SQL ODBC Driver-<version>-Darwin.pkg安装程序。该安装程序未签名，会显示安全对话框。右键单击安装程序并选择打开。
多次选择继续以继续安装过程。
选择安装驱动程序文件的目标位置。
安装程序捆绑了文档和用于连接到各种 BI 工具的有用资源文件（例如，用于 Tableau 的
.tdc文件）。您可以选择保留或删除这些资源。选择继续。选择安装和关闭。
目前，安装过程中并未设置 DSN，需要手动配置。首先，打开 iODBC Administrator：
sudo /Applications/iODBC/iODBC\ Administrator64.app/Contents/MacOS/iODBC\ Administrator64
此命令授予应用程序保存驱动程序和 DSN 配置的权限。
选择 ODBC Drivers 选项卡。
选择 Add a Driver 并填写以下详细信息：
Description of the Driver：输入用于 ODBC 连接的驱动程序名称（例如，UDB-SX SQL ODBC Driver）。
Driver File Name：输入驱动程序文件的路径（默认：
<driver-install-dir>/bin/libopensearchsqlodbc.dylib）。Setup File Name：输入设置文件的路径（默认：
<driver-install-dir>/bin/libopensearchsqlodbc.dylib）。
选择用户驱动程序。
选择 OK 保存选项。
选择 User DSN 选项卡。
选择 Add。
选择您上面添加的驱动程序。
在 Data Source Name (DSN) 中，输入用于存储连接选项的 DSN 名称（例如，UDB-SX SQL ODBC DSN）。
在 Comment 中，添加可选注释。
使用
+按钮添加键值对。对于默认的本地 UDB-SX 安装，我们建议使用以下选项：Host：
localhost- UDB-SX 服务器端点Port：
10200- 服务器端口Auth：
NONE- 认证模式Username：
（空白）- 用于 BASIC 认证的用户名Password：
（空白）- 用于 BASIC 认证的密码ResponseTimeout：
10- 等待服务器响应的秒数UseSSL：
0- 连接不使用 SSL
选择 OK 保存 DSN 配置。
选择 OK 退出 iODBC Administrator。
自定义 ODBC 驱动程序
驱动程序以库文件的形式存在：Windows 为 opensearchsqlodbc.dll，macOS 为 libopensearchsqlodbc.dylib。
如果您正在使用与 ODBC 兼容的 BI 工具，请参阅您的 BI 工具文档以配置新的 ODBC 驱动程序。 通常，只需要让 BI 工具知道驱动程序库文件的位置，然后用它来设置数据库（即 UDB-SX）连接。
连接字符串和其他设置
ODBC 驱动程序使用 ODBC 连接字符串。 连接字符串是由分号分隔的字符串，指定了可用于连接的选项集。 通常，连接字符串将执行以下操作之一：
指定一个包含预配置选项集的 DSN（数据源名称）（
DSN=xxx;User=xxx;Password=xxx;）。或者，使用字符串显式配置选项（
Host=xxx;Port=xxx;LogLevel=ES_DEBUG;...）。
您可以使用 DSN 或连接字符串配置以下驱动程序选项：
所有选项名称不区分大小写。
基本选项
| 选项 | 描述 | 类型 | 默认值 |
|---|---|---|---|
DSN |
用于配置连接的数据源名称。 | string |
- |
Host / Server |
目标集群的主机名或 IP 地址。 | string |
- |
Port |
UDB-SX 集群 REST 接口监听的端口号。 | string |
- |
认证选项
| 选项 | 描述 | 类型 | 默认值 |
|---|---|---|---|
Auth |
要使用的认证机制。 | BASIC（基本 HTTP）、AWS_SIGV4（AWS 认证）或 NONE |
NONE |
User / UID |
[Auth=BASIC] 连接的用户名。 |
string |
- |
Password / PWD |
[Auth=BASIC] 连接的密码。 |
string |
- |
Region |
[Auth=AWS_SIGV4] 用于签名请求的区域。 |
AWS region (例如 us-west-1) |
- |
高级选项
| 选项 | 描述 | 类型 | 默认值 |
|---|---|---|---|
UseSSL |
是否通过 SSL/TLS 建立连接。 | boolean (0 或 1) |
false (0) |
HostnameVerification |
指示是否应为 SSL/TLS 连接执行证书主机名验证。 | boolean (0 或 1) |
true (1) |
ResponseTimeout |
等待主机响应的最长时间，以秒为单位。 | integer |
10 |
日志选项
| 选项 | 描述 | 类型 | 默认值 |
|---|---|---|---|
LogLevel |
驱动程序日志的严重性级别。 | LOG_OFF、LOG_FATAL、LOG_ERROR、LOG_INFO、LOG_DEBUG、LOG_TRACE 或 LOG_ALL |
LOG_WARNING |
LogOutput |
存储驱动程序日志的位置。 | string |
WIN: C:\、MAC: /tmp |
需要管理员权限才能更改日志选项。
连接 Tableau
前提条件：
确保 DSN 已设置。
确保 UDB-SX 正在 DSN 中配置的 host 和 port 上运行。
确保
.tdc文件已复制到<用户主目录>/Documents/My Tableau Repository/Datasources（适用于 macOS 和 Windows）。
启动 Tableau。在 Connect 部分，转到 To a Server 并选择 Other Databases (ODBC)。
在 DSN 下拉列表中，选择您在之前步骤中设置的 UDB-SX DSN。您添加的选项将自动填充在 Connection Attributes 下。
选择 Sign In。几秒钟后，Tableau 将连接到您的 UDB-SX 服务器。连接后，您将被定向到 Datasource 窗口。Database 将已填充为 UDB-SX 集群的名称。 要列出所有索引，请单击 Table 下的搜索图标。
通过将表拖到连接区域来开始试验数据。选择 Update Now 或 Automatically Update 以填充表数据。
有关更详细的说明，请参阅 GitHub 仓库(文档可联系售前工作人员获取)。
故障排除
问题
无法连接到服务器。
解决方法
这很可能是由于 UDB-SX 服务器未在 DSN 中配置的 host 和 port 上运行。
确认 host 和 port 正确，并且 UDB-SX 服务器正在运行并安装了 UDB-SX SQL 插件。
同时确保与安装程序一起下载的 .tdc 文件已正确复制到 <用户主目录>/Documents/My Tableau Repository/Datasources 目录。
连接 Microsoft Power BI
按照 GitHub 仓库(文档可联系售前工作人员获取) 中发布的安装说明(文档可联系售前工作人员获取)和配置说明(文档可联系售前工作人员获取)进行操作。