-
Notifications
You must be signed in to change notification settings - Fork 68
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: [Hub Bot] Refresh metadata 2024-12-23 #1914
Conversation
✅ Deploy Preview for meltano-hub ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Testing plugin
Version info
Usage info
Detected capabilities
JSON Metadata{
"name": "tap-github",
"description": "GitHub tap class.",
"version": "1.4.2",
"sdk_version": "0.42.1",
"supported_python_versions": [
"3.8",
"3.9",
"3.10",
"3.11",
"3.12",
"3.13"
],
"capabilities": [
"catalog",
"state",
"discover",
"about",
"stream-maps",
"schema-flattening",
"batch"
],
"settings": {
"type": "object",
"properties": {
"user_agent": {
"type": [
"string",
"null"
]
},
"metrics_log_level": {
"type": [
"string",
"null"
]
},
"auth_token": {
"type": [
"string",
"null"
],
"description": "GitHub token to authenticate with."
},
"additional_auth_tokens": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string"
]
},
"description": "List of GitHub tokens to authenticate with. Streams will loop through them when hitting rate limits."
},
"auth_app_keys": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string"
]
},
"description": "List of GitHub App credentials to authenticate with. Each credential can be constructed by combining an App ID and App private key into the format `:app_id:;;-----BEGIN RSA PRIVATE KEY-----\n_YOUR_P_KEY_\n-----END RSA PRIVATE KEY-----`."
},
"rate_limit_buffer": {
"type": [
"integer",
"null"
],
"description": "Add a buffer to avoid consuming all query points for the token at hand. Defaults to 1000."
},
"expiry_time_buffer": {
"type": [
"integer",
"null"
],
"description": [
"When authenticating as a GitHub App, this buffer controls how many minutes before expiry the GitHub app tokens will be refreshed. Defaults to 10 minutes."
]
},
"searches": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"name": {
"type": [
"string"
]
},
"query": {
"type": [
"string"
]
}
},
"required": [
"name",
"query"
]
}
},
"organizations": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string"
]
}
},
"repositories": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string"
]
}
},
"user_usernames": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string"
]
}
},
"user_ids": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string"
]
}
},
"start_date": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"stream_maps": {
"type": [
"object",
"null"
],
"properties": {}
},
"stream_map_config": {
"type": [
"object",
"null"
],
"properties": {}
},
"skip_parent_streams": {
"type": [
"boolean",
"null"
],
"description": "Set to true to skip API calls for the parent streams (such as repositories) if it is not selected but children are"
},
"stream_options": {
"type": [
"object",
"null"
],
"properties": {
"milestones": {
"type": [
"object",
"null"
],
"properties": {
"state": {
"type": [
"string",
"null"
],
"default": "open",
"description": "Configures which states are of interest. Must be one of [open, closed, all], defaults to open.",
"enum": [
"open",
"closed",
"all"
]
}
},
"additionalProperties": false,
"description": "Options specific to the 'milestones' stream."
}
},
"additionalProperties": false,
"description": "Options which change the behaviour of a specific stream."
},
"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."
}
}
}
} Discovered streams
|
Testing plugin
Version info
Usage info
Detected 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 |
---|---|---|---|
api_key | False | None | The token to authenticate against the API service |
access_token | False | None | The token to authenticate against the API service |
start_date | False | None | The earliest record date to sync |
api_url | False | https://www.faire.com/api/v1/ | The url for the API service |
stream_maps | False | None | Config object for stream maps capability. |
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-faire --about
Version info
tap-faire v0.0.1, Meltano SDK v0.5.0)
Usage info
melty-bot % tap-faire --help
Usage: tap-faire [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-faire",
"description": "faire tap class.",
"version": "0.0.1",
"sdk_version": "0.5.0",
"capabilities": [
"catalog",
"state",
"discover",
"about",
"stream-maps",
"schema-flattening"
],
"settings": {
"type": "object",
"properties": {
"api_key": {
"type": [
"string",
"null"
],
"description": "The token to authenticate against the API service"
},
"access_token": {
"type": [
"string",
"null"
],
"description": "The token to authenticate against the API service"
},
"start_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The earliest record date to sync"
},
"api_url": {
"type": [
"string",
"null"
],
"default": "https://www.faire.com/api/v1/",
"description": "The url for the API service"
},
"stream_maps": {
"type": [
"object",
"null"
],
"properties": {},
"description": "Config object for stream maps capability."
},
"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."
}
}
}
}
Discovered streams
orders
products
retailers
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
campaigns
lists
lists_members
reports_email_activity
reports_sent_to
reports_unsubscribes
Testing plugin
Auto-generated README.md
|
Setting | Required | Default | Description |
---|---|---|---|
host | False | None | Hostname for redshift instance. |
port | False | 5432 | The port on which redshift is awaiting connection. |
enable_iam_authentication | False | None | If true, use temporary credentials (https://docs.aws.amazon.com/redshift/latest/mgmt/generating-iam-credentials-cli-api.html). |
cluster_identifier | False | None | Redshift cluster identifier. Note if sqlalchemy_url is set or enable_iam_authentication is false this will be ignored. |
user | False | None | User name used to authenticate. Note if sqlalchemy_url is set this will be ignored. |
password | False | None | Password used to authenticate. Note if sqlalchemy_url is set this will be ignored. |
dbname | False | None | Database name. Note if sqlalchemy_url is set this will be ignored. |
aws_redshift_copy_role_arn | True | None | Redshift copy role arn to use for the COPY command from s3 |
s3_bucket | True | None | S3 bucket to save staging files before using COPY command |
s3_region | False | None | AWS region for S3 bucket. If not specified, region will be detected by boto config resolution. See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html |
s3_key_prefix | False | S3 key prefix to save staging files before using COPY command | |
remove_s3_files | False | 0 | If you want to remove staging files in S3 |
temp_dir | False | temp | Where you want to store your temp data files. |
default_target_schema | False | None | Redshift schema to send data to, example: tap-clickup |
activate_version | False | 0 | 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 | 0 | 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. |
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_mode | False | verify-full | SSL Protection method, see [redshift documentation](https://docs.aws.amazon.com/redshift/latest/mgmt/connecting-ssl-support.html for more information. Must be one of disable, allow, prefer, require, verify-ca, or verify-full. |
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-redshift --about
Version info
target-redshift v0.1.0, Meltano SDK v0.43.1
Usage info
melty-bot % target-redshift --help
Usage: target-redshift [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-redshift",
"description": "Target for Redshift.",
"version": "0.1.0",
"sdk_version": "0.43.1",
"supported_python_versions": [
"3.9",
"3.10",
"3.11",
"3.12"
],
"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 redshift instance."
},
"port": {
"type": [
"string",
"null"
],
"default": "5432",
"description": "The port on which redshift is awaiting connection."
},
"enable_iam_authentication": {
"type": [
"boolean",
"null"
],
"title": "Enable IAM Authentication",
"description": "If true, use temporary credentials (https://docs.aws.amazon.com/redshift/latest/mgmt/generating-iam-credentials-cli-api.html)."
},
"cluster_identifier": {
"type": [
"string",
"null"
],
"description": "Redshift cluster identifier. Note if sqlalchemy_url is set or enable_iam_authentication is false this will be ignored."
},
"user": {
"type": [
"string",
"null"
],
"description": "User name used to authenticate. Note if sqlalchemy_url is set this will be ignored."
},
"password": {
"type": [
"string",
"null"
],
"description": "Password used to authenticate. Note if sqlalchemy_url is set this will be ignored."
},
"dbname": {
"type": [
"string",
"null"
],
"title": "Database Name",
"description": "Database name. Note if sqlalchemy_url is set this will be ignored."
},
"aws_redshift_copy_role_arn": {
"type": [
"string"
],
"title": "AWS Redshift Copy Role ARN",
"description": "Redshift copy role arn to use for the COPY command from s3",
"secret": true,
"writeOnly": true
},
"s3_bucket": {
"type": [
"string"
],
"description": "S3 bucket to save staging files before using COPY command"
},
"s3_region": {
"type": [
"string",
"null"
],
"description": "AWS region for S3 bucket. If not specified, region will be detected by boto config resolution. See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html"
},
"s3_key_prefix": {
"type": [
"string",
"null"
],
"default": "",
"description": "S3 key prefix to save staging files before using COPY command"
},
"remove_s3_files": {
"type": [
"boolean",
"null"
],
"default": false,
"description": "If you want to remove staging files in S3"
},
"temp_dir": {
"type": [
"string",
"null"
],
"default": "temp",
"description": "Where you want to store your temp data files."
},
"default_target_schema": {
"type": [
"string",
"null"
],
"description": "Redshift schema to send data to, example: tap-clickup"
},
"activate_version": {
"type": [
"boolean",
"null"
],
"default": false,
"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": false,
"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."
},
"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_mode": {
"type": [
"string",
"null"
],
"default": "verify-full",
"description": "SSL Protection method, see [redshift documentation](https://docs.aws.amazon.com/redshift/latest/mgmt/connecting-ssl-support.html for more information. Must be one of disable, allow, prefer, require, verify-ca, or verify-full."
},
"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": [
"aws_redshift_copy_role_arn",
"s3_bucket"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}
}
Updates Plugin Definitions