tap-mssql - Meltano Hub

Microsoft SQL Server

tap-mssql (buzzcutnorman variant)🥇

Microsoft SQL Server

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

Alternate Implementations

Getting Started

Prerequisites

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

Installation and configuration

Add the tap-mssql extractor to your project using
```
meltano add
```
:

meltano add extractor tap-mssql --variant buzzcutnorman

Configure the tap-mssql settings using

meltano config

:

meltano config tap-mssql set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-mssql test

Next steps

Follow the remaining steps of the Getting Started guide:

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

Capabilities

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:

about
batch
catalog
discover
schema-flattening
state
stream-maps

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

Settings

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:

database
dialect
driver_type
hd_jsonschema_types
host
password
port
sqlalchemy_eng_params.fast_executemany
sqlalchemy_eng_params.future
sqlalchemy_url_query.MultiSubnetFailover
sqlalchemy_url_query.TrustServerCertificate
sqlalchemy_url_query.driver
start_date
user

Expand To Show SDK Settings

batch_config.encoding.compression
batch_config.encoding.format
batch_config.storage.prefix
batch_config.storage.root
faker_config.locale
faker_config.seed
flattening_enabled
flattening_max_depth
stream_map_config
stream_maps

You can also list these settings using

meltano config

with the list subcommand:

meltano config tap-mssql 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.

Database (database)

Environment variable: TAP_MSSQL_DATABASE

The Default database for this connection

Configure this setting directly using the following Meltano command:

meltano config tap-mssql set database [value]

Dialect (dialect)

Environment variable: TAP_MSSQL_DIALECT
Default Value: mssql

The Dialect of SQLAlchamey

Configure this setting directly using the following Meltano command:

meltano config tap-mssql set dialect [value]

Driver Type (driver_type)

Environment variable: TAP_MSSQL_DRIVER_TYPE
Default Value: pymssql

The Python Driver you will be using to connect to the SQL server

Configure this setting directly using the following Meltano command:

meltano config tap-mssql set driver_type [value]

Hd Jsonschema Types (hd_jsonschema_types)

Environment variable: TAP_MSSQL_HD_JSONSCHEMA_TYPES
Default Value: false

Turn on Higher Defined(HD) JSON Schema types to assist Targets

Configure this setting directly using the following Meltano command:

meltano config tap-mssql set hd_jsonschema_types [value]

Host (host)

Environment variable: TAP_MSSQL_HOST

The FQDN of the Host serving out the SQL Instance

Configure this setting directly using the following Meltano command:

meltano config tap-mssql set host [value]

Password (password)

Environment variable: TAP_MSSQL_PASSWORD

The Password for the User account

Configure this setting directly using the following Meltano command:

meltano config tap-mssql set password [value]

Port (port)

Environment variable: TAP_MSSQL_PORT

The port on which SQL awaiting connection

Configure this setting directly using the following Meltano command:

meltano config tap-mssql set port [value]

SQLAlchemy Eng Params Fast Executemany (sqlalchemy_eng_params.fast_executemany)

Environment variable: TAP_MSSQL_SQLALCHEMY_ENG_PARAMS_FAST_EXECUTEMANY

Fast Executemany Mode: True, False

Configure this setting directly using the following Meltano command:

meltano config tap-mssql set sqlalchemy_eng_params fast_executemany [value]

SQLAlchemy Eng Params Future (sqlalchemy_eng_params.future)

Environment variable: TAP_MSSQL_SQLALCHEMY_ENG_PARAMS_FUTURE

Run the engine in 2.0 mode: True, False

Configure this setting directly using the following Meltano command:

meltano config tap-mssql set sqlalchemy_eng_params future [value]

SQLAlchemy URL Query Multisubnetfailover (sqlalchemy_url_query.MultiSubnetFailover)

Environment variable: TAP_MSSQL_SQLALCHEMY_URL_QUERY_MULTISUBNETFAILOVER

This is a Yes No option

Configure this setting directly using the following Meltano command:

meltano config tap-mssql set sqlalchemy_url_query MultiSubnetFailover [value]

SQLAlchemy URL Query Trustservercertificate (sqlalchemy_url_query.TrustServerCertificate)

Environment variable: TAP_MSSQL_SQLALCHEMY_URL_QUERY_TRUSTSERVERCERTIFICATE

This is a Yes No option

Configure this setting directly using the following Meltano command:

meltano config tap-mssql set sqlalchemy_url_query TrustServerCertificate [value]

SQLAlchemy URL Query Driver (sqlalchemy_url_query.driver)

Environment variable: TAP_MSSQL_SQLALCHEMY_URL_QUERY_DRIVER

The Driver to use when connection should match the Driver Type

Configure this setting directly using the following Meltano command:

meltano config tap-mssql set sqlalchemy_url_query driver [value]

Start Date (start_date)

Environment variable: TAP_MSSQL_START_DATE

The earliest record date to sync

Configure this setting directly using the following Meltano command:

meltano config tap-mssql set start_date [value]

User (user)

Environment variable: TAP_MSSQL_USER

The User Account who has been granted access to the SQL Server

Configure this setting directly using the following Meltano command:

meltano config tap-mssql set user [value]

Expand To Show SDK Settings

Batch Config Encoding Compression (batch_config.encoding.compression)

Environment variable: TAP_MSSQL_BATCH_CONFIG_ENCODING_COMPRESSION

Currently the only compression options is gzip

Configure this setting directly using the following Meltano command:

meltano config tap-mssql set batch_config encoding.compression [value]

Batch Config Encoding Format (batch_config.encoding.format)

Environment variable: TAP_MSSQL_BATCH_CONFIG_ENCODING_FORMAT

Currently the only format is jsonl

Configure this setting directly using the following Meltano command:

meltano config tap-mssql set batch_config encoding.format [value]

Batch Config Storage Prefix (batch_config.storage.prefix)

Environment variable: TAP_MSSQL_BATCH_CONFIG_STORAGE_PREFIX

What prefix you want your messages to have example: test-batch-

Configure this setting directly using the following Meltano command:

meltano config tap-mssql set batch_config storage.prefix [value]

Batch Config Storage Root (batch_config.storage.root)

Environment variable: TAP_MSSQL_BATCH_CONFIG_STORAGE_ROOT

The directory you want batch messages to be placed in example: file://test/batches

Configure this setting directly using the following Meltano command:

meltano config tap-mssql set batch_config storage.root [value]

Faker Config Locale (faker_config.locale)

Environment variable: TAP_MSSQL_FAKER_CONFIG_LOCALE

One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization

Configure this setting directly using the following Meltano command:

meltano config tap-mssql set faker_config locale [value]

Faker Config Seed (faker_config.seed)

Environment variable: TAP_MSSQL_FAKER_CONFIG_SEED

Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator

Configure this setting directly using the following Meltano command:

meltano config tap-mssql set faker_config seed [value]

Flattening Enabled (flattening_enabled)

Environment variable: TAP_MSSQL_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.

Configure this setting directly using the following Meltano command:

meltano config tap-mssql set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

Environment variable: TAP_MSSQL_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-mssql set flattening_max_depth [value]

Stream Map Config (stream_map_config)

Environment variable: TAP_MSSQL_STREAM_MAP_CONFIG

User-defined config values to be used within map expressions.

Configure this setting directly using the following Meltano command:

meltano config tap-mssql set stream_map_config [value]

Stream Maps (stream_maps)

Environment variable: TAP_MSSQL_STREAM_MAPS

Config object for stream maps capability. For more information check out Stream Maps.

Configure this setting directly using the following Meltano command:

meltano config tap-mssql set stream_maps [value]

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

#plugins-general

channel.

Install

meltano add extractor tap-mssql --variant buzzcutnorman

Maintenance Status

Repo

https://github.com/BuzzCutNorman/tap-mssql

Maintainer

Meltano Stats

Keywords