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

Alternative variants #

Multiple variants of tap-mssql are available. This document describes the default wintersrd variant, which is recommended for new users.

Alternative variants are:

Getting Started #

Prerequisites #

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 :

    meltano add extractor tap-mssql
  2. Configure the settings below using meltano config .

Next steps #

Follow the remaining steps of the Getting Started guide:

  1. Select entities and attributes to extract
  2. Add a loader to send data to a destination
  3. Run a data integration (EL) pipeline
If you run into any issues, learn how to get help.

Capabilities #

Settings #

tap-mssql requires the configuration of the following settings:

The settings for extractor tap-mssql that are known to Meltano are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

Host (host) #

Your MSSQL server host.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-mssql set host <host>

export TAP_MSSQL_HOST=<host>

Database (database) #

Your MSSQL database name.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-mssql set database <database>

export TAP_MSSQL_DATABASE=<database>

User (user) #

Your MSSQL username.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-mssql set user <user>

export TAP_MSSQL_USER=<user>

Password (password) #

Your MSSQL password.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-mssql set password <password>

export TAP_MSSQL_PASSWORD=<password>

Filter Databases (filter_dbs) #

A comma separated list of databases to filter for.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-mssql set filter_dbs <filter_dbs>

export TAP_MSSQL_FILTER_DBS=<filter_dbs>

Port (port) #

The MSSQL port, defaulted to 1433.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-mssql set port <port>

export TAP_MSSQL_PORT=<port>

tds_version (tds_version) #

The TDS version of the connection. Defaults to 8.0, connecting to older databases (ex MS SQL 2005) requires 7.0 or earlier

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-mssql set tds_version <tds_version>

export TAP_MSSQL_TDS_VERSION=<tds_version>

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 #plugins-general channel.

Found an issue on this page? #

This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!