Datasets:
dataunitylab
/
json-schema-descriptions

Dataset card Data Studio Files
xet
 Community
1
schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
meltano.schema.json
collector_endpoints
Array of Snowplow collector endpoints.
{"type": "array", "items": {"type": "string"}, "default": ["https://sp.meltano.com"]}
meltano.schema.json
items
A URL to which Snowplow events will be sent if telemetry is enabled.
{"type": "string"}
meltano.schema.json
annotations
Arbitrary annotations keyed by tool/vendor name - not processed by the core Meltano library or CLI
{"type": "object", "propertyNames": {"type": "string"}, "additionalProperties": {"type": "object"}}
meltano.schema.json
name
The name of the plugin.
{"type": "string", "examples": ["target-jsonl"]}
meltano.schema.json
description
A description of the plugin.
{"type": "string"}
meltano.schema.json
plugin_type
The type of the plugin.
{"type": "string", "enum": ["extractors", "loaders", "orchestrators", "transformers", "files", "utilities", "transforms", "mappers"]}
meltano.schema.json
repo
The URL of the repository containing the source code for the plugin.
{"type": "string"}
meltano.schema.json
ext_repo
The URL of the repository containing the source code for a Meltano extension plugin that typically wraps some other tool, in which case the 'repo' property is used for the URL of the repository for that tool.
{"type": "string"}
meltano.schema.json
inherit_from
An existing plugin to inherit from.
{"type": "string"}
meltano.schema.json
pip_url
The pip hosted package name or URL
{"type": "string", "examples": ["target-jsonl", "git+https://gitlab.com/meltano/tap-facebook.git", "wtforms==2.2.1 apache-airflow==1.10.2"]}
meltano.schema.json
variant
The variant of the plugin.
{"type": "string"}
meltano.schema.json
namespace
The namespace of this plugin
{"type": "string", "examples": ["tap_csv", "target_jsonl"]}
meltano.schema.json
config
Your plugin configuration, type 'meltano config <plugin> list' for details
{"type": "object"}
meltano.schema.json
label
A user friendly label describing the plugin
{"type": "string", "examples": ["Stripe", "Facebook Ads"]}
meltano.schema.json
logo_url
An optional logo URL for this plugin
{"type": "string"}
meltano.schema.json
python
The python version to use for this plugin, specified as a path, or as the name of an executable to find within a directory in $PATH. If not specified, the top-level `python` setting will be used, or if it is not set, the python executable that was used to run Meltano will be used (within a separate virtual environment).
{"type": "string", "examples": ["/usr/bin/python3.10", "python", "python3.11"]}
meltano.schema.json
executable
The plugin's executable name, as defined in setup.py (if a Python based plugin)
{"type": "string", "examples": ["tap-stripe", "tap-covid-19"]}
meltano.schema.json
docs
A URL to the documentation for this plugin
{"type": "string"}
meltano.schema.json
items
A set consisting of one valid combination of required setting names
{"type": "array", "items": {"type": "string"}}
meltano.schema.json
commands
A mapping of command names to either a string command, or an object containing info about the command.
{"type": "object", "additionalProperties": {"oneOf": [{"type": "object", "required": ["args"], "properties": {"annotations": {}, "args": {"type": "string"}, "executable": {"type": "string"}, "container_spec": {"type": "object", "required": ["image"], "properties": {"annotations": {}, "image": {"type": "string", "examples": ["ghcr.io/dbt-labs/dbt-postgres:latest"]}, "command": {"type": "string", "examples": ["list", "test", "compile"]}, "entrypoint": {"type": "string"}, "ports": {"type": "object", "propertyNames": {"type": "string"}, "additionalProperties": {"type": "string"}, "examples": [{"5000": "5000"}]}, "volumes": {"type": "array", "items": {"type": "string", "examples": ["$MELTANO_PROJECT_ROOT/transform/:/usr/app/"]}}, "env": {"type": "object", "propertyNames": {"type": "string"}, "additionalProperties": {"type": "string"}, "examples": [{"DBT_PROFILES_DIR": "/usr/app/profile/"}]}}}}}, {"type": "string"}]}}
meltano.schema.json
args
Command arguments
{"type": "string"}
meltano.schema.json
description
Documentation displayed when listing commands
{"type": "string"}
meltano.schema.json
executable
Override the plugin's executable for this command
{"type": "string"}
meltano.schema.json
container_spec
Container specification for this command
{"type": "object", "required": ["image"], "properties": {"annotations": {}, "image": {"type": "string", "examples": ["ghcr.io/dbt-labs/dbt-postgres:latest"]}, "command": {"type": "string", "examples": ["list", "test", "compile"]}, "entrypoint": {"type": "string"}, "ports": {"type": "object", "propertyNames": {"type": "string"}, "additionalProperties": {"type": "string"}, "examples": [{"5000": "5000"}]}, "volumes": {"type": "array", "items": {"type": "string", "examples": ["$MELTANO_PROJECT_ROOT/transform/:/usr/app/"]}}, "env": {"type": "object", "propertyNames": {"type": "string"}, "additionalProperties": {"type": "string"}, "examples": [{"DBT_PROFILES_DIR": "/usr/app/profile/"}]}}}
meltano.schema.json
image
Container image
{"type": "string", "examples": ["ghcr.io/dbt-labs/dbt-postgres:latest"]}
meltano.schema.json
command
Container command
{"type": "string", "examples": ["list", "test", "compile"]}
meltano.schema.json
entrypoint
Container entrypoint
{"type": "string"}
meltano.schema.json
ports
Mapping of host to container ports
{"type": "object", "propertyNames": {"type": "string"}, "additionalProperties": {"type": "string"}, "examples": [{"5000": "5000"}]}
meltano.schema.json
volumes
Array of volumes to mount during container execution
{"type": "array", "items": {"type": "string", "examples": ["$MELTANO_PROJECT_ROOT/transform/:/usr/app/"]}}
meltano.schema.json
env
Mapping to environment variable to set inside the container. These take precedence over Meltano own runtime environment variables.
{"type": "object", "propertyNames": {"type": "string"}, "additionalProperties": {"type": "string"}, "examples": [{"DBT_PROFILES_DIR": "/usr/app/profile/"}]}
meltano.schema.json
additionalProperties
The command as a string.
{"type": "string"}
meltano.schema.json
catalog
A path to a catalog file (relative to the project directory) to be provided to the extractor when it is run in sync mode.
{"type": "string"}
meltano.schema.json
load_schema
The name of the database schema extracted data should be loaded into.
{"type": "string"}
meltano.schema.json
metadata
An object containing Singer stream and property metadata
{"type": "object", "default": {}}
meltano.schema.json
schema
An object representing override rules for a Singer stream schema
{"type": "object", "default": {}}
meltano.schema.json
state
A path to a state file (relative to the project directory) to be provided to the extractor when it is run as part of a pipeline using meltano elt.
{"type": "string"}
meltano.schema.json
select
An array of entity selection rules in the form '<entity|*>.<attribute|*>'
{"type": "array", "default": ["*.*"], "items": {"type": "string"}}
meltano.schema.json
select_filter
An array of entity selection filter rules that are applied to the extractor's discovered or provided catalog file when the extractor is run.
{"type": "array", "items": {"type": "string"}, "default": []}
meltano.schema.json
extractors
https://docs.meltano.com/concepts/plugins#extractors
{"type": "object", "allOf": [{}, {}, {"type": "object", "properties": {"capabilities": {"type": "array", "items": {"type": "string", "enum": ["properties", "catalog", "discover", "state", "about", "stream-maps", "activate-version", "batch", "test", "log-based", "schema-flattening"]}}}}], "unevaluatedProperties": false}
meltano.schema.json
loaders
https://docs.meltano.com/concepts/plugins#loaders
{"type": "object", "allOf": [{}, {"properties": {"capabilities": {"type": "array", "items": {"type": "string", "enum": ["about", "stream-maps", "activate-version", "batch", "soft-delete", "hard-delete", "datatype-failsafe", "record-flattening"]}}, "dialect": {"type": "string"}, "target_schema": {"type": "string"}}}], "unevaluatedProperties": false}
meltano.schema.json
dialect
The name of the dialect of the target database, so that transformers in the same pipeline and Meltano UI's Analysis feature can determine the type of database to connect to.
{"type": "string"}
meltano.schema.json
target_schema
The name of the database schema the loader has been configured to load data into (assuming the destination supports schemas), so that transformers in the same pipeline can determine the database schema to load data from.
{"type": "string"}
meltano.schema.json
orchestrators
https://docs.meltano.com/concepts/plugins#orchestrators
{"type": "object", "unevaluatedProperties": false}
meltano.schema.json
transformers
https://docs.meltano.com/concepts/plugins#transforms
{"type": "object", "unevaluatedProperties": false}
meltano.schema.json
files
https://docs.meltano.com/concepts/plugins#file-bundles
{"type": "object", "unevaluatedProperties": false}
meltano.schema.json
utilities
https://docs.meltano.com/concepts/plugins#utilities
{"type": "object", "unevaluatedProperties": false}
meltano.schema.json
transforms
https://docs.meltano.com/concepts/plugins#transforms
{"type": "object", "allOf": [{}, {"properties": {"annotations": {}, "vars": {"type": "object"}, "package_name": {"type": "string"}}}], "unevaluatedProperties": false}
meltano.schema.json
vars
An object containing dbt model variables
{"type": "object"}
meltano.schema.json
package_name
The name of the dbt package's internal dbt project: the value of name in dbt_project.yml.
{"type": "string"}
meltano.schema.json
mappings
Name of the invokable mappings and their associated configs.
{"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"annotations": {}, "name": {"type": "string"}, "config": {"type": "object"}}}, "required": ["config", "name"]}
meltano.schema.json
mappers
https://docs.meltano.com/concepts/plugins#mappers
{"type": "object", "allOf": [{}, {}], "unevaluatedProperties": false}
meltano.schema.json
name
The name of the setting
{"type": "string", "examples": ["account_id"]}
meltano.schema.json
aliases
Alternative setting names that can be used in 'meltano.yml' and 'meltano config set'
{"type": "array", "examples": ["accountId", "account_identifier"], "items": {"type": "string"}}
meltano.schema.json
label
A user friendly label for the setting
{"type": "string", "examples": ["Account ID"]}
meltano.schema.json
value
The default value of this setting if not otherwise defined
{}
meltano.schema.json
placeholder
A placeholder value for this setting
{"type": "string", "examples": ["Ex. 18161"]}
meltano.schema.json
kind
The type of value this setting contains
{"type": "string", "enum": ["oauth", "hidden", "password", "date_iso8601", "file", "email", "integer", "options", "object", "array", "boolean", "string"]}
meltano.schema.json
description
A description for what this setting does
{"type": "string", "examples": ["The unique account identifier for your Stripe Account"]}
meltano.schema.json
tooltip
A phrase to provide additional information on this setting
{"type": "string", "examples": ["Here is some additional info..."]}
meltano.schema.json
documentation
A link to documentation on this setting
{"type": "string", "examples": ["https://meltano.com/"]}
meltano.schema.json
protected
A protected setting cannot be changed from the UI
{"type": "boolean", "default": false}
meltano.schema.json
env
An alternative environment variable name to populate with this settings value in the plugin environment.
{"type": "string", "examples": ["GITLAB_API_TOKEN", "FACEBOOK_ADS_ACCESS_TOKEN"]}
meltano.schema.json
value_processor
Use with `kind: object` to pre-process the keys in a particular way.
{"enum": ["nest_object", "upcase_string"]}
meltano.schema.json
value_post_processor
Use with `kind: object` to post-process the keys in a particular way.
{"enum": ["stringify"]}
meltano.schema.json
provider
The name of a Meltano-supported OAuth provider
{"type": "string", "examples": ["google-adwords"]}
meltano.schema.json
label
A user friendly label for the option
{"type": "string", "examples": ["Account ID"]}
meltano.schema.json
value
The value of this option
{}
meltano.schema.json
schedules
https://docs.meltano.com/guide/orchestration
{"type": "object", "oneOf": [{"required": ["name", "job", "interval"]}, {"required": ["name", "extractor", "loader", "transform", "interval", "start_date"]}], "additionalProperties": false, "properties": {"annotations": {}, "name": {"type": "string", "examples": ["gitlab-to-jsonl"]}, "job": {"type": "string", "examples": ["some-custom-job"]}, "extractor": {"type": "string", "examples": ["tap-gitlab"]}, "env": {}, "loader": {"type": "string", "examples": ["target-jsonl"]}, "interval": {"type": "string", "examples": ["@hourly", "@daily", "@weekly", "0 0 * * *"], "pattern": "^((@(hourly|daily|weekly|monthly|yearly|once))|((((\\d+,)+\\d+|(\\d+(\\/|-)\\d+)|\\d+|\\*) ?){5,6}))$"}, "transform": {"type": "string", "default": "skip", "enum": ["run", "skip", "only"]}, "start_date": {"type": "string", "examples": ["2020-08-06 00:00:00"]}}}
meltano.schema.json
name
The schedule's unique name
{"type": "string", "examples": ["gitlab-to-jsonl"]}
meltano.schema.json
job
The name of a meltano job
{"type": "string", "examples": ["some-custom-job"]}
meltano.schema.json
extractor
The name of the extractor plugin
{"type": "string", "examples": ["tap-gitlab"]}
meltano.schema.json
loader
The name of the loader plugin
{"type": "string", "examples": ["target-jsonl"]}
meltano.schema.json
interval
A UNIX cron expression to represent the frequency the scheduled job should execute
{"type": "string", "examples": ["@hourly", "@daily", "@weekly", "0 0 * * *"], "pattern": "^((@(hourly|daily|weekly|monthly|yearly|once))|((((\\d+,)+\\d+|(\\d+(\\/|-)\\d+)|\\d+|\\*) ?){5,6}))$"}
meltano.schema.json
transform
Describes if transforms should run, be skipped, or if only transforms should execute (skip extractors and loaders)
{"type": "string", "default": "skip", "enum": ["run", "skip", "only"]}
meltano.schema.json
start_date
The date when the schedule should first execute
{"type": "string", "examples": ["2020-08-06 00:00:00"]}
meltano.schema.json
jobs
https://docs.meltano.com/reference/command-line-interface#job
{"type": "object", "required": ["name", "tasks"], "additionalProperties": false, "properties": {"annotations": {}, "name": {"type": "string", "examples": ["gitlab-to-jsonl"]}, "tasks": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}}]}}}
meltano.schema.json
name
This jobs unique name
{"type": "string", "examples": ["gitlab-to-jsonl"]}
meltano.schema.json
name
The name of the environment.
{"type": "string"}
meltano.schema.json
config
An object of environment specific configurations.
{"type": "object", "additionalProperties": false, "properties": {"plugins": {"type": "object", "properties": {"extractors": {"type": "array", "items": {"allOf": [{}, {}], "unevaluatedProperties": false}}, "loaders": {"type": "array", "items": {"unevaluatedProperties": false}}, "orchestrators": {"type": "array", "items": {"unevaluatedProperties": false}}, "transformers": {"type": "array", "items": {"unevaluatedProperties": false}}, "files": {"type": "array", "items": {"unevaluatedProperties": false}}, "utilities": {"type": "array", "items": {"unevaluatedProperties": false}}, "transforms": {"type": "array", "items": {"unevaluatedProperties": false}}}}}}
meltano.schema.json
plugins
An object of environment specific plugin configurations.
{"type": "object", "properties": {"extractors": {"type": "array", "items": {"allOf": [{}, {}], "unevaluatedProperties": false}}, "loaders": {"type": "array", "items": {"unevaluatedProperties": false}}, "orchestrators": {"type": "array", "items": {"unevaluatedProperties": false}}, "transformers": {"type": "array", "items": {"unevaluatedProperties": false}}, "files": {"type": "array", "items": {"unevaluatedProperties": false}}, "utilities": {"type": "array", "items": {"unevaluatedProperties": false}}, "transforms": {"type": "array", "items": {"unevaluatedProperties": false}}}}
meltano.schema.json
requires
A set of plugin requirements.
{"type": "object", "additionalProperties": false, "patternProperties": {"^(extractors|loaders|transforms|orchestrators|transformers|files|utilities|mappers)$": {"type": "array", "items": {}}}}
meltano.schema.json
plugin_requirement
A single plugin requirement
{"type": "object", "additionalProperties": false, "properties": {"annotations": {}, "name": {"type": "string"}, "variant": {"type": "string"}}}
meltano.schema.json
name
The name of the required plugin
{"type": "string"}
meltano.schema.json
variant
The variant of the required plugin
{"type": "string"}
meltano.schema.json
env
Mapping of environment variables for use in config.
{"type": "object", "propertyNames": {"type": "string"}, "additionalProperties": {"type": "string"}, "examples": [{"SNOWFLAKE_ACCOUNT": "my.snowflake.account.com"}]}
cloudformation.schema.json
Description
Template description
{"maxLength": 1024, "type": "string"}
component.json
private
A boolean specifying whether the component is private, defaulting to false.
{"type": "boolean", "default": false}
component.json
name
A public component MUST have a 'name'. This is what will be passed to require().
{"type": "string", "pattern": "^[0-9a-z-_]+$"}
component.json
repo
The public component MUST have a 'repository' property, this is registry end-point consisting of <username>/<project> , for example 'visionmedia/page.js' or 'component/dialog'.
{"type": "string"}
component.json
description
The component SHOULD have a 'description' property. This helps people find and understand your component.
{"type": "string"}
component.json
version
The public component MUST include a version, allowing other scripts to depend on specific releases of the component.
{"type": "string"}
component.json
keywords
Keywords are used when searching for a component. A public component SHOULD list a few keywords.
{"type": "array", "minItems": 1, "items": {"type": "string"}}
component.json
main
It is recommended that you use 'index.js' for the main component file, however if you use another filename, you MUST define a 'main' field for that.
{"type": "string"}
component.json
scripts
The scripts field explicitly specifies the scripts for this component. For public components, these must be regular JavaScript files. For private components, these should be regular Javascript files.
{"type": "array", "minItems": 1, "items": {"type": "string"}}
component.json
styles
The styles field explicitly specifies the stylesheets for this component. For public components, these must be regular CSS files. For private components, these should be regular CSS files.
{"type": "array", "minItems": 1, "items": {"type": "string"}}
component.json
json
The json field explicitly specifies the JSON files for this component. Each file must be valid JSON .
{"type": "array", "minItems": 1, "items": {"type": "string"}}
component.json
images
The images field MUST be supported and fetched upon installation, this allows component build tools to rewrite stylesheet url() s in order to accomodate various file serving techniques.
{"type": "array", "minItems": 1, "items": {"type": "string"}}
component.json
fonts
The fonts field MUST be supported and fetched upon installation, this allows component build tools to rewrite stylesheet url() s in order to accomodate various file serving techniques.
{"type": "array", "minItems": 1, "items": {"type": "string"}}
component.json
files
In the future we will classify more file types, however for those which are not treated uniquely such as fonts may be placed in a files array to aid build and installation tools.
{"type": "array", "minItems": 1, "items": {"type": "string"}}
component.json
dependencies
Runtime dependencies.
{"type": "object", "additionalProperties": {"type": "string"}}