Link Search Menu Expand Document Documentation Menu
文档

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

  1. 打开已下载的 OpenSearch SQL ODBC Driver-<version>-Windows.msi 安装程序。

    安装程序未经签名，会显示安全对话框。选择更多信息和仍然运行。

  2. 选择下一步继续安装。

  3. 接受协议，然后选择下一步。

  4. 安装程序捆绑了文档和有用的资源文件，用于连接各种 BI 工具（例如，用于 Tableau 的 .tdc 文件）。您可以选择保留或删除这些资源。选择下一步。

  5. 选择安装和完成。

以下连接信息作为默认 DSN 的一部分进行设置

Host: localhost
Port: 9200
Auth: NONE

要自定义 DSN，请使用 Windows 10 预装的 ODBC 数据源管理器。

macOS

在 macOS 上安装 ODBC 驱动程序之前，请安装 iODBC 驱动程序管理器。

  1. 打开已下载的 OpenSearch SQL ODBC Driver-<version>-Darwin.pkg 安装程序。

    安装程序未经签名，会显示安全对话框。右键单击安装程序，然后选择打开。

  2. 多次选择继续以进行安装。

  3. 选择安装驱动程序文件的目标。

  4. 安装程序捆绑了文档和有用的资源文件，用于连接各种 BI 工具（例如，用于 Tableau 的 .tdc 文件）。您可以选择保留或删除这些资源。选择继续。

  5. 选择安装和关闭。

目前，DSN 未作为安装的一部分进行设置，需要手动配置。首先，打开 iODBC Administrator

sudo /Applications/iODBC/iODBC\ Administrator64.app/Contents/MacOS/iODBC\ Administrator64

此命令授予应用程序保存驱动程序和 DSN 配置的权限。

  1. 选择ODBC 驱动程序选项卡。
  2. 选择添加驱动程序并填写以下详细信息
    • 驱动程序描述：输入您用于 ODBC 连接的驱动程序名称（例如，OpenSearch SQL ODBC 驱动程序）。
    • 驱动程序文件名：输入驱动程序文件的路径（默认：<driver-install-dir>/bin/libopensearchsqlodbc.dylib）。
    • 安装文件名：输入安装文件的路径（默认：<driver-install-dir>/bin/libopensearchsqlodbc.dylib）。
  3. 选择用户驱动程序。
  4. 选择确定保存选项。
  5. 选择用户 DSN 选项卡。
  6. 选择添加。
  7. 选择您上面添加的驱动程序。
  8. 对于数据源名称 (DSN)，输入用于存储连接选项的 DSN 名称（例如，OpenSearch SQL ODBC DSN）。
  9. 对于备注，添加一个可选备注。
  10. 使用 + 按钮添加键值对。对于默认的本地 OpenSearch 安装，我们推荐以下选项
    • 主机：localhost - OpenSearch 服务器端点
    • 端口：9200 - 服务器端口
    • 认证：NONE - 认证模式
    • 用户名：(空白) - 用于基本认证的用户名
    • 密码：(空白) - 用于基本认证的密码
    • 响应超时：10 - 等待服务器响应的秒数
    • 使用 SSL：0 - 连接时不使用 SSL
  11. 选择确定保存 DSN 配置。
  12. 选择确定退出 iODBC 管理器。

自定义 ODBC 驱动程序

驱动程序以库文件形式存在：Windows 为 opensearchsqlodbc.dll，macOS 为 libopensearchsqlodbc.dylib。

如果您正在使用兼容 ODBC 的 BI 工具，请参阅您的 BI 工具文档以配置新的 ODBC 驱动程序。通常，只需让 BI 工具知道驱动程序库文件的位置，然后使用它来设置数据库（即 OpenSearch）连接即可。

连接字符串和其他设置

ODBC 驱动程序使用 ODBC 连接字符串。连接字符串是以分号分隔的字符串，指定可用于连接的选项集。通常，连接字符串会

  • 指定包含预配置选项集的数据源名称 (DSN)（DSN=xxx;User=xxx;Password=xxx;）。
  • 或者，使用字符串显式配置选项（Host=xxx;Port=xxx;LogLevel=ES_DEBUG;...）。

您可以使用 DSN 或连接字符串配置以下驱动程序选项

所有选项名称均不区分大小写。

基本选项

选项 描述 类型 默认值
DSN 用于配置连接的数据源名称。 字符串 -
主机 / 服务器 目标集群的主机名或 IP 地址。 字符串 -
端口 OpenSearch 集群 REST 接口正在监听的端口号。 字符串 -

认证选项

选项 描述 类型 默认值
认证 要使用的认证机制。 BASIC（基本 HTTP）、AWS_SIGV4（AWS 认证）或 NONE NONE
用户 / UID [Auth=BASIC] 连接的用户名。 字符串 -
密码 / PWD [Auth=BASIC] 连接的密码。 字符串 -
区域 [Auth=AWS_SIGV4] 用于签名请求的区域。 AWS 区域（例如，us-west-1） -

高级选项

选项 描述 类型 默认值
使用 SSL 是否通过 SSL/TLS 建立连接。 布尔值（0 或 1） 假 (0)
主机名验证 指示是否对 SSL/TLS 连接执行证书主机名验证。 布尔值（0 或 1） 真 (1)
响应超时 等待主机响应的最大时间，单位为秒。 整型 10

日志选项

选项 描述 类型 默认值
日志级别 驱动程序日志的严重性级别。 LOG_OFF, LOG_FATAL, LOG_ERROR, LOG_INFO, LOG_DEBUG, LOG_TRACE, 或 LOG_ALL LOG_WARNING
日志输出 存储驱动程序日志的位置。 字符串 WIN: C:\, MAC: /tmp

您需要管理员权限才能更改日志选项。

连接到 Tableau

先决条件

  • 确保 DSN 已设置。
  • 确保 OpenSearch 正在 DSN 中配置的主机和端口上运行。
  • 确保 .tdc 文件已复制到 macOS 和 Windows 的 <user_home_directory>/Documents/My Tableau Repository/Datasources 目录中。

  1. 启动 Tableau。在连接部分下，转到到服务器并选择其他数据库 (ODBC)。

  2. 在DSN 下拉菜单中，选择您在前面步骤中设置的 OpenSearch DSN。您添加的选项将自动填充到连接属性下。

  3. 选择登录。几秒钟后，Tableau 将连接到您的 OpenSearch 服务器。连接后，您将被定向到数据源窗口。数据库将已填充 OpenSearch 集群的名称。要列出所有索引，请单击表下的搜索图标。

  4. 通过将表拖到连接区域来开始数据实验。选择立即更新或自动更新以填充表数据。

有关更详细的说明，请参阅 GitHub 仓库。

故障排除

问题

无法连接到服务器。

解决方法

这很可能是由于 OpenSearch 服务器未在 DSN 中配置的主机和端口上运行。请确认主机和端口正确，并且 OpenSearch 服务器正在运行 OpenSearch SQL 插件。另请确保与安装程序一起下载的 .tdc 文件已正确复制到 <user_home_directory>/Documents/My Tableau Repository/Datasources 目录。

连接到 Microsoft Power BI

遵循 GitHub 仓库中发布的安装说明和配置说明。

剩余 350 字符

有问题？。

想贡献？或。