target-mssql - Meltano Hub

Microsoft SQL Server

target-mssql (meltanolabs variant)🥇

Microsoft SQL Server

The target-mssql loader sends data into Microsoft SQL Server after it was pulled from a source using an extractor

Alternate Implementations

Meltano (default)🥇
Storebrand
🥇

Getting Started

Prerequisites

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

Installation and configuration

Add the target-mssql loader to your project using
```
meltano add
```
:

meltano add loader target-mssql

Configure the target-mssql settings using

meltano config

:

meltano config target-mssql set --interactive

Next steps

Follow the remaining steps of the Getting Started guide:

Run a data integration (EL) pipeline

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

Capabilities

The current capabilities for target-mssql may have been automatically set when originally added to the Hub. Please review the capabilities when using this loader. 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 loader.

This plugin has the following capabilities:

about
schema-flattening
stream-maps

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

Settings

The target-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
host
password
port
prefer_float_over_numeric
sqlalchemy_url
table_prefix
username

Expand To Show SDK Settings

default_target_schema
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 target-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: TARGET_MSSQL_DATABASE

SQL Server database

Configure this setting directly using the following Meltano command:

meltano config target-mssql set database [value]

Host (host)

Environment variable: TARGET_MSSQL_HOST

SQL Server host

Configure this setting directly using the following Meltano command:

meltano config target-mssql set host [value]

Password (password)

Environment variable: TARGET_MSSQL_PASSWORD

SQL Server password

Configure this setting directly using the following Meltano command:

meltano config target-mssql set password [value]

Port (port)

Environment variable: TARGET_MSSQL_PORT
Default Value: 1433

SQL Server port

Configure this setting directly using the following Meltano command:

meltano config target-mssql set port [value]

Prefer Float Over Numeric (prefer_float_over_numeric)

Environment variable: TARGET_MSSQL_PREFER_FLOAT_OVER_NUMERIC
Default Value: false

Use float data type for numbers (otherwise number type is used)

Configure this setting directly using the following Meltano command:

meltano config target-mssql set prefer_float_over_numeric [value]

SQLAlchemy URL (sqlalchemy_url)

Environment variable: TARGET_MSSQL_SQLALCHEMY_URL

SQLAlchemy connection string

Configure this setting directly using the following Meltano command:

meltano config target-mssql set sqlalchemy_url [value]

Table Prefix (table_prefix)

Environment variable: TARGET_MSSQL_TABLE_PREFIX

Prefix to add to table name

Configure this setting directly using the following Meltano command:

meltano config target-mssql set table_prefix [value]

Username (username)

Environment variable: TARGET_MSSQL_USERNAME

SQL Server username

Configure this setting directly using the following Meltano command:

meltano config target-mssql set username [value]

Expand To Show SDK Settings

Default Target Schema (default_target_schema)

Environment variable: TARGET_MSSQL_DEFAULT_TARGET_SCHEMA

Default target schema to write to

Configure this setting directly using the following Meltano command:

meltano config target-mssql set default_target_schema [value]

Flattening Enabled (flattening_enabled)

Environment variable: TARGET_MSSQL_FLATTENING_ENABLED

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

Configure this setting directly using the following Meltano command:

meltano config target-mssql set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

Environment variable: TARGET_MSSQL_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config target-mssql set flattening_max_depth [value]

Stream Map Config (stream_map_config)

Environment variable: TARGET_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 target-mssql set stream_map_config [value]

Stream Maps (stream_maps)

Environment variable: TARGET_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 target-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 target-mssql loader 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 loader target-mssql

Maintenance Status

Repo

https://github.com/MeltanoLabs/target-mssql

Maintainer

Meltano Stats

Keywords