Microsoft SQL Server

tap-mssql from wintersrd

Microsoft SQL Server

The tap-mssql extractor pulls data from Microsoft SQL Server that can then be sent to a destination using a loader.

Available Variants

Getting Started


If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-mssql extractor to your project using
    meltano add
  2. meltano add extractor tap-mssql
  3. Configure the tap-mssql settings using
    meltano config
  4. meltano config tap-mssql set --interactive
  5. Test that extractor settings are valid using
    meltano config
  6. meltano config tap-mssql test

Next steps

If you run into any issues, learn how to get help.


The current capabilities for tap-mssql may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

  • catalog
  • discover
  • state

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.


The tap-mssql settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Host (host)

  • Environment variable: TAP_MSSQL_HOST

Your MSSQL server host.

Database (database)

  • Environment variable: TAP_MSSQL_DATABASE

Your MSSQL database name.

User (user)

  • Environment variable: TAP_MSSQL_USER

Your MSSQL username.

Password (password)

  • Environment variable: TAP_MSSQL_PASSWORD

Your MSSQL password.

Filter Databases (filter_dbs)

  • Environment variable: TAP_MSSQL_FILTER_DBS

A comma separated list of databases to filter for.

Port (port)

  • Environment variable: TAP_MSSQL_PORT

The MSSQL port, defaulted to 1433.

TDS Version (tds_version)

  • Environment variable: TAP_MSSQL_TDS_VERSION

The TDS version of the connection. Defaults to 7.3, connecting to older databases (ex MS SQL 2005) requires 7.0 or earlier. Please see the pymssql or FreeTSD documentation for more details. Also note, while this is a confusing topic version 7.3 is more current than 8.0.

Use Date Datatype (use_date_datatype)

  • Environment variable: TAP_MSSQL_USE_DATE_DATATYPE
  • Default Value: false

To emit a date datatype as a date without a time component or time without an UTC offset. If this boolean config item is not set, the default behaviour is false i.e. emit date datatypes as a datetime. It is recommended to set this on if you have time datatypes and are having issues uploading into into a target database.

Characterset (characterset)

  • Environment variable: TAP_MSSQL_CHARACTERSET

The characterset for the database / source system. The default is utf8, however older databases might use a charactersets like cp1252 for the encoding. If you have errors with a UnicodeDecodeError: 'utf-8' codec can't decode byte .... then a solution is to examine the characterset of the source database / system and make an appropriate substitution for utf8 like cp1252.

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-mssql extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the


meltano add extractor tap-mssql

Maintenance Status

  • Maintenance Status
  • Stars
  • Forks
  • Open Issues
  • Open PRs
  • Contributors
  • License


  • Rob Winters

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

PyPI Stats

  • PyPI Downloads
  • PyPI Package Version


  • database