Elastic Microsoft SQL 连接器参考

此连接器在 Elastic 版本 8.8.0 及更高版本中作为托管连接器提供。要在 Elastic Cloud 中本地使用此连接器，请满足所有托管连接器要求。

要创建新的 Microsoft SQL 连接器

有关其他操作，请参阅Kibana 中的连接器 UI。

您可以使用 Elasticsearch 创建连接器 API 创建新的原生 Microsoft SQL 连接器。

例如

resp = client.connector.put(
    connector_id="my-{service-name-stub}-connector",
    index_name="my-elasticsearch-index",
    name="Content synced from {service-name}",
    service_type="{service-name-stub}",
    is_native=True,
)
print(resp)

const response = await client.connector.put({
  connector_id: "my-{service-name-stub}-connector",
  index_name: "my-elasticsearch-index",
  name: "Content synced from {service-name}",
  service_type: "{service-name-stub}",
  is_native: true,
});
console.log(response);

PUT _connector/my-mssql-connector
{
  "index_name": "my-elasticsearch-index",
  "name": "Content synced from Microsoft SQL",
  "service_type": "mssql",
  "is_native": true
}

有关所有可用连接器 API 的详细信息，请参阅Elasticsearch API 文档。

要将此连接器用作托管连接器，请使用连接器工作流程。请参阅Elastic 托管连接器。

用户需要 sysadmin SQL Server 角色。请注意，需要 SQL Server 身份验证。不支持 Windows 身份验证。

有关其他操作，请参阅Kibana 中的连接器 UI。

以下与 Elastic 连接器框架兼容

设置连接器需要以下配置字段

基本同步规则 对于所有连接器都是相同的，并且默认可用。有关更多信息，请阅读同步规则。

此连接器支持用于远程过滤的高级同步规则。这些规则涵盖无法用基本同步规则表达的复杂查询和筛选场景。高级同步规则通过特定于源的 DSL JSON 代码片段定义。

以下是此连接器的一些高级同步规则示例。

示例：两个查询

这些规则从 employee 和 customer 表中获取所有记录。这些表中的数据将分别同步到 Elasticsearch。

[
  {
    "tables": [
      "employee"
    ],
    "query": "SELECT * FROM employee"
  },
  {
    "tables": [
      "customer"
    ],
    "query": "SELECT * FROM customer"
  }
]

示例：一个 WHERE 查询

此规则仅从 emp_id 大于 5 的 employee 表中获取记录。只有这些经过筛选的记录才会同步到 Elasticsearch。

[
  {
    "tables": ["employee"],
    "query": "SELECT * FROM employee WHERE emp_id > 5"
  }
]

示例：一个 JOIN 查询

此规则通过在 employee 中的 emp_id 与 customer 中的 c_id 匹配的条件下，在 employee 和 customer 表之间执行 INNER JOIN 来获取记录。此组合数据的结果将同步到 Elasticsearch。

[
  {
    "tables": ["employee", "customer"],
    "query": "SELECT * FROM employee INNER JOIN customer ON employee.emp_id = customer.c_id"
  }
]

此连接器没有已知问题。有关影响所有连接器的任何问题，请参阅已知问题。

请参阅故障排除。

请参阅安全性。

此连接器使用 通用数据库连接器源代码（分支 8.17，与 Elastic 8.17 兼容）。

查看 特定于此数据源的其他代码（分支 8.17，与 Elastic 8.17 兼容）。

此连接器作为自管理 自管理连接器 提供。要使用此连接器，请满足所有自管理连接器要求。

要创建新的 Microsoft SQL 连接器

您可以使用 Elasticsearch 创建连接器 API 来创建一个新的自管理 Microsoft SQL 自管理连接器。

例如

resp = client.connector.put(
    connector_id="my-{service-name-stub}-connector",
    index_name="my-elasticsearch-index",
    name="Content synced from {service-name}",
    service_type="{service-name-stub}",
)
print(resp)

const response = await client.connector.put({
  connector_id: "my-{service-name-stub}-connector",
  index_name: "my-elasticsearch-index",
  name: "Content synced from {service-name}",
  service_type: "{service-name-stub}",
});
console.log(response);

PUT _connector/my-mssql-connector
{
  "index_name": "my-elasticsearch-index",
  "name": "Content synced from Microsoft SQL",
  "service_type": "mssql"
}

有关所有可用连接器 API 的详细信息，请参阅Elasticsearch API 文档。

用户需要 sysadmin 服务器角色。请注意，需要 SQL Server 身份验证。不支持 Windows 身份验证。

要将此连接器用作 自管理连接器，请参阅 自管理连接器。有关其他用法操作，请参阅 Kibana 中的连接器 UI。

以下与 Elastic 连接器框架兼容

设置连接器需要以下配置字段

您可以使用 Docker 将 Microsoft SQL 连接器部署为自管理连接器。请按照以下说明操作。

curl https://raw.githubusercontent.com/elastic/connectors/main/config.yml.example --output ~/connectors-config/config.yml

# When connecting to your cloud deployment you should edit the host value
elasticsearch.host: http://host.docker.internal:9200
elasticsearch.api_key: <ELASTICSEARCH_API_KEY>

connectors:
  -
    connector_id: <CONNECTOR_ID_FROM_KIBANA>
    service_type: mssql
    api_key: <CONNECTOR_API_KEY_FROM_KIBANA> # Optional. If not provided, the connector will use the elasticsearch.api_key instead

docker run \
-v ~/connectors-config:/config \
--network "elastic" \
--tty \
--rm \
docker.elastic.co/enterprise-search/elastic-connectors:8.17.0.0 \
/app/bin/elastic-ingest \
-c /config/config.yml

有关更多详细信息，请参阅 elastic/connectors 存储库中的 DOCKER.md。

在官方注册表中查找所有可用的 Docker 镜像。

基本同步规则 对于所有连接器都是相同的，并且默认可用。有关更多信息，请阅读同步规则。

此连接器支持用于远程过滤的高级同步规则。这些规则涵盖无法用基本同步规则表达的复杂查询和筛选场景。高级同步规则通过特定于源的 DSL JSON 代码片段定义。

以下是此连接器的一些高级同步规则示例。

示例：两个查询

这些规则从 employee 和 customer 表中获取所有记录。这些表中的数据将分别同步到 Elasticsearch。

[
  {
    "tables": [
      "employee"
    ],
    "query": "SELECT * FROM employee"
  },
  {
    "tables": [
      "customer"
    ],
    "query": "SELECT * FROM customer"
  }
]

示例：一个 WHERE 查询

此规则仅从 emp_id 大于 5 的 employee 表中获取记录。只有这些经过筛选的记录才会同步到 Elasticsearch。

[
  {
    "tables": ["employee"],
    "query": "SELECT * FROM employee WHERE emp_id > 5"
  }
]

示例：一个 JOIN 查询

此规则通过在 employee 中的 emp_id 与 customer 中的 c_id 匹配的条件下，在 employee 和 customer 表之间执行 INNER JOIN 来获取记录。此组合数据的结果将同步到 Elasticsearch。

[
  {
    "tables": ["employee", "customer"],
    "query": "SELECT * FROM employee INNER JOIN customer ON employee.emp_id = customer.c_id"
  }
]

连接器框架使操作员能够针对真实数据源运行功能测试。有关更多详细信息，请参阅 连接器测试。

要执行 Microsoft SQL 连接器的 E2E 测试，请运行以下命令

make ftest NAME=mssql

为了加快测试速度，请添加 DATA_SIZE=small 标志

make ftest NAME=mssql DATA_SIZE=small

此连接器没有已知问题。有关影响所有连接器的任何问题，请参阅已知问题。

请参阅故障排除。

请参阅安全性。

此连接器使用 通用数据库连接器源代码（分支 8.17，与 Elastic 8.17 兼容）。

查看 特定于此数据源的其他代码（分支 8.17，与 Elastic 8.17 兼容）。