tap-mssql

Singer tap that extracts data from a Microsoft SQL Server (MSSQL) database and produces JSON-formatted data following the Singer spec.

Requirements

This tap is written in Clojure, and as such, requires Java and Leiningen.

• For full installation instructions, please see the installation guide.

Onboarding for Developers and Testers

To get started as a contributor and/or tester, see the contribution guidelines and developer guide.

Configuring tap-mssql

At minimum, the tap requires the following settings: host, port, database, username, and password.

• For detailed configuration instructions, including a list of supported settings, please check the configuration guide.

Running the tap

The tap supports several different wrappers and execution patterns for different types of environments.

Running in production

When executing in production, the following patterns are generally recommended:

1. Executing using lein directly (platform agnostic):

   # Discover metadata catalog:
   lein run -m tap-mssql.core --config config.json --discover > catalog.json
   
   # Execute sync to target-csv (for example):
   lein run -m tap-mssql.core --config config.json --sync | target-csv > state.json

2. Executing using the tap-mssql shell script wrapper (Linux/Mac only):

   # Discover metadata catalog:
   bin/tap-mssql --config config.json --discover > catalog.json
   
   # Execute sync to target-csv (for example):
   bin/tap-mssql  --config config.json --sync | target-csv > state.json

3. Executing using the tap-mssql batch script (Windows only):

   # Discover metadata catalog:
   bin/tap-mssql.bat --config config.json --discover > catalog.json
   
   # Execute sync to target-csv (for example):
   bin/tap-mssql.bat  --config config.json --sync | target-csv > state.json

4. Instructions to execute using docker:

   • Build the docker image (optional):

     docker build -t ghcr.io/slalom/tap-mssql:latest .

   • Run using docker:

     # Discover metadata catalog:
     docker run --rm -it -v .:/home/tap-mssql ghcr.io/slalom/tap-mssql:latest --config config.json --discover > catalog.json
     
     # Execute sync to target-csv (for example):
     docker run --rm -it -v .:/home/tap-mssql ghcr.io/slalom/tap-mssql:latest --config config.json --sync | target-csv > state.json

Other ways to run and test

For more ways to execute the tap, including dockerized methods, REPL methods, and various other testing configurations, see the the Developers Guide.

Troubleshooting

For help common errors, please see the troubleshooting guide.

---

Copyright © 2019 Stitch