The target-apprise loader sends data into Apprise after it was pulled from a source using an extractor
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the target-apprise loader to your
project using
:meltano add -
Configure the target-apprise
settings using
:meltano config
meltano add loader target-apprisemeltano config target-apprise set --interactiveNext steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
target-apprise
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this loader. If you find they are out of date, please
consider updating them by making a pull request to the YAML file that defines the
capabilities for this loader.
This plugin has the following capabilities:
- about
- schema-flattening
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
target-apprise settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
You can also list these settings using
with the meltano configlist
subcommand:
meltano config target-apprise list
You can
override these settings or specify additional ones
in your meltano.yml by adding the settings key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
Batch Size Rows (batch_size_rows)
-
Environment variable:
TARGET_APPRISE_BATCH_SIZE_ROWS
Maximum number of rows in each batch.
Configure this setting directly using the following Meltano command:
meltano config target-apprise set batch_size_rows [value]Uri Replacement (uri_replacement)
-
Environment variable:
TARGET_APPRISE_URI_REPLACEMENT -
Default Value:
false
If enabled, allows for uris to be dynamically configured. Any fields in the record that have a name beginning with _sdc_replace_, will have their value substituted in for a matching string in the URI. See an example here.
Configure this setting directly using the following Meltano command:
meltano config target-apprise set uri_replacement [value]Uris (uris)
-
Environment variable:
TARGET_APPRISE_URIS
Array of apprise URIs,checkout https://github.com/caronc/apprise
Configure this setting directly using the following Meltano command:
meltano config target-apprise set uris [value]Expand To Show SDK Settings
Add Record Metadata (add_record_metadata)
-
Environment variable:
TARGET_APPRISE_ADD_RECORD_METADATA
Add metadata to records.
Configure this setting directly using the following Meltano command:
meltano config target-apprise set add_record_metadata [value]Faker Config Locale (faker_config.locale)
-
Environment variable:
TARGET_APPRISE_FAKER_CONFIG_LOCALE
One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization
Configure this setting directly using the following Meltano command:
meltano config target-apprise set faker_config locale [value]Faker Config Seed (faker_config.seed)
-
Environment variable:
TARGET_APPRISE_FAKER_CONFIG_SEED
Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator
Configure this setting directly using the following Meltano command:
meltano config target-apprise set faker_config seed [value]Flattening Enabled (flattening_enabled)
-
Environment variable:
TARGET_APPRISE_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config target-apprise set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TARGET_APPRISE_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config target-apprise set flattening_max_depth [value]Load Method (load_method)
-
Environment variable:
TARGET_APPRISE_LOAD_METHOD -
Default Value:
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.
Configure this setting directly using the following Meltano command:
meltano config target-apprise set load_method [value]Stream Map Config (stream_map_config)
-
Environment variable:
TARGET_APPRISE_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config target-apprise set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TARGET_APPRISE_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Configure this setting directly using the following Meltano command:
meltano config target-apprise set stream_maps [value]Validate Records (validate_records)
-
Environment variable:
TARGET_APPRISE_VALIDATE_RECORDS -
Default Value:
true
Whether to validate the schema of the incoming streams.
Configure this setting directly using the following Meltano command:
meltano config target-apprise set validate_records [value]Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general-brightgreen){kind=icon}
-6-c0c0c4){kind=icon}
-2-c0c0c4){kind=icon}
&color=grey)
