Справочник по подключению Elastic к Microsoft SQL

Этот коннектор доступен как управляемый коннектор в версиях Elastic 8.8.0 и более поздних. Чтобы использовать этот коннектор в Elastic Cloud, выполните все требования к управляемым коннекторам.

Чтобы создать новый коннектор Microsoft SQL:

Для дополнительных операций см. Интерфейс коннекторов в Kibana.

Вы можете использовать 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.

Следующие совместимы с фреймворками коннекторов Elastic:

Для настройки коннектора требуются следующие поля конфигурации:

Основные правила синхронизации одинаковы для всех коннекторов и доступны по умолчанию. Для получения дополнительной информации см. правила синхронизации.

Этот коннектор поддерживает расширенные правила синхронизации для удаленной фильтрации. Эти правила охватывают сложные сценарии запросов и фильтрации, которые не могут быть выражены с помощью основных правил синхронизации. Расширенные правила синхронизации определяются с помощью JSON-фрагмента DSL, специфичного для источника.

Вот несколько примеров расширенных правил синхронизации для этого коннектора.

Пример: Два запроса

Эти правила извлекают все записи из таблиц employee и customer. Данные из этих таблиц будут синхронизированы с Elasticsearch отдельно.

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

Пример: Один запрос WHERE

Это правило извлекает только записи из таблицы employee, где значение emp_id больше 5. Только эти отфильтрованные записи будут синхронизированы с Elasticsearch.

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

Пример: Один запрос JOIN

Это правило извлекает записи, выполняя INNER JOIN между таблицами employee и customer по условию, что значение emp_id в таблице employee соответствует значению c_id в таблице customer. Результат этого объединённых данных будет синхронизирован с 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.

Следующие совместимы с рамками подключения Elastic:

Следующие поля конфигурации необходимы для настройки подключения:

Вы можете развернуть подключение к Microsoft SQL в качестве самостоятельного подключения с помощью Docker. Следуйте этим инструкциям.

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.3 \
/app/bin/elastic-ingest \
-c /config/config.yml

См. DOCKER.md в репозитории elastic/connectors для получения дополнительной информации.

Найдите все доступные образы Docker в официальном реестре.

Основные правила синхронизации одинаковы для всех коннекторов и доступны по умолчанию. Для получения дополнительной информации ознакомьтесь с правилами синхронизации.

Этот коннектор поддерживает расширенные правила синхронизации для удалённого фильтрации. Эти правила охватывают сложные сценарии запросов и фильтрации, которые нельзя выразить с помощью основных правил синхронизации. Расширенные правила синхронизации определяются с помощью JSON-фрагмента DSL, специфичного для источника.

Вот несколько примеров расширенных правил синхронизации для этого коннектора.

Пример: Два запроса

Эти правила извлекают все записи из обеих таблиц employee и customer. Данные из этих таблиц будут синхронизированы с Elasticsearch отдельно.

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

Пример: Один запрос WHERE

Это правило извлекает только записи из таблицы employee, где значение emp_id больше 5. Только эти отфильтрованные записи будут синхронизированы с Elasticsearch.

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

Пример: Один запрос JOIN

Это правило извлекает записи путём INNER JOIN между таблицами employee и customer по условию, что значение emp_id в таблице employee совпадает со значением c_id в таблице customer. Результат этих объединённых данных будет синхронизирован с Elasticsearch.

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

Фреймворк коннектора позволяет операторам проводить функциональные тесты на реальном источнике данных. Подробности см. в разделе тестирования коннекторов.

Для проведения конечного тестирования для коннектора Microsoft SQL запустите следующую команду:

make ftest NAME=mssql

Для более быстрых тестов добавьте флаг DATA_SIZE=small:

make ftest NAME=mssql DATA_SIZE=small

Для этого коннектора известных проблем нет. См. известные проблемы для проблем, затрагивающих все коннекторы.

См. Устранение неполадок.

См. Безопасность.

Этот коннектор использует исходный код универсального коннектора для баз данных (ветвь 8.17, совместимый с Elastic 8.17).

Просмотреть дополнительный код, специфичный для этого источника данных (ветвь 8.17, совместимый с Elastic 8.17).