Elastic Microsoft SQL connector referenceedit

The Elastic Microsoft SQL connector is a connector for Microsoft SQL databases. This connector is written in Python using the Elastic connector framework.

View the source code for this connector (branch 8.11, compatible with Elastic 8.11).

Native connector (Elastic Cloud)edit

View native connector reference

Availability and prerequisitesedit

This connector is available as a native connector in Elastic versions 8.8.0 and later. To use this connector natively in Elastic Cloud, satisfy all native connector requirements.

This connector is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

Usageedit

To use this connector as a native connector, use the Connector workflow. See Native connectors.

Users require the sysadmin server role.

For additional operations, see Using connectors.

Compatibilityedit

The following are compatible with Elastic connector frameworks:

  • Microsoft SQL Server versions 2017, 2019
  • Azure SQL
  • Amazon RDS for SQL Server

Configurationedit

The following configuration fields are required to set up the connector:

Host

The server host address where the Microsoft SQL Server is hosted. Default value is 127.0.0.1. Examples:

  • 192.158.1.38
  • demo.instance.demo-region.demo.service.com
Port
The port where the Microsoft SQL Server is hosted. Default value is 9090.
Username
The username of the account for Microsoft SQL Server.
Password
The password of the account to be used for the Microsoft SQL Server.
Database

Name of the Microsoft SQL Server database. Examples:

  • employee_database
  • customer_database
Comma-separated list of tables

List of tables, separated by commas. The Microsoft SQL connector will fetch data from all tables present in the configured database, if the value is * . Default value is *. Examples:

  • table_1, table_2
  • *

    This field can be bypassed by advanced sync rules.

Schema

Name of the Microsoft SQL Server schema. Default value is dbo.

Examples:

  • dbo
  • custom_schema
Enable SSL
Toggle to enable SSL verification. Default value is False.
SSL certificate

Content of SSL certificate. If SSL is disabled, the ssl_ca value will be ignored.

Expand to see an example certificate
-----BEGIN CERTIFICATE-----
MIID+jCCAuKgAwIBAgIGAJJMzlxLMA0GCSqGSIb3DQEBCwUAMHoxCzAJBgNVBAYT
...
7RhLQyWn2u00L7/9Omw=
-----END CERTIFICATE-----
Validate host
Toggle to enable host validation. Default value is False.

Documents and syncsedit

  • Tables with no primary key defined are skipped.
  • If the last_user_update of sys.dm_db_index_usage_stats table is not available for a specific table and database then all data in that table will be synced.
  • Files bigger than 10 MB won’t be extracted.
  • Permissions are not synced. All documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.

Sync rulesedit

Basic sync rules are identical for all connectors and are available by default. For more information read sync rules.

Advanced sync rulesedit

This connector supports advanced sync rules for remote filtering. These rules cover complex query-and-filter scenarios that cannot be expressed with basic sync rules. Advanced sync rules are defined through a source-specific DSL JSON snippet.

A full sync is required for advanced sync rules to take effect.

Here are a few examples of advanced sync rules for this connector.

Expand to see example data

employee table

emp_id name age

3

John

28

10

Jane

35

14

Alex

22

* customer table

c_id name age

2

Elm

24

6

Pine

30

9

Oak

34

Example: Two queriesedit

These rules fetch all records from both the employee and customer tables. The data from these tables will be synced separately to Elasticsearch.

[
  {
    "tables": [
      "employee"
    ],
    "query": "SELECT * FROM employee"
  },
  {
    "tables": [
      "customer"
    ],
    "query": "SELECT * FROM customer"
  }
]
Example: One WHERE queryedit

This rule fetches only the records from the employee table where the emp_id is greater than 5. Only these filtered records will be synced to Elasticsearch.

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

This rule fetches records by performing an INNER JOIN between the employee and customer tables on the condition that the emp_id in employee matches the c_id in customer. The result of this combined data will be synced to Elasticsearch.

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

When using advanced rules, a query can bypass the configuration field tables. This will happen if the query specifies a table that doesn’t appear in the configuration. This can also happen if the configuration specifies * to fetch all tables while the advanced sync rule requests for only a subset of tables.

Content extractionedit

See Content extraction.

Known issuesedit

There are no known issues for this connector. See Known issues for any issues affecting all connectors.

Troubleshootingedit

See Troubleshooting.

Securityedit

See Security.

This connector uses the generic database connector source code (branch 8.11, compatible with Elastic 8.11).

View additional code specific to this data source (branch 8.11, compatible with Elastic 8.11).

Connector client (self-managed)edit

View connector client reference

Availability and prerequisitesedit

This connector is available as a self-managed connector client. To use this connector, satisfy all connector client requirements.

This connector is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

Usageedit

Self-manage this connector

Because this client is available as a native connector, you’ll first need to convert to a connector client in the Kibana UI. This action is irreversible. Use the Convert connector button on the right-hand side of the configuration page.

Users require the sysadmin server role.

To use this connector as a connector client, see Connector clients.

For additional usage operations, see Using connectors.

Compatibilityedit

The following are compatible with Elastic connector frameworks:

  • Microsoft SQL Server versions 2017, 2019
  • Azure SQL
  • Amazon RDS for SQL Server

Configurationedit

When using the connector client workflow, initially these fields will use the default configuration set in the connector source code. Note that this data source uses the generic_database.py connector source code.

Refer to mssql.py for additional code, specific to this data source. These configurable fields will be rendered with their respective labels in the Kibana UI. Once connected, users will be able to update these values in Kibana.

The following configuration fields are required to set up the connector:

host

The server host address where the Microsoft SQL Server is hosted. Default value is 127.0.0.1. Examples:

  • 192.158.1.38
  • demo.instance.demo-region.demo.service.com
port
The port where the Microsoft SQL Server is hosted. Default value is 9090.
username
The username of the account for Microsoft SQL Server.
password
The password of the account to be used for the Microsoft SQL Server.
database

Name of the Microsoft SQL Server database. Examples:

  • employee_database
  • customer_database
tables

Comma-separated list of tables. The Microsoft SQL connector will fetch data from all tables present in the configured database, if the value is * . Default value is *. Examples:

  • table_1, table_2
  • *

    This field can be bypassed by advanced sync rules.

fetch_size
Rows fetched per request.
retry_count
The number of retry attempts per failed request.
schema

Name of the Microsoft SQL Server schema. Default value is dbo.

Examples:

  • dbo
  • custom_schema
ssl_enabled
SSL verification enablement. Default value is False.
ssl_ca

Content of SSL certificate. If SSL is disabled, the ssl_ca value will be ignored.

Expand to see an example certificate
-----BEGIN CERTIFICATE-----
MIID+jCCAuKgAwIBAgIGAJJMzlxLMA0GCSqGSIb3DQEBCwUAMHoxCzAJBgNVBAYT
...
7RhLQyWn2u00L7/9Omw=
-----END CERTIFICATE-----
validate_host
Host validation enablement. Default value is False.

Deployment using Dockeredit

You can deploy the Microsoft SQL connector as a self-managed connector client using Docker. Follow these instructions.

Step 1: Download sample configuration file

Download the sample configuration file. You can either download it manually or run the following command:

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

Remember to update the --output argument value if your directory name is different, or you want to use a different config file name.

Step 2: Update the configuration file for your self-managed connector

Update the configuration file with the following settings to match your environment:

  • elasticsearch.host
  • elasticsearch.api_key
  • connectors

If you’re running the connector service against a Dockerized version of Elasticsearch and Kibana, your config file will look like this:

# 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>

Using the elasticsearch.api_key is the recommended authentication method. However, you can also use elasticsearch.username and elasticsearch.password to authenticate with your Elasticsearch instance.

Note: You can change other default configurations by simply uncommenting specific settings in the configuration file and modifying their values.

Step 3: Run the Docker image

Run the Docker image with the Connector Service using the following command:

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

Refer to DOCKER.md in the elastic/connectors repo for more details.

Find all available Docker images in the official registry.

Documents and syncsedit

  • Tables with no primary key defined are skipped.
  • If the last_user_update of sys.dm_db_index_usage_stats table is not available for a specific table and database then all data in that table will be synced.
  • Files bigger than 10 MB won’t be extracted.
  • Permissions are not synced. All documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.

Sync rulesedit

Basic sync rules are identical for all connectors and are available by default. For more information read sync rules.

Advanced sync rulesedit

This connector supports advanced sync rules for remote filtering. These rules cover complex query-and-filter scenarios that cannot be expressed with basic sync rules. Advanced sync rules are defined through a source-specific DSL JSON snippet.

A full sync is required for advanced sync rules to take effect.

Here are a few examples of advanced sync rules for this connector.

Expand to see example data

employee table

emp_id name age

3

John

28

10

Jane

35

14

Alex

22

* customer table

c_id name age

2

Elm

24

6

Pine

30

9

Oak

34

Example: Two queriesedit

These rules fetch all records from both the employee and customer tables. The data from these tables will be synced separately to Elasticsearch.

[
  {
    "tables": [
      "employee"
    ],
    "query": "SELECT * FROM employee"
  },
  {
    "tables": [
      "customer"
    ],
    "query": "SELECT * FROM customer"
  }
]
Example: One WHERE queryedit

This rule fetches only the records from the employee table where the emp_id is greater than 5. Only these filtered records will be synced to Elasticsearch.

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

This rule fetches records by performing an INNER JOIN between the employee and customer tables on the condition that the emp_id in employee matches the c_id in customer. The result of this combined data will be synced to Elasticsearch.

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

When using advanced rules, a query can bypass the configuration field tables. This will happen if the query specifies a table that doesn’t appear in the configuration. This can also happen if the configuration specifies * to fetch all tables while the advanced sync rule requests for only a subset of tables.

Content extractionedit

See Content extraction.

End-to-end testingedit

The connector framework enables operators to run functional tests against a real data source. Refer to Connector testing for more details.

To perform E2E testing for the Microsoft SQL connector, run the following command:

make ftest NAME=mssql

For faster tests, add the DATA_SIZE=small flag:

make ftest NAME=mssql DATA_SIZE=small

Known issuesedit

There are no known issues for this connector. See Known issues for any issues affecting all connectors.

Troubleshootingedit

See Troubleshooting.

Securityedit

See Security.

This connector uses the generic database connector source code (branch 8.11, compatible with Elastic 8.11).

View additional code specific to this data source (branch 8.11, compatible with Elastic 8.11).