The tap-mssql
extractor
pulls data from
Microsoft SQL Server that can
then be sent to a destination using a
loader.
Airbyte Usage Notice
Container-based connectors
can introduce deployment challenges including the potential need to run
Docker-in-Docker (not currently supported by services like AWS ECS, Meltano
Cloud, etc. see
FAQ
and
Airbyte's ECS deployment docs
for more details). Before using this variant we recommend considering if/how
you will be able to deploy container-based connectors to production.
For more context on how this Airbyte integration works please checkout out the
FAQ in the Meltano Docs.
Alternate Implementations
- Airbyte
🥈
-
Dan Norman
-
Connor Moreside
🥈
-
Stitch Data
🥈
-
Rob Winters
(default)🥈
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 -
Configure the tap-mssql
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-mssql --variant airbytemeltano config tap-mssql set --interactivemeltano config tap-mssql testNext 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
- 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:
airbyte_config.databaseairbyte_config.hostairbyte_config.jdbc_url_paramsairbyte_config.passwordairbyte_config.portairbyte_config.replication_method.data_to_syncairbyte_config.replication_method.methodairbyte_config.replication_method.snapshot_isolationairbyte_config.schemasairbyte_config.ssl_method.hostNameInCertificateairbyte_config.ssl_method.ssl_methodairbyte_config.tunnel_method.ssh_keyairbyte_config.tunnel_method.tunnel_hostairbyte_config.tunnel_method.tunnel_methodairbyte_config.tunnel_method.tunnel_portairbyte_config.tunnel_method.tunnel_userairbyte_config.tunnel_method.tunnel_user_passwordairbyte_config.usernameairbyte_spec.imageairbyte_spec.tagdocker_mounts
Expand To Show SDK Settings
You can also list these settings using
with the meltano configlist
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.
Airbyte Config Database (airbyte_config.database)
-
Environment variable:
TAP_MSSQL_AIRBYTE_CONFIG_DATABASE
The name of the database.
Configure this setting directly using the following Meltano command:
meltano config tap-mssql set airbyte_config database [value]Airbyte Config Host (airbyte_config.host)
-
Environment variable:
TAP_MSSQL_AIRBYTE_CONFIG_HOST
The hostname of the database.
Configure this setting directly using the following Meltano command:
meltano config tap-mssql set airbyte_config host [value]Airbyte Config Jdbc Url Params (airbyte_config.jdbc_url_params)
-
Environment variable:
TAP_MSSQL_AIRBYTE_CONFIG_JDBC_URL_PARAMS
Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).
Configure this setting directly using the following Meltano command:
meltano config tap-mssql set airbyte_config jdbc_url_params [value]Airbyte Config Password (airbyte_config.password)
-
Environment variable:
TAP_MSSQL_AIRBYTE_CONFIG_PASSWORD
The password associated with the username.
Configure this setting directly using the following Meltano command:
meltano config tap-mssql set airbyte_config password [value]Airbyte Config Port (airbyte_config.port)
-
Environment variable:
TAP_MSSQL_AIRBYTE_CONFIG_PORT
The port of the database.
Configure this setting directly using the following Meltano command:
meltano config tap-mssql set airbyte_config port [value]Airbyte Config Replication Method Data To Sync (airbyte_config.replication_method.data_to_sync)
-
Environment variable:
TAP_MSSQL_AIRBYTE_CONFIG_REPLICATION_METHOD_DATA_TO_SYNC
What data should be synced under the CDC. "Existing and New" will read existing data as a snapshot, and sync new changes through CDC. "New Changes Only" will skip the initial snapshot, and only sync new changes through CDC.
Configure this setting directly using the following Meltano command:
meltano config tap-mssql set airbyte_config replication_method.data_to_sync [value]Airbyte Config Replication Method Method (airbyte_config.replication_method.method)
-
Environment variable:
TAP_MSSQL_AIRBYTE_CONFIG_REPLICATION_METHOD_METHOD
STANDARD, CDC
Configure this setting directly using the following Meltano command:
meltano config tap-mssql set airbyte_config replication_method.method [value]Airbyte Config Replication Method Snapshot Isolation (airbyte_config.replication_method.snapshot_isolation)
-
Environment variable:
TAP_MSSQL_AIRBYTE_CONFIG_REPLICATION_METHOD_SNAPSHOT_ISOLATION
Existing data in the database are synced through an initial snapshot. This parameter controls the isolation level that will be used during the initial snapshotting. If you choose the "Snapshot" level, you must enable the snapshot isolation mode on the database.
Configure this setting directly using the following Meltano command:
meltano config tap-mssql set airbyte_config replication_method.snapshot_isolation [value]Airbyte Config Schemas (airbyte_config.schemas)
-
Environment variable:
TAP_MSSQL_AIRBYTE_CONFIG_SCHEMAS
The list of schemas to sync from. Defaults to user. Case sensitive.
Configure this setting directly using the following Meltano command:
meltano config tap-mssql set airbyte_config schemas [value]Airbyte Config Ssl Method Hostnameincertificate (airbyte_config.ssl_method.hostNameInCertificate)
-
Environment variable:
TAP_MSSQL_AIRBYTE_CONFIG_SSL_METHOD_HOSTNAMEINCERTIFICATE
Specifies the host name of the server. The value of this property must match the subject property of the certificate.
Configure this setting directly using the following Meltano command:
meltano config tap-mssql set airbyte_config ssl_method.hostNameInCertificate [value]Airbyte Config Ssl Method Ssl Method (airbyte_config.ssl_method.ssl_method)
-
Environment variable:
TAP_MSSQL_AIRBYTE_CONFIG_SSL_METHOD_SSL_METHOD
unencrypted, encrypted_trust_server_certificate, encrypted_verify_certificate
Configure this setting directly using the following Meltano command:
meltano config tap-mssql set airbyte_config ssl_method.ssl_method [value]Airbyte Config Tunnel Method Ssh Key (airbyte_config.tunnel_method.ssh_key)
-
Environment variable:
TAP_MSSQL_AIRBYTE_CONFIG_TUNNEL_METHOD_SSH_KEY
OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )
Configure this setting directly using the following Meltano command:
meltano config tap-mssql set airbyte_config tunnel_method.ssh_key [value]Airbyte Config Tunnel Method Tunnel Host (airbyte_config.tunnel_method.tunnel_host)
-
Environment variable:
TAP_MSSQL_AIRBYTE_CONFIG_TUNNEL_METHOD_TUNNEL_HOST
Hostname of the jump server host that allows inbound ssh tunnel., Hostname of the jump server host that allows inbound ssh tunnel.
Configure this setting directly using the following Meltano command:
meltano config tap-mssql set airbyte_config tunnel_method.tunnel_host [value]Airbyte Config Tunnel Method Tunnel Method (airbyte_config.tunnel_method.tunnel_method)
-
Environment variable:
TAP_MSSQL_AIRBYTE_CONFIG_TUNNEL_METHOD_TUNNEL_METHOD
NO_TUNNEL, SSH_KEY_AUTH, SSH_PASSWORD_AUTH
Configure this setting directly using the following Meltano command:
meltano config tap-mssql set airbyte_config tunnel_method.tunnel_method [value]Airbyte Config Tunnel Method Tunnel Port (airbyte_config.tunnel_method.tunnel_port)
-
Environment variable:
TAP_MSSQL_AIRBYTE_CONFIG_TUNNEL_METHOD_TUNNEL_PORT
Port on the proxy/jump server that accepts inbound ssh connections., Port on the proxy/jump server that accepts inbound ssh connections.
Configure this setting directly using the following Meltano command:
meltano config tap-mssql set airbyte_config tunnel_method.tunnel_port [value]Airbyte Config Tunnel Method Tunnel User (airbyte_config.tunnel_method.tunnel_user)
-
Environment variable:
TAP_MSSQL_AIRBYTE_CONFIG_TUNNEL_METHOD_TUNNEL_USER
OS-level username for logging into the jump server host., OS-level username for logging into the jump server host
Configure this setting directly using the following Meltano command:
meltano config tap-mssql set airbyte_config tunnel_method.tunnel_user [value]Airbyte Config Tunnel Method Tunnel User Password (airbyte_config.tunnel_method.tunnel_user_password)
-
Environment variable:
TAP_MSSQL_AIRBYTE_CONFIG_TUNNEL_METHOD_TUNNEL_USER_PASSWORD
OS-level password for logging into the jump server host
Configure this setting directly using the following Meltano command:
meltano config tap-mssql set airbyte_config tunnel_method.tunnel_user_password [value]Airbyte Config Username (airbyte_config.username)
-
Environment variable:
TAP_MSSQL_AIRBYTE_CONFIG_USERNAME
The username which is used to access the database.
Configure this setting directly using the following Meltano command:
meltano config tap-mssql set airbyte_config username [value]Airbyte Spec Image (airbyte_spec.image)
-
Environment variable:
TAP_MSSQL_AIRBYTE_SPEC_IMAGE -
Default Value:
airbyte/source-mssql
Airbyte image to run
Configure this setting directly using the following Meltano command:
meltano config tap-mssql set airbyte_spec image [value]Airbyte Spec Tag (airbyte_spec.tag)
-
Environment variable:
TAP_MSSQL_AIRBYTE_SPEC_TAG -
Default Value:
latest
Airbyte image tag
Configure this setting directly using the following Meltano command:
meltano config tap-mssql set airbyte_spec tag [value]Docker Mounts (docker_mounts)
-
Environment variable:
TAP_MSSQL_DOCKER_MOUNTS
Docker mounts to make available to the Airbyte container. Expects a list of maps containing source, target, and type as is documented in the docker --mount documentation
Configure this setting directly using the following Meltano command:
meltano config tap-mssql set docker_mounts [value]Expand To Show SDK Settings
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?
#plugins-general-yellow){kind=icon}
-55-c0c0c4){kind=icon}
-4-c0c0c4){kind=icon}
