mrhorvath / tap-mssql

Singer Tap for MS SQL built with Meltano Singer SDK.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

tap-mssql

tap-mssql is a Singer tap for mssql. !!! Warning !!! work in progress. Full loads working. You can setup a batch_config and generate batch messages.

Built with the Meltano Tap SDK for Singer Taps.

Installation

Prerequisites

You will need to install the SQL Server Native Driver or ODBC Driver for SQL Server

Installing Microsoft ODBC Driver for SQL Server

Install from GitHub:

pipx install git+https://github.com/BuzzCutNorman/tap-mssql.git

Install using Meltano as a Custom Plugin

Configuration

Accepted Config Options

Setting Required Default Description
dialect False None The Dialect of SQLAlchamey
driver_type False None The Python Driver you will be using to connect to the SQL server (either "pyodbc" or "pymssql")
host False None The FQDN of the Host serving out the SQL Instance
port False None The port on which SQL awaiting connection
user False None The User Account who has been granted access to the SQL Server
password False None The Password for the User account
database False None The Default database for this connection
sqlalchemy_eng_params False None SQLAlchemy Engine Paramaters: fast_executemany, future
sqlalchemy_url_query False None SQLAlchemy URL Query options: driver, TrustServerCertificate
batch_config False None Optional Batch Message configuration
start_date False None The earliest record date to sync
stream_maps False None Config object for stream maps capability. For more information check out Stream Maps.
stream_map_config False None User-defined config values to be used within map expressions.
flattening_enabled False None 'True' to enable schema flattening and automatically expand nested properties.
flattening_max_depth False None The max depth to flatten schemas.

A full list of supported settings and capabilities for this tap is available by running:

tap-mssql --about

Configure using environment variables

This Singer tap will automatically import any environment variables within the working directory's .env if the --config=ENV is provided, such that config values will be considered if a matching environment variable is set either in the terminal context or in the .env file.

Usage

You can easily run tap-mssql by itself or in a pipeline using Meltano.

SDK Dev Guide

See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.

About

Singer Tap for MS SQL built with Meltano Singer SDK.


Languages

Language:Python 100.0%