Elastic Microsoft SQL connector referenceedit

The Elastic Microsoft SQL connector is a connector for Microsoft SQL databases.

Availability and prerequisitesedit

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

This connector is also available as a connector client from the Python connectors framework. 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.


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

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

Users require the sysadmin server role.

For additional operations, see Usage.


The following are compatible with Elastic connector frameworks:

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


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:


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

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

Name of the Microsoft SQL Server database. Examples:

  • employee_database
  • customer_database

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
  • *

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


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

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

Expand to see an example certificate
Host validation enablement. Default value is False.
The number of rows to fetch on each request to Microsoft SQL Server. Default value is 50.
The number of retry attempts after failed request to Microsoft SQL Server. Default value is 3.

Deployment using Dockeredit

Follow these instructions to deploy the Microsoft SQL connector using Docker.

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-python/main/config.yml --output ~/connectors-python-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.password
  • connector_id
  • service_type

Use jira as the service_type value. Don’t forget to uncomment "jira" in the sources section of the yaml file.

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

  host: http://host.docker.internal:9200
  username: elastic
  password: <YOUR_PASSWORD>

service_type: jira

  # UNCOMMENT "jira" below to enable the Microsoft SQL connector

  #mongodb: connectors.sources.mongo:MongoDataSource
  #s3: connectors.sources.s3:S3DataSource
  #dir: connectors.sources.directory:DirectoryDataSource
  #mysql: connectors.sources.mysql:MySqlDataSource
  #network_drive: connectors.sources.network_drive:NASDataSource
  #google_cloud_storage: connectors.sources.google_cloud_storage:GoogleCloudStorageDataSource
  #azure_blob_storage: connectors.sources.azure_blob_storage:AzureBlobStorageDataSource
  #postgresql: connectors.sources.postgresql:PostgreSQLDataSource
  #oracle: connectors.sources.oracle:OracleDataSource
  #mssql: connectors.sources.mssql:MSSQLDataSource

Note that the config file you downloaded might contain more entries, so you will need to manually copy/change the settings that apply to you. Normally you’ll only need to update elasticsearch.host, elasticsearch.password, connector_id and service_type to run the connector service.

Step 3: Run the Docker image

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

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

Refer to this guide in the Python framework repository for more details.

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.

Sync rulesedit

  • Permissions are not synced. All documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.
  • Filtering rules are not available in the present version. Currently, filtering is controlled by ingest pipelines.

Content extractionedit

See Content extraction.

Connector client operationsedit

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.


See Troubleshooting.


See Security.

Framework and sourceedit

This connector is included in the Python connectors framework.

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

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