IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elastic Docs › ›Elastic connectors
« Google Cloud Storage Connector Elastic MongoDB connector reference »

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

Usageedit

To use this connector as a connector client, use the build a connector workflow. See Connector clients and frameworks.

Users require the sysadmin server role.

For additional operations, see Usage.

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 build a connector workflow, intially 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
  • *
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, keep the ssl_ca field empty.

Expand to see an example certificate 
-----BEGIN CERTIFICATE-----
MIID+jCCAuKgAwIBAgIGAJJMzlxLMA0GCSqGSIb3DQEBCwUAMHoxCzAJBgNVBAYT
...
7RhLQyWn2u00L7/9Omw=
-----END CERTIFICATE-----
validate_host
Host validation enablement. Default value is False.
fetch_size
The number of rows to fetch on each request to Microsoft SQL Server. Default value is 50.
retry_count
The number of retry attempts after failed request to Microsoft SQL Server. Default value is 3.

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.

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.

Troubleshootingedit

See Troubleshooting.

Securityedit

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.7, compatible with Elastic 8.7).

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

« Google Cloud Storage Connector Elastic MongoDB connector reference »