-
Notifications
You must be signed in to change notification settings - Fork 68
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add the SpaceCondor variant of tap-mssql #1918
Merged
Merged
+129
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
edgarrmondragon
requested review from
tayloramurphy and
pnadolny13
as code owners
January 3, 2025 16:15
Closed
edgarrmondragon
temporarily deployed
to
preview
January 3, 2025 16:15 — with
GitHub Actions
Inactive
✅ Deploy Preview for meltano-hub ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Testing plugin
Auto-generated README.md
|
Setting | Required | Default | Description |
---|---|---|---|
host | False | None | Host for SQL Server Instance. |
database | False | None | Database to connect to. |
port | False | 1433 | The port of the SQL Server Instance. |
username | False | None | Username used to authenticate. |
password | False | None | Password used to authenticate. |
sqlalchemy_url_query_options | False | None | List of SQLAlchemy URL Query options to provide. Example: driver, TrustServerCertificate, etc. |
sqlalchemy_url_query | False | None | SQLAlchemy URL. Setting this will take precedence over other connection settings. |
default_replication_method | False | FULL_TABLE | Replication method to use if there is not a catalog entry to override this choice. One of FULL_TABLE , INCREMENTAL , or LOG_BASED . |
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. |
faker_config | False | None | Config for the Faker instance variable fake used within map expressions. Only applicable if the plugin specifies faker as an addtional dependency (through the singer-sdk faker extra or directly). |
faker_config.seed | False | None | Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator |
faker_config.locale | False | None | One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization |
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. |
batch_config | False | None | Configuration for BATCH message capabilities. |
batch_config.encoding | False | None | Specifies the format and compression of the batch files. |
batch_config.encoding.format | False | None | Format to use for batch files. |
batch_config.encoding.compression | False | None | Compression format to use for batch files. |
batch_config.storage | False | None | Defines the storage layer to use when writing batch files |
batch_config.storage.root | False | None | Root path to use when writing batch files. |
batch_config.storage.prefix | False | None | Prefix to use when writing batch files. |
A full list of supported settings and capabilities is available by running: tap-mssql --about
Version info
tap-mssql v0.0.2, Meltano SDK v0.43.1
Usage info
melty-bot % tap-mssql --help
Usage: tap-mssql [OPTIONS]
Execute the Singer tap.
Options:
--version Display the package version.
--about Display package metadata and settings.
--format [json|markdown] Specify output style for --about
--config TEXT Configuration file location or 'ENV' to use
environment variables.
--discover Run the tap in discovery mode.
--test TEXT Use --test to sync a single record for each
stream. Use --test=schema to test schema output
without syncing records.
--catalog FILE Use a Singer catalog file with the tap.
--state FILE Use a bookmarks file for incremental replication.
--help Show this message and exit.
Detected capabilities
- ✅ 'discover'
- ✅ 'catalog'
- ✅ 'state'
- ✅ 'about'
JSON Metadata
{
"name": "tap-mssql",
"description": "MSSQL tap class.",
"version": "0.0.2",
"sdk_version": "0.43.1",
"supported_python_versions": [],
"capabilities": [
"catalog",
"state",
"discover",
"about",
"stream-maps",
"schema-flattening",
"batch"
],
"settings": {
"type": "object",
"properties": {
"host": {
"type": [
"string",
"null"
],
"description": "Host for SQL Server Instance."
},
"database": {
"type": [
"string",
"null"
],
"description": "Database to connect to."
},
"port": {
"type": [
"integer",
"null"
],
"default": 1433,
"description": "The port of the SQL Server Instance."
},
"username": {
"type": [
"string",
"null"
],
"description": "Username used to authenticate."
},
"password": {
"type": [
"string",
"null"
],
"description": "Password used to authenticate.",
"secret": true,
"writeOnly": true
},
"sqlalchemy_url_query_options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"key": {
"type": [
"string",
"null"
],
"description": "Key of the sqlalchemy URL query option. Example: driver"
},
"value": {
"type": [
"string",
"null"
],
"description": "Value of the sqlalchemy URL query option. Example: ODBC Driver 18 for SQL Server"
}
}
},
"description": "List of SQLAlchemy URL Query options to provide. Example: driver, TrustServerCertificate, etc."
},
"sqlalchemy_url_query": {
"type": [
"string",
"null"
],
"description": "SQLAlchemy URL. Setting this will take precedence over other connection settings.",
"secret": true,
"writeOnly": true
},
"default_replication_method": {
"type": [
"string",
"null"
],
"default": "FULL_TABLE",
"description": "Replication method to use if there is not a catalog entry to override this choice. One of `FULL_TABLE`, `INCREMENTAL`, or `LOG_BASED`.",
"enum": [
"FULL_TABLE",
"INCREMENTAL",
"LOG_BASED"
]
},
"stream_maps": {
"type": [
"object",
"null"
],
"properties": {},
"title": "Stream Maps",
"description": "Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html)."
},
"stream_map_config": {
"type": [
"object",
"null"
],
"properties": {},
"title": "User Stream Map Configuration",
"description": "User-defined config values to be used within map expressions."
},
"faker_config": {
"type": [
"object",
"null"
],
"properties": {
"seed": {
"oneOf": [
{
"type": [
"number"
]
},
{
"type": [
"string"
]
},
{
"type": [
"boolean"
]
},
{
"type": "null"
}
],
"title": "Faker Seed",
"description": "Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator"
},
"locale": {
"oneOf": [
{
"type": [
"string"
]
},
{
"type": "array",
"items": {
"type": [
"string"
]
}
},
{
"type": "null"
}
],
"title": "Faker Locale",
"description": "One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization"
}
},
"title": "Faker Configuration",
"description": "Config for the [`Faker`](https://faker.readthedocs.io/en/master/) instance variable `fake` used within map expressions. Only applicable if the plugin specifies `faker` as an addtional dependency (through the `singer-sdk` `faker` extra or directly)."
},
"flattening_enabled": {
"type": [
"boolean",
"null"
],
"title": "Enable Schema Flattening",
"description": "'True' to enable schema flattening and automatically expand nested properties."
},
"flattening_max_depth": {
"type": [
"integer",
"null"
],
"title": "Max Flattening Depth",
"description": "The max depth to flatten schemas."
},
"batch_config": {
"type": [
"object",
"null"
],
"properties": {
"encoding": {
"type": [
"object",
"null"
],
"properties": {
"format": {
"type": [
"string",
"null"
],
"title": "Batch Encoding Format",
"description": "Format to use for batch files.",
"enum": [
"jsonl",
"parquet"
]
},
"compression": {
"type": [
"string",
"null"
],
"title": "Batch Compression Format",
"description": "Compression format to use for batch files.",
"enum": [
"gzip",
"none"
]
}
},
"title": "Batch Encoding Configuration",
"description": "Specifies the format and compression of the batch files."
},
"storage": {
"type": [
"object",
"null"
],
"properties": {
"root": {
"type": [
"string",
"null"
],
"title": "Batch Storage Root",
"description": "Root path to use when writing batch files."
},
"prefix": {
"type": [
"string",
"null"
],
"title": "Batch Storage Prefix",
"description": "Prefix to use when writing batch files."
}
},
"title": "Batch Storage Configuration",
"description": "Defines the storage layer to use when writing batch files"
}
},
"title": "Batch Configuration",
"description": "Configuration for BATCH message capabilities."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}
}
edgarrmondragon
temporarily deployed
to
preview
January 3, 2025 16:16 — with
GitHub Actions
Inactive
edgarrmondragon
temporarily deployed
to
preview
January 3, 2025 16:19 — with
GitHub Actions
Inactive
edgarrmondragon
temporarily deployed
to
preview
January 3, 2025 16:20 — with
GitHub Actions
Inactive
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
cc @SpaceCondor