chore: [Hub Bot] Refresh metadata 2024-12-16 #1911
Merged
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
MeltyBot
requested review from
tayloramurphy,
pnadolny13 and
edgarrmondragon
as code owners
✅ 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 |
|---|---|---|---|
| api_key | True | None | The token to authenticate against the API service |
| start_date | False | None | The earliest record date to sync |
| dc | True | None | Your Mailchimp DC |
| 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 is available by running: tap-mailchimp --about
Version info
tap-mailchimp v0.0.1, Meltano SDK v0.24.0
Usage info
melty-bot % tap-mailchimp --help
Usage: tap-mailchimp [OPTIONS]
Execute the Singer tap.
Options:
--state PATH Use a bookmarks file for incremental replication.
--catalog PATH Use a Singer catalog file with the tap.
--test TEXT Use --test to sync a single record for each
stream. Use --test=schema to test schema output
without syncing records.
--discover Run the tap in discovery mode.
--config TEXT Configuration file location or 'ENV' to use
environment variables.
--format [json|markdown] Specify output style for --about
--about Display package metadata and settings.
--version Display the package version.
--help Show this message and exit.
Detected capabilities
- ✅ 'discover'
- ✅ 'catalog'
- ✅ 'state'
- ✅ 'about'
JSON Metadata
{
"name": "tap-mailchimp",
"description": "Mailchimp tap class.",
"version": "0.0.1",
"sdk_version": "0.24.0",
"capabilities": [
"catalog",
"state",
"discover",
"about",
"stream-maps",
"schema-flattening"
],
"settings": {
"type": "object",
"properties": {
"api_key": {
"type": [
"string"
],
"description": "The token to authenticate against the API service",
"secret": true,
"writeOnly": true
},
"start_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The earliest record date to sync"
},
"dc": {
"type": [
"string"
],
"description": "Your Mailchimp DC"
},
"stream_maps": {
"type": [
"object",
"null"
],
"properties": {},
"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": {},
"description": "User-defined config values to be used within map expressions."
},
"flattening_enabled": {
"type": [
"boolean",
"null"
],
"description": "'True' to enable schema flattening and automatically expand nested properties."
},
"flattening_max_depth": {
"type": [
"integer",
"null"
],
"description": "The max depth to flatten schemas."
}
},
"required": [
"api_key",
"dc"
]
}
}Discovered streams
campaignslistslists_membersreports_email_activityreports_sent_toreports_unsubscribes
|
Testing plugin
Auto-generated README.md
|
| Setting | Required | Default | Description |
|---|---|---|---|
| token | True | None | Personal API Token you have generated that can be used to access the CircleCI API |
| org_slug | True | None | Organization slug in the form vcs-slug/org-name. Example: org-slug=gh/CircleCI-Public |
| base_url | False | https://circleci.com/api/v2 | The API base URL to use for requests. Default, https://circleci.com/api/v2. |
| user_agent | False | tap-circle-ci/0.5.0 Singer tap for the CircleCI API. | User-Agent header |
| 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-circle-ci --about
Version info
tap-circle-ci v0.5.0, Meltano SDK v0.43.1
Usage info
melty-bot % tap-circle-ci --help
Usage: tap-circle-ci [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-circle-ci",
"description": "Singer tap for the CircleCI API.",
"version": "0.5.0",
"sdk_version": "0.43.1",
"supported_python_versions": [
"3.9",
"3.10",
"3.11",
"3.12",
"3.13"
],
"capabilities": [
"catalog",
"state",
"discover",
"about",
"stream-maps",
"schema-flattening",
"batch"
],
"settings": {
"type": "object",
"properties": {
"token": {
"type": [
"string"
],
"description": "Personal API Token you have generated that can be used to access the CircleCI API"
},
"org_slug": {
"type": [
"string"
],
"description": "Organization slug in the form vcs-slug/org-name. Example: org-slug=gh/CircleCI-Public"
},
"base_url": {
"type": [
"string",
"null"
],
"default": "https://circleci.com/api/v2",
"description": "The API base URL to use for requests. Default, https://circleci.com/api/v2."
},
"user_agent": {
"type": [
"string",
"null"
],
"default": "tap-circle-ci/0.5.0 Singer tap for the CircleCI API.",
"description": "User-Agent header"
},
"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."
}
},
"required": [
"token",
"org_slug"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}
}Discovered streams
jobspipelinesworkflows
Auto-generated README.md
tap-circle-ci
Singer tap for the CircleCI API.
Built with the Meltano Singer SDK.
Capabilities
catalogstatediscoveraboutstream-mapsschema-flatteningbatch
Supported Python Versions
- 3.9
- 3.10
- 3.11
- 3.12
- 3.13
Settings
| Setting | Required | Default | Description |
|---|---|---|---|
| token | True | None | Personal API Token you have generated that can be used to access the CircleCI API |
| org_slug | True | None | Organization slug in the form vcs-slug/org-name. Example: org-slug=gh/CircleCI-Public |
| base_url | False | https://circleci.com/api/v2 | The API base URL to use for requests. Default, https://circleci.com/api/v2. |
| user_agent | False | tap-circle-ci/0.5.0 Singer tap for the CircleCI API. | User-Agent header |
| 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-circle-ci --about
Version info
tap-circle-ci v0.5.0, Meltano SDK v0.43.1
Usage info
melty-bot % tap-circle-ci --help
Usage: tap-circle-ci [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-circle-ci",
"description": "Singer tap for the CircleCI API.",
"version": "0.5.0",
"sdk_version": "0.43.1",
"supported_python_versions": [
"3.9",
"3.10",
"3.11",
"3.12",
"3.13"
],
"capabilities": [
"catalog",
"state",
"discover",
"about",
"stream-maps",
"schema-flattening",
"batch"
],
"settings": {
"type": "object",
"properties": {
"token": {
"type": [
"string"
],
"description": "Personal API Token you have generated that can be used to access the CircleCI API"
},
"org_slug": {
"type": [
"string"
],
"description": "Organization slug in the form vcs-slug/org-name. Example: org-slug=gh/CircleCI-Public"
},
"base_url": {
"type": [
"string",
"null"
],
"default": "https://circleci.com/api/v2",
"description": "The API base URL to use for requests. Default, https://circleci.com/api/v2."
},
"user_agent": {
"type": [
"string",
"null"
],
"default": "tap-circle-ci/0.5.0 Singer tap for the CircleCI API.",
"description": "User-Agent header"
},
"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."
}
},
"required": [
"token",
"org_slug"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}
}Discovered streams
jobspipelinesworkflows
|
Testing plugin
Auto-generated README.md
|
| Setting | Required | Default | Description |
|---|---|---|---|
| access_token | False | None | Token to authenticate against the API service |
| client_id | False | None | The OAuth app client ID. |
| client_secret | False | None | The OAuth app client secret. |
| refresh_token | False | None | The OAuth app refresh token. |
| start_date | False | None | Earliest record date to sync |
| end_date | False | None | Latest 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. |
| 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-hubspot --about
Version info
tap-hubspot v[could not be detected], Meltano SDK v0.43.1
Usage info
melty-bot % tap-hubspot --help
Usage: tap-hubspot [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-hubspot",
"description": "tap-hubspot is a Singer tap for Hubspot.",
"version": "[could not be detected]",
"sdk_version": "0.43.1",
"supported_python_versions": null,
"capabilities": [
"catalog",
"state",
"discover",
"about",
"stream-maps",
"schema-flattening",
"batch"
],
"settings": {
"type": "object",
"properties": {
"access_token": {
"type": [
"string",
"null"
],
"description": "Token to authenticate against the API service"
},
"client_id": {
"type": [
"string",
"null"
],
"description": "The OAuth app client ID."
},
"client_secret": {
"type": [
"string",
"null"
],
"description": "The OAuth app client secret."
},
"refresh_token": {
"type": [
"string",
"null"
],
"description": "The OAuth app refresh token."
},
"start_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Earliest record date to sync"
},
"end_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Latest record date to sync"
},
"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"
}
}Auto-generated README.md
tap-hubspot
tap-hubspot is a Singer tap for Hubspot.
Built with the Meltano Singer SDK.
Capabilities
catalogstatediscoveraboutstream-mapsschema-flatteningbatch
Settings
| Setting | Required | Default | Description |
|---|---|---|---|
| access_token | False | None | Token to authenticate against the API service |
| client_id | False | None | The OAuth app client ID. |
| client_secret | False | None | The OAuth app client secret. |
| refresh_token | False | None | The OAuth app refresh token. |
| start_date | False | None | Earliest record date to sync |
| end_date | False | None | Latest 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. |
| 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-hubspot --about
Version info
tap-hubspot v[could not be detected], Meltano SDK v0.43.1
Usage info
melty-bot % tap-hubspot --help
Usage: tap-hubspot [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-hubspot",
"description": "tap-hubspot is a Singer tap for Hubspot.",
"version": "[could not be detected]",
"sdk_version": "0.43.1",
"supported_python_versions": null,
"capabilities": [
"catalog",
"state",
"discover",
"about",
"stream-maps",
"schema-flattening",
"batch"
],
"settings": {
"type": "object",
"properties": {
"access_token": {
"type": [
"string",
"null"
],
"description": "Token to authenticate against the API service"
},
"client_id": {
"type": [
"string",
"null"
],
"description": "The OAuth app client ID."
},
"client_secret": {
"type": [
"string",
"null"
],
"description": "The OAuth app client secret."
},
"refresh_token": {
"type": [
"string",
"null"
],
"description": "The OAuth app refresh token."
},
"start_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Earliest record date to sync"
},
"end_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Latest record date to sync"
},
"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"
}
}Auto-generated README.md
tap-hubspot
tap-hubspot is a Singer tap for Hubspot.
Built with the Meltano Singer SDK.
Capabilities
catalogstatediscoveraboutstream-mapsschema-flatteningbatch
Settings
| Setting | Required | Default | Description |
|---|---|---|---|
| access_token | False | None | Token to authenticate against the API service |
| client_id | False | None | The OAuth app client ID. |
| client_secret | False | None | The OAuth app client secret. |
| refresh_token | False | None | The OAuth app refresh token. |
| start_date | False | None | Earliest record date to sync |
| end_date | False | None | Latest 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. |
| 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-hubspot --about
Version info
tap-hubspot v[could not be detected], Meltano SDK v0.43.1
Usage info
melty-bot % tap-hubspot --help
Usage: tap-hubspot [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-hubspot",
"description": "tap-hubspot is a Singer tap for Hubspot.",
"version": "[could not be detected]",
"sdk_version": "0.43.1",
"supported_python_versions": null,
"capabilities": [
"catalog",
"state",
"discover",
"about",
"stream-maps",
"schema-flattening",
"batch"
],
"settings": {
"type": "object",
"properties": {
"access_token": {
"type": [
"string",
"null"
],
"description": "Token to authenticate against the API service"
},
"client_id": {
"type": [
"string",
"null"
],
"description": "The OAuth app client ID."
},
"client_secret": {
"type": [
"string",
"null"
],
"description": "The OAuth app client secret."
},
"refresh_token": {
"type": [
"string",
"null"
],
"description": "The OAuth app refresh token."
},
"start_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Earliest record date to sync"
},
"end_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Latest record date to sync"
},
"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"
}
}
|
Testing plugin
Auto-generated README.md
|
| Setting | Required | Default | Description |
|---|---|---|---|
| api_key | True | None | API key for the dbt Cloud API |
| account_ids | True | None | dbt Cloud account IDs |
| base_url | False | https://cloud.getdbt.com/api/v2 | Base URL for the dbt Cloud API |
| user_agent | False | tap-dbt/0.14.0 Singer tap for the dbt Cloud API. | User-Agent to make requests with |
| page_size | True | 5000 | Page size to use in limit= url parameter |
| 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-dbt --about
Version info
tap-dbt v0.14.0, Meltano SDK v0.43.1
Usage info
melty-bot % tap-dbt --help
Usage: tap-dbt [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-dbt",
"description": "Singer tap for the dbt Cloud API.",
"version": "0.14.0",
"sdk_version": "0.43.1",
"supported_python_versions": [
"3.9",
"3.10",
"3.11",
"3.12",
"3.13"
],
"capabilities": [
"catalog",
"state",
"discover",
"about",
"stream-maps",
"schema-flattening",
"batch"
],
"settings": {
"type": "object",
"properties": {
"api_key": {
"type": [
"string"
],
"description": "API key for the dbt Cloud API"
},
"account_ids": {
"type": "array",
"items": {
"type": [
"string"
]
},
"description": "dbt Cloud account IDs"
},
"base_url": {
"type": [
"string",
"null"
],
"default": "https://cloud.getdbt.com/api/v2",
"description": "Base URL for the dbt Cloud API"
},
"user_agent": {
"type": [
"string",
"null"
],
"default": "tap-dbt/0.14.0 Singer tap for the dbt Cloud API.",
"description": "User-Agent to make requests with"
},
"page_size": {
"type": [
"integer"
],
"default": 5000,
"description": "Page size to use in limit= url parameter"
},
"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."
}
},
"required": [
"api_key",
"account_ids",
"page_size"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}
}Discovered streams
accountsconnectionsenvironmentsjobsprojectsrepositoriesrunsusers
Auto-generated README.md
tap-dbt
Singer tap for the dbt Cloud API.
Built with the Meltano Singer SDK.
Capabilities
catalogstatediscoveraboutstream-mapsschema-flatteningbatch
Supported Python Versions
- 3.9
- 3.10
- 3.11
- 3.12
- 3.13
Settings
| Setting | Required | Default | Description |
|---|---|---|---|
| api_key | True | None | API key for the dbt Cloud API |
| account_ids | True | None | dbt Cloud account IDs |
| base_url | False | https://cloud.getdbt.com/api/v2 | Base URL for the dbt Cloud API |
| user_agent | False | tap-dbt/0.14.0 Singer tap for the dbt Cloud API. | User-Agent to make requests with |
| page_size | True | 5000 | Page size to use in limit= url parameter |
| 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-dbt --about
Version info
tap-dbt v0.14.0, Meltano SDK v0.43.1
Usage info
melty-bot % tap-dbt --help
Usage: tap-dbt [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-dbt",
"description": "Singer tap for the dbt Cloud API.",
"version": "0.14.0",
"sdk_version": "0.43.1",
"supported_python_versions": [
"3.9",
"3.10",
"3.11",
"3.12",
"3.13"
],
"capabilities": [
"catalog",
"state",
"discover",
"about",
"stream-maps",
"schema-flattening",
"batch"
],
"settings": {
"type": "object",
"properties": {
"api_key": {
"type": [
"string"
],
"description": "API key for the dbt Cloud API"
},
"account_ids": {
"type": "array",
"items": {
"type": [
"string"
]
},
"description": "dbt Cloud account IDs"
},
"base_url": {
"type": [
"string",
"null"
],
"default": "https://cloud.getdbt.com/api/v2",
"description": "Base URL for the dbt Cloud API"
},
"user_agent": {
"type": [
"string",
"null"
],
"default": "tap-dbt/0.14.0 Singer tap for the dbt Cloud API.",
"description": "User-Agent to make requests with"
},
"page_size": {
"type": [
"integer"
],
"default": 5000,
"description": "Page size to use in limit= url parameter"
},
"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."
}
},
"required": [
"api_key",
"account_ids",
"page_size"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}
}Discovered streams
accountsconnectionsenvironmentsjobsprojectsrepositoriesrunsusers
|
Testing plugin
Version infoUsage infoDetected capabilities
JSON Metadata{
"name": "tap-mongodb",
"description": "mongodb tap class.",
"version": "2.5.0",
"sdk_version": "0.42.1",
"supported_python_versions": [],
"capabilities": [
"catalog",
"state",
"discover",
"about",
"stream-maps",
"schema-flattening",
"batch"
],
"settings": {
"type": "object",
"properties": {
"database": {
"type": [
"string"
],
"description": "Database name from which records will be extracted."
},
"mongodb_connection_string": {
"type": [
"string",
"null"
],
"description": "MongoDB connection string. See https://www.mongodb.com/docs/manual/reference/connection-string/#connection-string-uri-format for specification.",
"secret": true,
"writeOnly": true
},
"documentdb_credential_json_string": {
"type": [
"string",
"null"
],
"description": "String (serialized JSON object) with keys 'username', 'password', 'engine', 'host', 'port', 'dbClusterIdentifier' or 'dbName', 'ssl'. See example at https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html#reference_secret_json_structure_docdb. The password from this JSON object will be url-encoded by the tap before opening the database connection.",
"secret": true,
"writeOnly": true
},
"documentdb_credential_json_extra_options": {
"type": [
"string",
"null"
],
"description": "String (serialized JSON object) containing string-string key-value pairs which will be added to the connection string options when using documentdb_credential_json_string. For example, when set to the string `{\"tls\":\"true\",\"tlsCAFile\":\"my-ca-bundle.pem\"}`, the options `tls=true&tlsCAFile=my-ca-bundle.pem` will be passed to the MongoClient."
},
"datetime_conversion": {
"type": [
"string",
"null"
],
"default": "datetime",
"description": "Parameter passed to MongoClient 'datetime_conversion' parameter. See documentation at https://pymongo.readthedocs.io/en/stable/examples/datetimes.html#handling-out-of-range-datetimes for details. The default value is 'datetime', which will throw a bson.errors.InvalidBson error if a document contains a date outside the range of datetime.MINYEAR (year 1) to datetime.MAXYEAR (9999). The allowed values correspond to the enumeration members here: https://github.com/mongodb/mongo-python-driver/blob/e23eb7691e6e2905a77fc39a114d000ddf057e47/bson/codec_options.py#L192-L224 (they will be uppercased by the tap).",
"enum": [
"datetime_ms",
"datetime",
"datetime_auto",
"datetime_clamp"
]
},
"prefix": {
"type": [
"string",
"null"
],
"default": "",
"description": "An optional prefix which will be added to each stream name."
},
"filter_collections": {
"type": "array",
"items": {
"type": [
"string"
]
},
"default": [],
"description": "Collections to discover (default: all) - filtering is case-insensitive. Useful for improving catalog discovery performance."
},
"start_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Start date. This is used for incremental replication only. Log based replication does not support this setting - do not provide it unless using the incremental replication method. Defaults to epoch zero time 1970-01-01 if tap uses incremental replication method."
},
"add_record_metadata": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "When True, _sdc metadata fields will be added to records produced by this tap."
},
"allow_modify_change_streams": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "In DocumentDB (unlike MongoDB), change streams must be enabled specifically (see https://docs.aws.amazon.com/documentdb/latest/developerguide/change_streams.html#change_streams-enabling). If attempting to open a change stream against a collection on which change streams have not been enabled, an OperationFailure error will be raised. If this property is set to True, when this error is seen, the tap will execute an admin command to enable change streams and then retry the read operation. Note: this may incur new costs in AWS DocumentDB, and it requires elevated permissions onthe user - the user must have the modifyChangeStreams permission in addition to read permissions."
},
"operation_types": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string"
],
"enum": [
"create",
"createIndexes",
"delete",
"drop",
"dropDatabase",
"dropIndexes",
"insert",
"invalidate",
"modify",
"rename",
"replace",
"shardCollection",
"update"
]
},
"default": [
"create",
"delete",
"insert",
"replace",
"update"
],
"description": "List of MongoDB change stream operation types to include in tap output. The default behavior is to limit to document-level operation types. See full list of operation types athttps://www.mongodb.com/docs/manual/reference/change-events/#operation-types. Note that the list of allowed_values for this property includes some values not available to all MongoDB versions."
},
"stream_maps": {
"type": [
"object",
"null"
],
"properties": {},
"description": "Stream maps. See https://sdk.meltano.com/en/latest/stream_maps.html for documentation."
},
"stream_map_config": {
"type": [
"object",
"null"
],
"properties": {},
"description": "Stream map config. See https://sdk.meltano.com/en/latest/stream_maps.html for documentation."
},
"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."
}
},
"required": [
"database",
"filter_collections"
]
}
}Version infoUsage infoDetected capabilities
JSON Metadata{
"name": "tap-mongodb",
"description": "mongodb tap class.",
"version": "2.5.0",
"sdk_version": "0.42.1",
"supported_python_versions": [],
"capabilities": [
"catalog",
"state",
"discover",
"about",
"stream-maps",
"schema-flattening",
"batch"
],
"settings": {
"type": "object",
"properties": {
"database": {
"type": [
"string"
],
"description": "Database name from which records will be extracted."
},
"mongodb_connection_string": {
"type": [
"string",
"null"
],
"description": "MongoDB connection string. See https://www.mongodb.com/docs/manual/reference/connection-string/#connection-string-uri-format for specification.",
"secret": true,
"writeOnly": true
},
"documentdb_credential_json_string": {
"type": [
"string",
"null"
],
"description": "String (serialized JSON object) with keys 'username', 'password', 'engine', 'host', 'port', 'dbClusterIdentifier' or 'dbName', 'ssl'. See example at https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html#reference_secret_json_structure_docdb. The password from this JSON object will be url-encoded by the tap before opening the database connection.",
"secret": true,
"writeOnly": true
},
"documentdb_credential_json_extra_options": {
"type": [
"string",
"null"
],
"description": "String (serialized JSON object) containing string-string key-value pairs which will be added to the connection string options when using documentdb_credential_json_string. For example, when set to the string `{\"tls\":\"true\",\"tlsCAFile\":\"my-ca-bundle.pem\"}`, the options `tls=true&tlsCAFile=my-ca-bundle.pem` will be passed to the MongoClient."
},
"datetime_conversion": {
"type": [
"string",
"null"
],
"default": "datetime",
"description": "Parameter passed to MongoClient 'datetime_conversion' parameter. See documentation at https://pymongo.readthedocs.io/en/stable/examples/datetimes.html#handling-out-of-range-datetimes for details. The default value is 'datetime', which will throw a bson.errors.InvalidBson error if a document contains a date outside the range of datetime.MINYEAR (year 1) to datetime.MAXYEAR (9999). The allowed values correspond to the enumeration members here: https://github.com/mongodb/mongo-python-driver/blob/e23eb7691e6e2905a77fc39a114d000ddf057e47/bson/codec_options.py#L192-L224 (they will be uppercased by the tap).",
"enum": [
"datetime_ms",
"datetime",
"datetime_auto",
"datetime_clamp"
]
},
"prefix": {
"type": [
"string",
"null"
],
"default": "",
"description": "An optional prefix which will be added to each stream name."
},
"filter_collections": {
"type": "array",
"items": {
"type": [
"string"
]
},
"default": [],
"description": "Collections to discover (default: all) - filtering is case-insensitive. Useful for improving catalog discovery performance."
},
"start_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Start date. This is used for incremental replication only. Log based replication does not support this setting - do not provide it unless using the incremental replication method. Defaults to epoch zero time 1970-01-01 if tap uses incremental replication method."
},
"add_record_metadata": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "When True, _sdc metadata fields will be added to records produced by this tap."
},
"allow_modify_change_streams": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "In DocumentDB (unlike MongoDB), change streams must be enabled specifically (see https://docs.aws.amazon.com/documentdb/latest/developerguide/change_streams.html#change_streams-enabling). If attempting to open a change stream against a collection on which change streams have not been enabled, an OperationFailure error will be raised. If this property is set to True, when this error is seen, the tap will execute an admin command to enable change streams and then retry the read operation. Note: this may incur new costs in AWS DocumentDB, and it requires elevated permissions onthe user - the user must have the modifyChangeStreams permission in addition to read permissions."
},
"operation_types": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string"
],
"enum": [
"create",
"createIndexes",
"delete",
"drop",
"dropDatabase",
"dropIndexes",
"insert",
"invalidate",
"modify",
"rename",
"replace",
"shardCollection",
"update"
]
},
"default": [
"create",
"delete",
"insert",
"replace",
"update"
],
"description": "List of MongoDB change stream operation types to include in tap output. The default behavior is to limit to document-level operation types. See full list of operation types athttps://www.mongodb.com/docs/manual/reference/change-events/#operation-types. Note that the list of allowed_values for this property includes some values not available to all MongoDB versions."
},
"stream_maps": {
"type": [
"object",
"null"
],
"properties": {},
"description": "Stream maps. See https://sdk.meltano.com/en/latest/stream_maps.html for documentation."
},
"stream_map_config": {
"type": [
"object",
"null"
],
"properties": {},
"description": "Stream map config. See https://sdk.meltano.com/en/latest/stream_maps.html for documentation."
},
"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."
}
},
"required": [
"database",
"filter_collections"
]
}
} |
|
Testing plugin
Version infoUsage infoDetected capabilities
JSON Metadata{
"name": "tap-mongodb",
"description": "mongodb tap class.",
"version": "2.5.0",
"sdk_version": "0.42.1",
"supported_python_versions": [],
"capabilities": [
"catalog",
"state",
"discover",
"about",
"stream-maps",
"schema-flattening",
"batch"
],
"settings": {
"type": "object",
"properties": {
"database": {
"type": [
"string"
],
"description": "Database name from which records will be extracted."
},
"mongodb_connection_string": {
"type": [
"string",
"null"
],
"description": "MongoDB connection string. See https://www.mongodb.com/docs/manual/reference/connection-string/#connection-string-uri-format for specification.",
"secret": true,
"writeOnly": true
},
"documentdb_credential_json_string": {
"type": [
"string",
"null"
],
"description": "String (serialized JSON object) with keys 'username', 'password', 'engine', 'host', 'port', 'dbClusterIdentifier' or 'dbName', 'ssl'. See example at https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html#reference_secret_json_structure_docdb. The password from this JSON object will be url-encoded by the tap before opening the database connection.",
"secret": true,
"writeOnly": true
},
"documentdb_credential_json_extra_options": {
"type": [
"string",
"null"
],
"description": "String (serialized JSON object) containing string-string key-value pairs which will be added to the connection string options when using documentdb_credential_json_string. For example, when set to the string `{\"tls\":\"true\",\"tlsCAFile\":\"my-ca-bundle.pem\"}`, the options `tls=true&tlsCAFile=my-ca-bundle.pem` will be passed to the MongoClient."
},
"datetime_conversion": {
"type": [
"string",
"null"
],
"default": "datetime",
"description": "Parameter passed to MongoClient 'datetime_conversion' parameter. See documentation at https://pymongo.readthedocs.io/en/stable/examples/datetimes.html#handling-out-of-range-datetimes for details. The default value is 'datetime', which will throw a bson.errors.InvalidBson error if a document contains a date outside the range of datetime.MINYEAR (year 1) to datetime.MAXYEAR (9999). The allowed values correspond to the enumeration members here: https://github.com/mongodb/mongo-python-driver/blob/e23eb7691e6e2905a77fc39a114d000ddf057e47/bson/codec_options.py#L192-L224 (they will be uppercased by the tap).",
"enum": [
"datetime_ms",
"datetime",
"datetime_auto",
"datetime_clamp"
]
},
"prefix": {
"type": [
"string",
"null"
],
"default": "",
"description": "An optional prefix which will be added to each stream name."
},
"filter_collections": {
"type": "array",
"items": {
"type": [
"string"
]
},
"default": [],
"description": "Collections to discover (default: all) - filtering is case-insensitive. Useful for improving catalog discovery performance."
},
"start_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Start date. This is used for incremental replication only. Log based replication does not support this setting - do not provide it unless using the incremental replication method. Defaults to epoch zero time 1970-01-01 if tap uses incremental replication method."
},
"add_record_metadata": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "When True, _sdc metadata fields will be added to records produced by this tap."
},
"allow_modify_change_streams": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "In DocumentDB (unlike MongoDB), change streams must be enabled specifically (see https://docs.aws.amazon.com/documentdb/latest/developerguide/change_streams.html#change_streams-enabling). If attempting to open a change stream against a collection on which change streams have not been enabled, an OperationFailure error will be raised. If this property is set to True, when this error is seen, the tap will execute an admin command to enable change streams and then retry the read operation. Note: this may incur new costs in AWS DocumentDB, and it requires elevated permissions onthe user - the user must have the modifyChangeStreams permission in addition to read permissions."
},
"operation_types": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string"
],
"enum": [
"create",
"createIndexes",
"delete",
"drop",
"dropDatabase",
"dropIndexes",
"insert",
"invalidate",
"modify",
"rename",
"replace",
"shardCollection",
"update"
]
},
"default": [
"create",
"delete",
"insert",
"replace",
"update"
],
"description": "List of MongoDB change stream operation types to include in tap output. The default behavior is to limit to document-level operation types. See full list of operation types athttps://www.mongodb.com/docs/manual/reference/change-events/#operation-types. Note that the list of allowed_values for this property includes some values not available to all MongoDB versions."
},
"stream_maps": {
"type": [
"object",
"null"
],
"properties": {},
"description": "Stream maps. See https://sdk.meltano.com/en/latest/stream_maps.html for documentation."
},
"stream_map_config": {
"type": [
"object",
"null"
],
"properties": {},
"description": "Stream map config. See https://sdk.meltano.com/en/latest/stream_maps.html for documentation."
},
"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."
}
},
"required": [
"database",
"filter_collections"
]
}
}Version infoUsage infoDetected capabilities
JSON Metadata{
"name": "tap-mongodb",
"description": "mongodb tap class.",
"version": "2.5.0",
"sdk_version": "0.42.1",
"supported_python_versions": [],
"capabilities": [
"catalog",
"state",
"discover",
"about",
"stream-maps",
"schema-flattening",
"batch"
],
"settings": {
"type": "object",
"properties": {
"database": {
"type": [
"string"
],
"description": "Database name from which records will be extracted."
},
"mongodb_connection_string": {
"type": [
"string",
"null"
],
"description": "MongoDB connection string. See https://www.mongodb.com/docs/manual/reference/connection-string/#connection-string-uri-format for specification.",
"secret": true,
"writeOnly": true
},
"documentdb_credential_json_string": {
"type": [
"string",
"null"
],
"description": "String (serialized JSON object) with keys 'username', 'password', 'engine', 'host', 'port', 'dbClusterIdentifier' or 'dbName', 'ssl'. See example at https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html#reference_secret_json_structure_docdb. The password from this JSON object will be url-encoded by the tap before opening the database connection.",
"secret": true,
"writeOnly": true
},
"documentdb_credential_json_extra_options": {
"type": [
"string",
"null"
],
"description": "String (serialized JSON object) containing string-string key-value pairs which will be added to the connection string options when using documentdb_credential_json_string. For example, when set to the string `{\"tls\":\"true\",\"tlsCAFile\":\"my-ca-bundle.pem\"}`, the options `tls=true&tlsCAFile=my-ca-bundle.pem` will be passed to the MongoClient."
},
"datetime_conversion": {
"type": [
"string",
"null"
],
"default": "datetime",
"description": "Parameter passed to MongoClient 'datetime_conversion' parameter. See documentation at https://pymongo.readthedocs.io/en/stable/examples/datetimes.html#handling-out-of-range-datetimes for details. The default value is 'datetime', which will throw a bson.errors.InvalidBson error if a document contains a date outside the range of datetime.MINYEAR (year 1) to datetime.MAXYEAR (9999). The allowed values correspond to the enumeration members here: https://github.com/mongodb/mongo-python-driver/blob/e23eb7691e6e2905a77fc39a114d000ddf057e47/bson/codec_options.py#L192-L224 (they will be uppercased by the tap).",
"enum": [
"datetime_ms",
"datetime",
"datetime_auto",
"datetime_clamp"
]
},
"prefix": {
"type": [
"string",
"null"
],
"default": "",
"description": "An optional prefix which will be added to each stream name."
},
"filter_collections": {
"type": "array",
"items": {
"type": [
"string"
]
},
"default": [],
"description": "Collections to discover (default: all) - filtering is case-insensitive. Useful for improving catalog discovery performance."
},
"start_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Start date. This is used for incremental replication only. Log based replication does not support this setting - do not provide it unless using the incremental replication method. Defaults to epoch zero time 1970-01-01 if tap uses incremental replication method."
},
"add_record_metadata": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "When True, _sdc metadata fields will be added to records produced by this tap."
},
"allow_modify_change_streams": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "In DocumentDB (unlike MongoDB), change streams must be enabled specifically (see https://docs.aws.amazon.com/documentdb/latest/developerguide/change_streams.html#change_streams-enabling). If attempting to open a change stream against a collection on which change streams have not been enabled, an OperationFailure error will be raised. If this property is set to True, when this error is seen, the tap will execute an admin command to enable change streams and then retry the read operation. Note: this may incur new costs in AWS DocumentDB, and it requires elevated permissions onthe user - the user must have the modifyChangeStreams permission in addition to read permissions."
},
"operation_types": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string"
],
"enum": [
"create",
"createIndexes",
"delete",
"drop",
"dropDatabase",
"dropIndexes",
"insert",
"invalidate",
"modify",
"rename",
"replace",
"shardCollection",
"update"
]
},
"default": [
"create",
"delete",
"insert",
"replace",
"update"
],
"description": "List of MongoDB change stream operation types to include in tap output. The default behavior is to limit to document-level operation types. See full list of operation types athttps://www.mongodb.com/docs/manual/reference/change-events/#operation-types. Note that the list of allowed_values for this property includes some values not available to all MongoDB versions."
},
"stream_maps": {
"type": [
"object",
"null"
],
"properties": {},
"description": "Stream maps. See https://sdk.meltano.com/en/latest/stream_maps.html for documentation."
},
"stream_map_config": {
"type": [
"object",
"null"
],
"properties": {},
"description": "Stream map config. See https://sdk.meltano.com/en/latest/stream_maps.html for documentation."
},
"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."
}
},
"required": [
"database",
"filter_collections"
]
}
} |
|
Testing plugin
Version infoUsage infoDetected capabilities
JSON Metadata{
"name": "tap-totango",
"description": "totango tap class.",
"version": "0.5.0",
"sdk_version": "0.27.0",
"capabilities": [
"catalog",
"state",
"discover",
"about",
"stream-maps",
"schema-flattening"
],
"settings": {
"type": "object",
"properties": {
"api_url": {
"type": [
"string"
],
"default": "https://api.totango.com",
"description": "The url for the API services. https://api.totango.com is for US services, whereas https://api-eu1.totango.com is for EU services.",
"enum": [
"https://api.totango.com",
"https://api-eu1.totango.com "
]
},
"auth_token": {
"type": [
"string"
],
"description": "The token to authenticate against the API service",
"secret": true,
"writeOnly": true
},
"events_terms": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": [
"string"
]
}
},
"required": [
"type"
],
"additionalProperties": true
},
"default": [],
"description": "An array containing filter conditions to use for the events stream search.",
"examples": [
[
{
"type": "event_property",
"name": "event_type",
"eq": "note"
}
],
[
{
"type": "or",
"or": [
{
"type": "event_property",
"name": "event_type",
"eq": "note"
},
{
"type": "event_property",
"name": "event_type",
"eq": "campaign_touch"
}
]
}
],
[
{
"type": "date",
"term": "date",
"joker": "yesterday"
},
{
"type": "or",
"or": [
{
"type": "event_property",
"name": "event_type",
"eq": "note"
},
{
"type": "event_property",
"name": "event_type",
"eq": "campaign_touch"
}
]
}
],
[
{
"type": "date",
"term": "date",
"gte": 1587859200000
},
{
"type": "event_property",
"name": "event_type",
"eq": "note"
}
]
]
},
"events_count": {
"type": [
"integer"
],
"default": 1000,
"description": "The maximum number of accounts to return in the events result set. The max. value for count is 1000."
},
"events_offset": {
"type": [
"integer"
],
"default": 0,
"description": "Page number (0 is the 1st-page)."
},
"account_id": {
"type": [
"string",
"null"
],
"description": "Filter the events stream results for a specific account."
},
"accounts_terms": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": [
"string"
]
}
},
"required": [
"type"
],
"additionalProperties": true
},
"default": [],
"description": "An array containing filter conditions to use for the accounts stream search.",
"examples": [
[
{
"type": "string",
"term": "status_group",
"in_list": [
"paying"
]
}
]
]
},
"accounts_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": [
"string"
]
}
},
"required": [
"type"
],
"additionalProperties": true
},
"default": [],
"description": "List of fields to return as results. Note that the account name and account-id are always returned as well.",
"examples": [
[
{
"type": "string",
"term": "health",
"field_display_name": "Health rank "
},
{
"type": "health_trend",
"field_display_name": "Health last change "
},
{
"type": "string_attribute",
"attribute": "Success Manager",
"field_display_name": "Success Manager"
}
]
]
},
"accounts_count": {
"type": [
"integer",
"null"
],
"default": 100,
"description": "The maximum number of accounts to return in the accounts result set. The max. value for count is 1000."
},
"accounts_offset": {
"type": [
"integer",
"null"
],
"default": 0,
"description": "Record number (0 states \"start at record 0\"). The record size can be defined using the count parameter (and limited to 1000). Tip: To page through results, ask for 1000 records (count: 1000). If you receive 1000 records, assume there\u2019s more, in which case you want to pull the next 1000 records (offset: 1000\u2026then 2000\u2026etc.). Repeat paging until the number of records returned is less than 1000."
},
"accounts_sort_by": {
"type": [
"string",
"null"
],
"default": "display_name",
"description": "Field name to sort the accounts stream results set by."
},
"accounts_sort_order": {
"type": [
"string",
"null"
],
"enum": [
"ASC",
"DESC"
],
"default": "ASC",
"description": "Order to sort the accounts stream results set by."
},
"users_terms": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": [
"string"
]
}
},
"required": [
"type"
],
"additionalProperties": true
},
"default": [],
"description": "An array containing filter conditions to use for the users stream search.",
"examples": [
[
{
"type": "parent_account",
"terms": [
{
"type": "string",
"term": "status_group",
"in_list": [
"paying"
]
}
]
}
]
]
},
"users_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": [
"string"
]
}
},
"required": [
"type"
],
"additionalProperties": true
},
"default": [],
"description": "List of fields to return as results. Note that the user name and id along with account name and account-id are always returned as well.",
"examples": [
[
{
"type": "date",
"term": "last_activity_time",
"field_display_name": "Last activity",
"desc": true
},
{
"type": "named_aggregation",
"aggregation": "total_activities",
"duration": 14,
"field_display_name": "Activities (14d)"
}
]
]
},
"users_count": {
"type": [
"integer",
"null"
],
"default": 1000,
"description": "The maximum number of users to return in the users result set. The max. value for count is 1000."
},
"users_offset": {
"type": [
"integer",
"null"
],
"default": 0,
"description": "Record number (0 states \"start at record 0\"). The record size can be defined using the count parameter (and limited to 1000). Tip: To page through results, ask for 1000 records (count: 1000). If you receive 1000 records, assume there\u2019s more, in which case you want to pull the next 1000 records (offset: 1000\u2026then 2000\u2026etc.). Repeat paging until the number of records returned is less than 1000."
},
"users_sort_by": {
"type": [
"string",
"null"
],
"default": "display_name",
"description": "Field name to sort the users stream results set by."
},
"users_sort_order": {
"type": [
"string",
"null"
],
"enum": [
"ASC",
"DESC"
],
"default": "ASC",
"description": "Order to sort the users stream results set by."
},
"stream_maps": {
"type": [
"object",
"null"
],
"properties": {},
"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": {},
"description": "User-defined config values to be used within map expressions."
},
"flattening_enabled": {
"type": [
"boolean",
"null"
],
"description": "'True' to enable schema flattening and automatically expand nested properties."
},
"flattening_max_depth": {
"type": [
"integer",
"null"
],
"description": "The max depth to flatten schemas."
}
},
"required": [
"api_url",
"auth_token",
"events_terms",
"events_count",
"events_offset",
"accounts_terms",
"accounts_fields",
"users_terms",
"users_fields"
]
}
}Discovered streams
Version infoUsage infoDetected capabilities
JSON Metadata{
"name": "tap-totango",
"description": "totango tap class.",
"version": "0.5.0",
"sdk_version": "0.27.0",
"capabilities": [
"catalog",
"state",
"discover",
"about",
"stream-maps",
"schema-flattening"
],
"settings": {
"type": "object",
"properties": {
"api_url": {
"type": [
"string"
],
"default": "https://api.totango.com",
"description": "The url for the API services. https://api.totango.com is for US services, whereas https://api-eu1.totango.com is for EU services.",
"enum": [
"https://api.totango.com",
"https://api-eu1.totango.com "
]
},
"auth_token": {
"type": [
"string"
],
"description": "The token to authenticate against the API service",
"secret": true,
"writeOnly": true
},
"events_terms": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": [
"string"
]
}
},
"required": [
"type"
],
"additionalProperties": true
},
"default": [],
"description": "An array containing filter conditions to use for the events stream search.",
"examples": [
[
{
"type": "event_property",
"name": "event_type",
"eq": "note"
}
],
[
{
"type": "or",
"or": [
{
"type": "event_property",
"name": "event_type",
"eq": "note"
},
{
"type": "event_property",
"name": "event_type",
"eq": "campaign_touch"
}
]
}
],
[
{
"type": "date",
"term": "date",
"joker": "yesterday"
},
{
"type": "or",
"or": [
{
"type": "event_property",
"name": "event_type",
"eq": "note"
},
{
"type": "event_property",
"name": "event_type",
"eq": "campaign_touch"
}
]
}
],
[
{
"type": "date",
"term": "date",
"gte": 1587859200000
},
{
"type": "event_property",
"name": "event_type",
"eq": "note"
}
]
]
},
"events_count": {
"type": [
"integer"
],
"default": 1000,
"description": "The maximum number of accounts to return in the events result set. The max. value for count is 1000."
},
"events_offset": {
"type": [
"integer"
],
"default": 0,
"description": "Page number (0 is the 1st-page)."
},
"account_id": {
"type": [
"string",
"null"
],
"description": "Filter the events stream results for a specific account."
},
"accounts_terms": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": [
"string"
]
}
},
"required": [
"type"
],
"additionalProperties": true
},
"default": [],
"description": "An array containing filter conditions to use for the accounts stream search.",
"examples": [
[
{
"type": "string",
"term": "status_group",
"in_list": [
"paying"
]
}
]
]
},
"accounts_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": [
"string"
]
}
},
"required": [
"type"
],
"additionalProperties": true
},
"default": [],
"description": "List of fields to return as results. Note that the account name and account-id are always returned as well.",
"examples": [
[
{
"type": "string",
"term": "health",
"field_display_name": "Health rank "
},
{
"type": "health_trend",
"field_display_name": "Health last change "
},
{
"type": "string_attribute",
"attribute": "Success Manager",
"field_display_name": "Success Manager"
}
]
]
},
"accounts_count": {
"type": [
"integer",
"null"
],
"default": 100,
"description": "The maximum number of accounts to return in the accounts result set. The max. value for count is 1000."
},
"accounts_offset": {
"type": [
"integer",
"null"
],
"default": 0,
"description": "Record number (0 states \"start at record 0\"). The record size can be defined using the count parameter (and limited to 1000). Tip: To page through results, ask for 1000 records (count: 1000). If you receive 1000 records, assume there\u2019s more, in which case you want to pull the next 1000 records (offset: 1000\u2026then 2000\u2026etc.). Repeat paging until the number of records returned is less than 1000."
},
"accounts_sort_by": {
"type": [
"string",
"null"
],
"default": "display_name",
"description": "Field name to sort the accounts stream results set by."
},
"accounts_sort_order": {
"type": [
"string",
"null"
],
"enum": [
"ASC",
"DESC"
],
"default": "ASC",
"description": "Order to sort the accounts stream results set by."
},
"users_terms": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": [
"string"
]
}
},
"required": [
"type"
],
"additionalProperties": true
},
"default": [],
"description": "An array containing filter conditions to use for the users stream search.",
"examples": [
[
{
"type": "parent_account",
"terms": [
{
"type": "string",
"term": "status_group",
"in_list": [
"paying"
]
}
]
}
]
]
},
"users_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": [
"string"
]
}
},
"required": [
"type"
],
"additionalProperties": true
},
"default": [],
"description": "List of fields to return as results. Note that the user name and id along with account name and account-id are always returned as well.",
"examples": [
[
{
"type": "date",
"term": "last_activity_time",
"field_display_name": "Last activity",
"desc": true
},
{
"type": "named_aggregation",
"aggregation": "total_activities",
"duration": 14,
"field_display_name": "Activities (14d)"
}
]
]
},
"users_count": {
"type": [
"integer",
"null"
],
"default": 1000,
"description": "The maximum number of users to return in the users result set. The max. value for count is 1000."
},
"users_offset": {
"type": [
"integer",
"null"
],
"default": 0,
"description": "Record number (0 states \"start at record 0\"). The record size can be defined using the count parameter (and limited to 1000). Tip: To page through results, ask for 1000 records (count: 1000). If you receive 1000 records, assume there\u2019s more, in which case you want to pull the next 1000 records (offset: 1000\u2026then 2000\u2026etc.). Repeat paging until the number of records returned is less than 1000."
},
"users_sort_by": {
"type": [
"string",
"null"
],
"default": "display_name",
"description": "Field name to sort the users stream results set by."
},
"users_sort_order": {
"type": [
"string",
"null"
],
"enum": [
"ASC",
"DESC"
],
"default": "ASC",
"description": "Order to sort the users stream results set by."
},
"stream_maps": {
"type": [
"object",
"null"
],
"properties": {},
"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": {},
"description": "User-defined config values to be used within map expressions."
},
"flattening_enabled": {
"type": [
"boolean",
"null"
],
"description": "'True' to enable schema flattening and automatically expand nested properties."
},
"flattening_max_depth": {
"type": [
"integer",
"null"
],
"description": "The max depth to flatten schemas."
}
},
"required": [
"api_url",
"auth_token",
"events_terms",
"events_count",
"events_offset",
"accounts_terms",
"accounts_fields",
"users_terms",
"users_fields"
]
}
}Discovered streams
|
|
Testing plugin
Auto-generated README.md
|
| Setting | Required | Default | Description |
|---|---|---|---|
| host | False | None | Hostname for postgres instance. |
| port | False | 5432 | The port on which postgres is awaiting connections. |
| user | False | None | User name used to authenticate. |
| password | False | None | Password used to authenticate. |
| database | False | None | Database name. |
| use_copy | False | 0 | Use the COPY command to insert data. This is usually faster than INSERT statements. This option is only available for the postgresql+psycopg dialect+driver. |
| sqlalchemy_url | False | None | DEPRECATED. SQLAlchemy connection string. This will override using host, user, password, port, dialect, and all ssl settings. Note that you must escape password special characters properly. See https://docs.sqlalchemy.org/en/20/core/engines.html#escaping-special-characters-such-as-signs-in-passwords |
| dialect+driver | False | postgresql+psycopg | DEPRECATED. Dialect+driver see https://docs.sqlalchemy.org/en/20/core/engines.html. Generally just leave this alone. |
| default_target_schema | False | melty | Postgres schema to send data to, example: tap-clickup |
| activate_version | False | 1 | If set to false, the tap will ignore activate version messages. If set to true, add_record_metadata must be set to true as well. |
| hard_delete | False | 0 | When activate version is sent from a tap this specefies if we should delete the records that don't match, or mark them with a date in the _sdc_deleted_at column. This config option is ignored if activate_version is set to false. |
| add_record_metadata | False | 1 | Note that this must be enabled for activate_version to work!This adds _sdc_extracted_at, _sdc_batched_at, and more to every table. See https://sdk.meltano.com/en/latest/implementation/record_metadata.html for more information. |
| interpret_content_encoding | False | 0 | If set to true, the target will interpret the content encoding of the schema to determine how to store the data. Using this option may result in a more efficient storage of the data but may also result in an error if the data is not encoded as expected. |
| sanitize_null_text_characters | False | 0 | If set to true, the target will sanitize null characters in char/text/varchar fields, as they are not supported by Postgres. See postgres documentation for more information about chr(0) not being supported. |
| ssl_enable | False | 0 | Whether or not to use ssl to verify the server's identity. Use ssl_certificate_authority and ssl_mode for further customization. To use a client certificate to authenticate yourself to the server, use ssl_client_certificate_enable instead. |
| ssl_client_certificate_enable | False | 0 | Whether or not to provide client-side certificates as a method of authentication to the server. Use ssl_client_certificate and ssl_client_private_key for further customization. To use SSL to verify the server's identity, use ssl_enable instead. |
| ssl_mode | False | verify-full | SSL Protection method, see postgres documentation for more information. Must be one of disable, allow, prefer, require, verify-ca, or verify-full. |
| ssl_certificate_authority | False | ~/.postgresql/root.crl | The certificate authority that should be used to verify the server's identity. Can be provided either as the certificate itself (in .env) or as a filepath to the certificate. |
| ssl_client_certificate | False | ~/.postgresql/postgresql.crt | The certificate that should be used to verify your identity to the server. Can be provided either as the certificate itself (in .env) or as a filepath to the certificate. |
| ssl_client_private_key | False | ~/.postgresql/postgresql.key | The private key for the certificate you provided. Can be provided either as the certificate itself (in .env) or as a filepath to the certificate. |
| ssl_storage_directory | False | .secrets | The folder in which to store SSL certificates provided as raw values. When a certificate/key is provided as a raw value instead of as a filepath, it must be written to a file before it can be used. This configuration option determines where that file is created. |
| ssh_tunnel | False | None | SSH Tunnel Configuration, this is a json object |
| ssh_tunnel.enable | False | 0 | Enable an ssh tunnel (also known as bastion host), see the other ssh_tunnel.* properties for more details |
| ssh_tunnel.host | False | None | Host of the bastion host, this is the host we'll connect to via ssh |
| ssh_tunnel.username | False | None | Username to connect to bastion host |
| ssh_tunnel.port | False | 22 | Port to connect to bastion host |
| ssh_tunnel.private_key | False | None | Private Key for authentication to the bastion host |
| ssh_tunnel.private_key_password | False | None | Private Key Password, leave None if no password is set |
| load_method | False | append-only | The method to use when loading data into the destination. append-only will always write all input records whether that records already exists or not. upsert will update existing records and insert new records. overwrite will delete all existing records and insert all input records. |
| batch_size_rows | False | None | Maximum number of rows in each batch. |
| process_activate_version_messages | False | 1 | Whether to process ACTIVATE_VERSION messages. |
| validate_records | False | 1 | Whether to validate the schema of the incoming streams. |
| 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. |
A full list of supported settings and capabilities is available by running: target-postgres --about
Version info
target-postgres v0.2.0, Meltano SDK v0.43.1
Usage info
melty-bot % target-postgres --help
Usage: target-postgres [OPTIONS]
Execute the Singer target.
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.
--input FILENAME A path to read messages from instead of from
standard in.
--help Show this message and exit.
Detected capabilities
- ❌ 'discover'
- ❌ 'catalog'
- ❌ 'properties'
- ❌ 'state'
- ✅ 'about'
JSON Metadata
{
"name": "target-postgres",
"description": "Target for Postgres.",
"version": "0.2.0",
"sdk_version": "0.43.1",
"supported_python_versions": [
"3.9",
"3.10",
"3.11",
"3.12",
"3.13"
],
"capabilities": [
"about",
"stream-maps",
"schema-flattening",
"validate-records",
"activate-version",
"target-schema",
"hard-delete"
],
"settings": {
"type": "object",
"properties": {
"host": {
"type": [
"string",
"null"
],
"description": "Hostname for postgres instance."
},
"port": {
"type": [
"integer",
"null"
],
"default": 5432,
"description": "The port on which postgres is awaiting connections."
},
"user": {
"type": [
"string",
"null"
],
"description": "User name used to authenticate."
},
"password": {
"type": [
"string",
"null"
],
"description": "Password used to authenticate."
},
"database": {
"type": [
"string",
"null"
],
"description": "Database name."
},
"use_copy": {
"type": [
"boolean",
"null"
],
"title": "Use COPY",
"default": false,
"description": "Use the COPY command to insert data. This is usually faster than INSERT statements. This option is only available for the postgresql+psycopg dialect+driver."
},
"sqlalchemy_url": {
"type": [
"string",
"null"
],
"description": "DEPRECATED. SQLAlchemy connection string. This will override using host, user, password, port, dialect, and all ssl settings. Note that you must escape password special characters properly. See https://docs.sqlalchemy.org/en/20/core/engines.html#escaping-special-characters-such-as-signs-in-passwords"
},
"dialect+driver": {
"type": [
"string",
"null"
],
"default": "postgresql+psycopg",
"description": "DEPRECATED. Dialect+driver see https://docs.sqlalchemy.org/en/20/core/engines.html. Generally just leave this alone."
},
"default_target_schema": {
"type": [
"string",
"null"
],
"default": "melty",
"description": "Postgres schema to send data to, example: tap-clickup"
},
"activate_version": {
"type": [
"boolean",
"null"
],
"default": true,
"description": "If set to false, the tap will ignore activate version messages. If set to true, add_record_metadata must be set to true as well."
},
"hard_delete": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "When activate version is sent from a tap this specefies if we should delete the records that don't match, or mark them with a date in the `_sdc_deleted_at` column. This config option is ignored if `activate_version` is set to false."
},
"add_record_metadata": {
"type": [
"boolean",
"null"
],
"default": true,
"description": "Note that this must be enabled for activate_version to work!This adds _sdc_extracted_at, _sdc_batched_at, and more to every table. See https://sdk.meltano.com/en/latest/implementation/record_metadata.html for more information."
},
"interpret_content_encoding": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "If set to true, the target will interpret the content encoding of the schema to determine how to store the data. Using this option may result in a more efficient storage of the data but may also result in an error if the data is not encoded as expected."
},
"sanitize_null_text_characters": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "If set to true, the target will sanitize null characters in char/text/varchar fields, as they are not supported by Postgres. See [postgres documentation](https://www.postgresql.org/docs/current/functions-string.html) for more information about chr(0) not being supported."
},
"ssl_enable": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "Whether or not to use ssl to verify the server's identity. Use ssl_certificate_authority and ssl_mode for further customization. To use a client certificate to authenticate yourself to the server, use ssl_client_certificate_enable instead."
},
"ssl_client_certificate_enable": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "Whether or not to provide client-side certificates as a method of authentication to the server. Use ssl_client_certificate and ssl_client_private_key for further customization. To use SSL to verify the server's identity, use ssl_enable instead."
},
"ssl_mode": {
"type": [
"string",
"null"
],
"default": "verify-full",
"description": "SSL Protection method, see [postgres documentation](https://www.postgresql.org/docs/current/libpq-ssl.html#LIBPQ-SSL-PROTECTION) for more information. Must be one of disable, allow, prefer, require, verify-ca, or verify-full."
},
"ssl_certificate_authority": {
"type": [
"string",
"null"
],
"default": "~/.postgresql/root.crl",
"description": "The certificate authority that should be used to verify the server's identity. Can be provided either as the certificate itself (in .env) or as a filepath to the certificate."
},
"ssl_client_certificate": {
"type": [
"string",
"null"
],
"default": "~/.postgresql/postgresql.crt",
"description": "The certificate that should be used to verify your identity to the server. Can be provided either as the certificate itself (in .env) or as a filepath to the certificate."
},
"ssl_client_private_key": {
"type": [
"string",
"null"
],
"default": "~/.postgresql/postgresql.key",
"description": "The private key for the certificate you provided. Can be provided either as the certificate itself (in .env) or as a filepath to the certificate."
},
"ssl_storage_directory": {
"type": [
"string",
"null"
],
"default": ".secrets",
"description": "The folder in which to store SSL certificates provided as raw values. When a certificate/key is provided as a raw value instead of as a filepath, it must be written to a file before it can be used. This configuration option determines where that file is created."
},
"ssh_tunnel": {
"type": [
"object",
"null"
],
"properties": {
"enable": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "Enable an ssh tunnel (also known as bastion host), see the other ssh_tunnel.* properties for more details"
},
"host": {
"type": [
"string",
"null"
],
"description": "Host of the bastion host, this is the host we'll connect to via ssh"
},
"username": {
"type": [
"string",
"null"
],
"description": "Username to connect to bastion host"
},
"port": {
"type": [
"integer",
"null"
],
"default": 22,
"description": "Port to connect to bastion host"
},
"private_key": {
"type": [
"string",
"null"
],
"description": "Private Key for authentication to the bastion host",
"secret": true,
"writeOnly": true
},
"private_key_password": {
"type": [
"string",
"null"
],
"description": "Private Key Password, leave None if no password is set",
"secret": true,
"writeOnly": true
}
},
"description": "SSH Tunnel Configuration, this is a json object"
},
"load_method": {
"type": [
"string",
"null"
],
"default": "append-only",
"description": "The method to use when loading data into the destination. `append-only` will always write all input records whether that records already exists or not. `upsert` will update existing records and insert new records. `overwrite` will delete all existing records and insert all input records.",
"enum": [
"append-only",
"upsert",
"overwrite"
]
},
"batch_size_rows": {
"type": [
"integer",
"null"
],
"title": "Batch Size Rows",
"description": "Maximum number of rows in each batch."
},
"process_activate_version_messages": {
"type": [
"boolean",
"null"
],
"title": "Process `ACTIVATE_VERSION` messages",
"default": true,
"description": "Whether to process `ACTIVATE_VERSION` messages."
},
"validate_records": {
"type": [
"boolean",
"null"
],
"title": "Validate Records",
"default": true,
"description": "Whether to validate the schema of the incoming streams."
},
"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."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}
}Auto-generated README.md
target-postgres
Target for Postgres.
Built with the Meltano Singer SDK.
Capabilities
aboutstream-mapsschema-flatteningvalidate-recordsactivate-versiontarget-schemahard-delete
Supported Python Versions
- 3.9
- 3.10
- 3.11
- 3.12
- 3.13
Settings
| Setting | Required | Default | Description |
|---|---|---|---|
| host | False | None | Hostname for postgres instance. |
| port | False | 5432 | The port on which postgres is awaiting connections. |
| user | False | None | User name used to authenticate. |
| password | False | None | Password used to authenticate. |
| database | False | None | Database name. |
| use_copy | False | 0 | Use the COPY command to insert data. This is usually faster than INSERT statements. This option is only available for the postgresql+psycopg dialect+driver. |
| sqlalchemy_url | False | None | DEPRECATED. SQLAlchemy connection string. This will override using host, user, password, port, dialect, and all ssl settings. Note that you must escape password special characters properly. See https://docs.sqlalchemy.org/en/20/core/engines.html#escaping-special-characters-such-as-signs-in-passwords |
| dialect+driver | False | postgresql+psycopg | DEPRECATED. Dialect+driver see https://docs.sqlalchemy.org/en/20/core/engines.html. Generally just leave this alone. |
| default_target_schema | False | melty | Postgres schema to send data to, example: tap-clickup |
| activate_version | False | 1 | If set to false, the tap will ignore activate version messages. If set to true, add_record_metadata must be set to true as well. |
| hard_delete | False | 0 | When activate version is sent from a tap this specefies if we should delete the records that don't match, or mark them with a date in the _sdc_deleted_at column. This config option is ignored if activate_version is set to false. |
| add_record_metadata | False | 1 | Note that this must be enabled for activate_version to work!This adds _sdc_extracted_at, _sdc_batched_at, and more to every table. See https://sdk.meltano.com/en/latest/implementation/record_metadata.html for more information. |
| interpret_content_encoding | False | 0 | If set to true, the target will interpret the content encoding of the schema to determine how to store the data. Using this option may result in a more efficient storage of the data but may also result in an error if the data is not encoded as expected. |
| sanitize_null_text_characters | False | 0 | If set to true, the target will sanitize null characters in char/text/varchar fields, as they are not supported by Postgres. See postgres documentation for more information about chr(0) not being supported. |
| ssl_enable | False | 0 | Whether or not to use ssl to verify the server's identity. Use ssl_certificate_authority and ssl_mode for further customization. To use a client certificate to authenticate yourself to the server, use ssl_client_certificate_enable instead. |
| ssl_client_certificate_enable | False | 0 | Whether or not to provide client-side certificates as a method of authentication to the server. Use ssl_client_certificate and ssl_client_private_key for further customization. To use SSL to verify the server's identity, use ssl_enable instead. |
| ssl_mode | False | verify-full | SSL Protection method, see postgres documentation for more information. Must be one of disable, allow, prefer, require, verify-ca, or verify-full. |
| ssl_certificate_authority | False | ~/.postgresql/root.crl | The certificate authority that should be used to verify the server's identity. Can be provided either as the certificate itself (in .env) or as a filepath to the certificate. |
| ssl_client_certificate | False | ~/.postgresql/postgresql.crt | The certificate that should be used to verify your identity to the server. Can be provided either as the certificate itself (in .env) or as a filepath to the certificate. |
| ssl_client_private_key | False | ~/.postgresql/postgresql.key | The private key for the certificate you provided. Can be provided either as the certificate itself (in .env) or as a filepath to the certificate. |
| ssl_storage_directory | False | .secrets | The folder in which to store SSL certificates provided as raw values. When a certificate/key is provided as a raw value instead of as a filepath, it must be written to a file before it can be used. This configuration option determines where that file is created. |
| ssh_tunnel | False | None | SSH Tunnel Configuration, this is a json object |
| ssh_tunnel.enable | False | 0 | Enable an ssh tunnel (also known as bastion host), see the other ssh_tunnel.* properties for more details |
| ssh_tunnel.host | False | None | Host of the bastion host, this is the host we'll connect to via ssh |
| ssh_tunnel.username | False | None | Username to connect to bastion host |
| ssh_tunnel.port | False | 22 | Port to connect to bastion host |
| ssh_tunnel.private_key | False | None | Private Key for authentication to the bastion host |
| ssh_tunnel.private_key_password | False | None | Private Key Password, leave None if no password is set |
| load_method | False | append-only | The method to use when loading data into the destination. append-only will always write all input records whether that records already exists or not. upsert will update existing records and insert new records. overwrite will delete all existing records and insert all input records. |
| batch_size_rows | False | None | Maximum number of rows in each batch. |
| process_activate_version_messages | False | 1 | Whether to process ACTIVATE_VERSION messages. |
| validate_records | False | 1 | Whether to validate the schema of the incoming streams. |
| 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. |
A full list of supported settings and capabilities is available by running: target-postgres --about
Version info
target-postgres v0.2.0, Meltano SDK v0.43.1
Usage info
melty-bot % target-postgres --help
Usage: target-postgres [OPTIONS]
Execute the Singer target.
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.
--input FILENAME A path to read messages from instead of from
standard in.
--help Show this message and exit.
Detected capabilities
- ❌ 'discover'
- ❌ 'catalog'
- ❌ 'properties'
- ❌ 'state'
- ✅ 'about'
JSON Metadata
{
"name": "target-postgres",
"description": "Target for Postgres.",
"version": "0.2.0",
"sdk_version": "0.43.1",
"supported_python_versions": [
"3.9",
"3.10",
"3.11",
"3.12",
"3.13"
],
"capabilities": [
"about",
"stream-maps",
"schema-flattening",
"validate-records",
"activate-version",
"target-schema",
"hard-delete"
],
"settings": {
"type": "object",
"properties": {
"host": {
"type": [
"string",
"null"
],
"description": "Hostname for postgres instance."
},
"port": {
"type": [
"integer",
"null"
],
"default": 5432,
"description": "The port on which postgres is awaiting connections."
},
"user": {
"type": [
"string",
"null"
],
"description": "User name used to authenticate."
},
"password": {
"type": [
"string",
"null"
],
"description": "Password used to authenticate."
},
"database": {
"type": [
"string",
"null"
],
"description": "Database name."
},
"use_copy": {
"type": [
"boolean",
"null"
],
"title": "Use COPY",
"default": false,
"description": "Use the COPY command to insert data. This is usually faster than INSERT statements. This option is only available for the postgresql+psycopg dialect+driver."
},
"sqlalchemy_url": {
"type": [
"string",
"null"
],
"description": "DEPRECATED. SQLAlchemy connection string. This will override using host, user, password, port, dialect, and all ssl settings. Note that you must escape password special characters properly. See https://docs.sqlalchemy.org/en/20/core/engines.html#escaping-special-characters-such-as-signs-in-passwords"
},
"dialect+driver": {
"type": [
"string",
"null"
],
"default": "postgresql+psycopg",
"description": "DEPRECATED. Dialect+driver see https://docs.sqlalchemy.org/en/20/core/engines.html. Generally just leave this alone."
},
"default_target_schema": {
"type": [
"string",
"null"
],
"default": "melty",
"description": "Postgres schema to send data to, example: tap-clickup"
},
"activate_version": {
"type": [
"boolean",
"null"
],
"default": true,
"description": "If set to false, the tap will ignore activate version messages. If set to true, add_record_metadata must be set to true as well."
},
"hard_delete": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "When activate version is sent from a tap this specefies if we should delete the records that don't match, or mark them with a date in the `_sdc_deleted_at` column. This config option is ignored if `activate_version` is set to false."
},
"add_record_metadata": {
"type": [
"boolean",
"null"
],
"default": true,
"description": "Note that this must be enabled for activate_version to work!This adds _sdc_extracted_at, _sdc_batched_at, and more to every table. See https://sdk.meltano.com/en/latest/implementation/record_metadata.html for more information."
},
"interpret_content_encoding": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "If set to true, the target will interpret the content encoding of the schema to determine how to store the data. Using this option may result in a more efficient storage of the data but may also result in an error if the data is not encoded as expected."
},
"sanitize_null_text_characters": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "If set to true, the target will sanitize null characters in char/text/varchar fields, as they are not supported by Postgres. See [postgres documentation](https://www.postgresql.org/docs/current/functions-string.html) for more information about chr(0) not being supported."
},
"ssl_enable": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "Whether or not to use ssl to verify the server's identity. Use ssl_certificate_authority and ssl_mode for further customization. To use a client certificate to authenticate yourself to the server, use ssl_client_certificate_enable instead."
},
"ssl_client_certificate_enable": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "Whether or not to provide client-side certificates as a method of authentication to the server. Use ssl_client_certificate and ssl_client_private_key for further customization. To use SSL to verify the server's identity, use ssl_enable instead."
},
"ssl_mode": {
"type": [
"string",
"null"
],
"default": "verify-full",
"description": "SSL Protection method, see [postgres documentation](https://www.postgresql.org/docs/current/libpq-ssl.html#LIBPQ-SSL-PROTECTION) for more information. Must be one of disable, allow, prefer, require, verify-ca, or verify-full."
},
"ssl_certificate_authority": {
"type": [
"string",
"null"
],
"default": "~/.postgresql/root.crl",
"description": "The certificate authority that should be used to verify the server's identity. Can be provided either as the certificate itself (in .env) or as a filepath to the certificate."
},
"ssl_client_certificate": {
"type": [
"string",
"null"
],
"default": "~/.postgresql/postgresql.crt",
"description": "The certificate that should be used to verify your identity to the server. Can be provided either as the certificate itself (in .env) or as a filepath to the certificate."
},
"ssl_client_private_key": {
"type": [
"string",
"null"
],
"default": "~/.postgresql/postgresql.key",
"description": "The private key for the certificate you provided. Can be provided either as the certificate itself (in .env) or as a filepath to the certificate."
},
"ssl_storage_directory": {
"type": [
"string",
"null"
],
"default": ".secrets",
"description": "The folder in which to store SSL certificates provided as raw values. When a certificate/key is provided as a raw value instead of as a filepath, it must be written to a file before it can be used. This configuration option determines where that file is created."
},
"ssh_tunnel": {
"type": [
"object",
"null"
],
"properties": {
"enable": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "Enable an ssh tunnel (also known as bastion host), see the other ssh_tunnel.* properties for more details"
},
"host": {
"type": [
"string",
"null"
],
"description": "Host of the bastion host, this is the host we'll connect to via ssh"
},
"username": {
"type": [
"string",
"null"
],
"description": "Username to connect to bastion host"
},
"port": {
"type": [
"integer",
"null"
],
"default": 22,
"description": "Port to connect to bastion host"
},
"private_key": {
"type": [
"string",
"null"
],
"description": "Private Key for authentication to the bastion host",
"secret": true,
"writeOnly": true
},
"private_key_password": {
"type": [
"string",
"null"
],
"description": "Private Key Password, leave None if no password is set",
"secret": true,
"writeOnly": true
}
},
"description": "SSH Tunnel Configuration, this is a json object"
},
"load_method": {
"type": [
"string",
"null"
],
"default": "append-only",
"description": "The method to use when loading data into the destination. `append-only` will always write all input records whether that records already exists or not. `upsert` will update existing records and insert new records. `overwrite` will delete all existing records and insert all input records.",
"enum": [
"append-only",
"upsert",
"overwrite"
]
},
"batch_size_rows": {
"type": [
"integer",
"null"
],
"title": "Batch Size Rows",
"description": "Maximum number of rows in each batch."
},
"process_activate_version_messages": {
"type": [
"boolean",
"null"
],
"title": "Process `ACTIVATE_VERSION` messages",
"default": true,
"description": "Whether to process `ACTIVATE_VERSION` messages."
},
"validate_records": {
"type": [
"boolean",
"null"
],
"title": "Validate Records",
"default": true,
"description": "Whether to validate the schema of the incoming streams."
},
"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."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}
}
|
Testing plugin
Auto-generated README.md
|
| Setting | Required | Default | Description |
|---|---|---|---|
| user | True | None | The login name for your Snowflake user. |
| password | False | None | The password for your Snowflake user. |
| private_key | False | None | The private key contents. For KeyPair authentication either private_key or private_key_path must be provided. |
| private_key_path | False | None | Path to file containing private key. For KeyPair authentication either private_key or private_key_path must be provided. |
| private_key_passphrase | False | None | Passphrase to decrypt private key if encrypted. |
| account | True | None | Your account identifier. See Account Identifiers. |
| database | True | None | The initial database for the Snowflake session. |
| schema | False | None | The initial schema for the Snowflake session. |
| warehouse | False | None | The initial warehouse for the session. |
| role | False | None | The initial role for the session. |
| add_record_metadata | False | 1 | Whether to add metadata columns. |
| clean_up_batch_files | False | 1 | Whether to remove batch files after processing. |
| use_browser_authentication | False | 0 | Whether to use SSO authentication using an external browser. |
| default_target_schema | False | None | The default target database schema name to use for all streams. |
| hard_delete | False | 0 | Hard delete records. |
| load_method | False | append-only | The method to use when loading data into the destination. append-only will always write all input records whether that records already exists or not. upsert will update existing records and insert new records. overwrite will delete all existing records and insert all input records. |
| batch_size_rows | False | None | Maximum number of rows in each batch. |
| process_activate_version_messages | False | 1 | Whether to process ACTIVATE_VERSION messages. |
| validate_records | False | 1 | Whether to validate the schema of the incoming streams. |
| 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. |
A full list of supported settings and capabilities is available by running: target-snowflake --about
Version info
target-snowflake v0.14.0, Meltano SDK v0.43.1
Usage info
melty-bot % target-snowflake --help
Usage: target-snowflake [OPTIONS]
Execute the Singer target.
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.
--input FILENAME A path to read messages from instead of from
standard in.
--initialize Interactive Snowflake account initialization.
--help Show this message and exit.
Detected capabilities
- ❌ 'discover'
- ❌ 'catalog'
- ❌ 'properties'
- ❌ 'state'
- ✅ 'about'
JSON Metadata
{
"name": "target-snowflake",
"description": "Target for Snowflake.",
"version": "0.14.0",
"sdk_version": "0.43.1",
"supported_python_versions": [
"3.9",
"3.10",
"3.11",
"3.12",
"3.13"
],
"capabilities": [
"about",
"stream-maps",
"schema-flattening",
"validate-records",
"activate-version",
"target-schema",
"hard-delete"
],
"settings": {
"type": "object",
"properties": {
"user": {
"type": [
"string"
],
"description": "The login name for your Snowflake user."
},
"password": {
"type": [
"string",
"null"
],
"description": "The password for your Snowflake user."
},
"private_key": {
"type": [
"string",
"null"
],
"description": "The private key contents. For KeyPair authentication either private_key or private_key_path must be provided.",
"secret": true,
"writeOnly": true
},
"private_key_path": {
"type": [
"string",
"null"
],
"description": "Path to file containing private key. For KeyPair authentication either private_key or private_key_path must be provided."
},
"private_key_passphrase": {
"type": [
"string",
"null"
],
"description": "Passphrase to decrypt private key if encrypted."
},
"account": {
"type": [
"string"
],
"description": "Your account identifier. See [Account Identifiers](https://docs.snowflake.com/en/user-guide/admin-account-identifier.html)."
},
"database": {
"type": [
"string"
],
"description": "The initial database for the Snowflake session."
},
"schema": {
"type": [
"string",
"null"
],
"description": "The initial schema for the Snowflake session."
},
"warehouse": {
"type": [
"string",
"null"
],
"description": "The initial warehouse for the session."
},
"role": {
"type": [
"string",
"null"
],
"description": "The initial role for the session."
},
"add_record_metadata": {
"type": [
"boolean",
"null"
],
"default": true,
"description": "Whether to add metadata columns."
},
"clean_up_batch_files": {
"type": [
"boolean",
"null"
],
"default": true,
"description": "Whether to remove batch files after processing."
},
"use_browser_authentication": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "Whether to use SSO authentication using an external browser."
},
"default_target_schema": {
"type": [
"string",
"null"
],
"title": "Default Target Schema",
"description": "The default target database schema name to use for all streams."
},
"hard_delete": {
"type": [
"boolean",
"null"
],
"title": "Hard Delete",
"default": false,
"description": "Hard delete records."
},
"load_method": {
"type": [
"string",
"null"
],
"default": "append-only",
"description": "The method to use when loading data into the destination. `append-only` will always write all input records whether that records already exists or not. `upsert` will update existing records and insert new records. `overwrite` will delete all existing records and insert all input records.",
"enum": [
"append-only",
"upsert",
"overwrite"
]
},
"batch_size_rows": {
"type": [
"integer",
"null"
],
"title": "Batch Size Rows",
"description": "Maximum number of rows in each batch."
},
"process_activate_version_messages": {
"type": [
"boolean",
"null"
],
"title": "Process `ACTIVATE_VERSION` messages",
"default": true,
"description": "Whether to process `ACTIVATE_VERSION` messages."
},
"validate_records": {
"type": [
"boolean",
"null"
],
"title": "Validate Records",
"default": true,
"description": "Whether to validate the schema of the incoming streams."
},
"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."
}
},
"required": [
"user",
"account",
"database"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}
}Auto-generated README.md
target-snowflake
Target for Snowflake.
Built with the Meltano Singer SDK.
Capabilities
aboutstream-mapsschema-flatteningvalidate-recordsactivate-versiontarget-schemahard-delete
Supported Python Versions
- 3.9
- 3.10
- 3.11
- 3.12
- 3.13
Settings
| Setting | Required | Default | Description |
|---|---|---|---|
| user | True | None | The login name for your Snowflake user. |
| password | False | None | The password for your Snowflake user. |
| private_key | False | None | The private key contents. For KeyPair authentication either private_key or private_key_path must be provided. |
| private_key_path | False | None | Path to file containing private key. For KeyPair authentication either private_key or private_key_path must be provided. |
| private_key_passphrase | False | None | Passphrase to decrypt private key if encrypted. |
| account | True | None | Your account identifier. See Account Identifiers. |
| database | True | None | The initial database for the Snowflake session. |
| schema | False | None | The initial schema for the Snowflake session. |
| warehouse | False | None | The initial warehouse for the session. |
| role | False | None | The initial role for the session. |
| add_record_metadata | False | 1 | Whether to add metadata columns. |
| clean_up_batch_files | False | 1 | Whether to remove batch files after processing. |
| use_browser_authentication | False | 0 | Whether to use SSO authentication using an external browser. |
| default_target_schema | False | None | The default target database schema name to use for all streams. |
| hard_delete | False | 0 | Hard delete records. |
| load_method | False | append-only | The method to use when loading data into the destination. append-only will always write all input records whether that records already exists or not. upsert will update existing records and insert new records. overwrite will delete all existing records and insert all input records. |
| batch_size_rows | False | None | Maximum number of rows in each batch. |
| process_activate_version_messages | False | 1 | Whether to process ACTIVATE_VERSION messages. |
| validate_records | False | 1 | Whether to validate the schema of the incoming streams. |
| 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. |
A full list of supported settings and capabilities is available by running: target-snowflake --about
Version info
target-snowflake v0.14.0, Meltano SDK v0.43.1
Usage info
melty-bot % target-snowflake --help
Usage: target-snowflake [OPTIONS]
Execute the Singer target.
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.
--input FILENAME A path to read messages from instead of from
standard in.
--initialize Interactive Snowflake account initialization.
--help Show this message and exit.
Detected capabilities
- ❌ 'discover'
- ❌ 'catalog'
- ❌ 'properties'
- ❌ 'state'
- ✅ 'about'
JSON Metadata
{
"name": "target-snowflake",
"description": "Target for Snowflake.",
"version": "0.14.0",
"sdk_version": "0.43.1",
"supported_python_versions": [
"3.9",
"3.10",
"3.11",
"3.12",
"3.13"
],
"capabilities": [
"about",
"stream-maps",
"schema-flattening",
"validate-records",
"activate-version",
"target-schema",
"hard-delete"
],
"settings": {
"type": "object",
"properties": {
"user": {
"type": [
"string"
],
"description": "The login name for your Snowflake user."
},
"password": {
"type": [
"string",
"null"
],
"description": "The password for your Snowflake user."
},
"private_key": {
"type": [
"string",
"null"
],
"description": "The private key contents. For KeyPair authentication either private_key or private_key_path must be provided.",
"secret": true,
"writeOnly": true
},
"private_key_path": {
"type": [
"string",
"null"
],
"description": "Path to file containing private key. For KeyPair authentication either private_key or private_key_path must be provided."
},
"private_key_passphrase": {
"type": [
"string",
"null"
],
"description": "Passphrase to decrypt private key if encrypted."
},
"account": {
"type": [
"string"
],
"description": "Your account identifier. See [Account Identifiers](https://docs.snowflake.com/en/user-guide/admin-account-identifier.html)."
},
"database": {
"type": [
"string"
],
"description": "The initial database for the Snowflake session."
},
"schema": {
"type": [
"string",
"null"
],
"description": "The initial schema for the Snowflake session."
},
"warehouse": {
"type": [
"string",
"null"
],
"description": "The initial warehouse for the session."
},
"role": {
"type": [
"string",
"null"
],
"description": "The initial role for the session."
},
"add_record_metadata": {
"type": [
"boolean",
"null"
],
"default": true,
"description": "Whether to add metadata columns."
},
"clean_up_batch_files": {
"type": [
"boolean",
"null"
],
"default": true,
"description": "Whether to remove batch files after processing."
},
"use_browser_authentication": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "Whether to use SSO authentication using an external browser."
},
"default_target_schema": {
"type": [
"string",
"null"
],
"title": "Default Target Schema",
"description": "The default target database schema name to use for all streams."
},
"hard_delete": {
"type": [
"boolean",
"null"
],
"title": "Hard Delete",
"default": false,
"description": "Hard delete records."
},
"load_method": {
"type": [
"string",
"null"
],
"default": "append-only",
"description": "The method to use when loading data into the destination. `append-only` will always write all input records whether that records already exists or not. `upsert` will update existing records and insert new records. `overwrite` will delete all existing records and insert all input records.",
"enum": [
"append-only",
"upsert",
"overwrite"
]
},
"batch_size_rows": {
"type": [
"integer",
"null"
],
"title": "Batch Size Rows",
"description": "Maximum number of rows in each batch."
},
"process_activate_version_messages": {
"type": [
"boolean",
"null"
],
"title": "Process `ACTIVATE_VERSION` messages",
"default": true,
"description": "Whether to process `ACTIVATE_VERSION` messages."
},
"validate_records": {
"type": [
"boolean",
"null"
],
"title": "Validate Records",
"default": true,
"description": "Whether to validate the schema of the incoming streams."
},
"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."
}
},
"required": [
"user",
"account",
"database"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}
}Auto-generated README.md
target-snowflake
Target for Snowflake.
Built with the Meltano Singer SDK.
Capabilities
aboutstream-mapsschema-flatteningvalidate-recordsactivate-versiontarget-schemahard-delete
Supported Python Versions
- 3.9
- 3.10
- 3.11
- 3.12
- 3.13
Settings
| Setting | Required | Default | Description |
|---|---|---|---|
| user | True | None | The login name for your Snowflake user. |
| password | False | None | The password for your Snowflake user. |
| private_key | False | None | The private key contents. For KeyPair authentication either private_key or private_key_path must be provided. |
| private_key_path | False | None | Path to file containing private key. For KeyPair authentication either private_key or private_key_path must be provided. |
| private_key_passphrase | False | None | Passphrase to decrypt private key if encrypted. |
| account | True | None | Your account identifier. See Account Identifiers. |
| database | True | None | The initial database for the Snowflake session. |
| schema | False | None | The initial schema for the Snowflake session. |
| warehouse | False | None | The initial warehouse for the session. |
| role | False | None | The initial role for the session. |
| add_record_metadata | False | 1 | Whether to add metadata columns. |
| clean_up_batch_files | False | 1 | Whether to remove batch files after processing. |
| use_browser_authentication | False | 0 | Whether to use SSO authentication using an external browser. |
| default_target_schema | False | None | The default target database schema name to use for all streams. |
| hard_delete | False | 0 | Hard delete records. |
| load_method | False | append-only | The method to use when loading data into the destination. append-only will always write all input records whether that records already exists or not. upsert will update existing records and insert new records. overwrite will delete all existing records and insert all input records. |
| batch_size_rows | False | None | Maximum number of rows in each batch. |
| process_activate_version_messages | False | 1 | Whether to process ACTIVATE_VERSION messages. |
| validate_records | False | 1 | Whether to validate the schema of the incoming streams. |
| 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. |
A full list of supported settings and capabilities is available by running: target-snowflake --about
Version info
target-snowflake v0.14.0, Meltano SDK v0.43.1
Usage info
melty-bot % target-snowflake --help
Usage: target-snowflake [OPTIONS]
Execute the Singer target.
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.
--input FILENAME A path to read messages from instead of from
standard in.
--initialize Interactive Snowflake account initialization.
--help Show this message and exit.
Detected capabilities
- ❌ 'discover'
- ❌ 'catalog'
- ❌ 'properties'
- ❌ 'state'
- ✅ 'about'
JSON Metadata
{
"name": "target-snowflake",
"description": "Target for Snowflake.",
"version": "0.14.0",
"sdk_version": "0.43.1",
"supported_python_versions": [
"3.9",
"3.10",
"3.11",
"3.12",
"3.13"
],
"capabilities": [
"about",
"stream-maps",
"schema-flattening",
"validate-records",
"activate-version",
"target-schema",
"hard-delete"
],
"settings": {
"type": "object",
"properties": {
"user": {
"type": [
"string"
],
"description": "The login name for your Snowflake user."
},
"password": {
"type": [
"string",
"null"
],
"description": "The password for your Snowflake user."
},
"private_key": {
"type": [
"string",
"null"
],
"description": "The private key contents. For KeyPair authentication either private_key or private_key_path must be provided.",
"secret": true,
"writeOnly": true
},
"private_key_path": {
"type": [
"string",
"null"
],
"description": "Path to file containing private key. For KeyPair authentication either private_key or private_key_path must be provided."
},
"private_key_passphrase": {
"type": [
"string",
"null"
],
"description": "Passphrase to decrypt private key if encrypted."
},
"account": {
"type": [
"string"
],
"description": "Your account identifier. See [Account Identifiers](https://docs.snowflake.com/en/user-guide/admin-account-identifier.html)."
},
"database": {
"type": [
"string"
],
"description": "The initial database for the Snowflake session."
},
"schema": {
"type": [
"string",
"null"
],
"description": "The initial schema for the Snowflake session."
},
"warehouse": {
"type": [
"string",
"null"
],
"description": "The initial warehouse for the session."
},
"role": {
"type": [
"string",
"null"
],
"description": "The initial role for the session."
},
"add_record_metadata": {
"type": [
"boolean",
"null"
],
"default": true,
"description": "Whether to add metadata columns."
},
"clean_up_batch_files": {
"type": [
"boolean",
"null"
],
"default": true,
"description": "Whether to remove batch files after processing."
},
"use_browser_authentication": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "Whether to use SSO authentication using an external browser."
},
"default_target_schema": {
"type": [
"string",
"null"
],
"title": "Default Target Schema",
"description": "The default target database schema name to use for all streams."
},
"hard_delete": {
"type": [
"boolean",
"null"
],
"title": "Hard Delete",
"default": false,
"description": "Hard delete records."
},
"load_method": {
"type": [
"string",
"null"
],
"default": "append-only",
"description": "The method to use when loading data into the destination. `append-only` will always write all input records whether that records already exists or not. `upsert` will update existing records and insert new records. `overwrite` will delete all existing records and insert all input records.",
"enum": [
"append-only",
"upsert",
"overwrite"
]
},
"batch_size_rows": {
"type": [
"integer",
"null"
],
"title": "Batch Size Rows",
"description": "Maximum number of rows in each batch."
},
"process_activate_version_messages": {
"type": [
"boolean",
"null"
],
"title": "Process `ACTIVATE_VERSION` messages",
"default": true,
"description": "Whether to process `ACTIVATE_VERSION` messages."
},
"validate_records": {
"type": [
"boolean",
"null"
],
"title": "Validate Records",
"default": true,
"description": "Whether to validate the schema of the incoming streams."
},
"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."
}
},
"required": [
"user",
"account",
"database"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}
}
edgarrmondragon
requested changes
Dec 16, 2024
edgarrmondragon
temporarily deployed
to
preview
GitHub Actions
Inactive
edgarrmondragon
temporarily deployed
to
preview
GitHub Actions
Inactive
edgarrmondragon
temporarily deployed
to
preview
GitHub Actions
Inactive
edgarrmondragon
temporarily deployed
to
preview
GitHub Actions
Inactive
edgarrmondragon
approved these changes
Dec 16, 2024
edgarrmondragon
deleted the
hub-bot-metadata-2024-12-16-12352275743-111-1
branch
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.
Updates Plugin Definitions