The target-weaviate loader sends data into Weaviate 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-weaviate loader to your
project using
:meltano add -
Configure the target-weaviate
settings using
:meltano config
meltano add target-weaviatemeltano config target-weaviate 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-weaviate
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
- validate-records
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
target-weaviate 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:
batch_sizebatch_size_rowscollection_namecreate_collection_if_missingprimary_keystream_maps.__else__vectorizerweaviate_api_keyweaviate_url
You can also list these settings using
with the meltano configlist
subcommand:
meltano config target-weaviate 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 (batch_size)
-
Environment variable:
TARGET_WEAVIATE_BATCH_SIZE -
Default Value:
100
Maximum number of records to write in one batch.
Configure this setting directly using the following Meltano command:
meltano config target-weaviate set batch_size [value]Batch Size Rows (batch_size_rows)
-
Environment variable:
TARGET_WEAVIATE_BATCH_SIZE_ROWS
Maximum number of rows in each batch.
Configure this setting directly using the following Meltano command:
meltano config target-weaviate set batch_size_rows [value]Collection Name (collection_name)
-
Environment variable:
TARGET_WEAVIATE_COLLECTION_NAME
Weaviate collection name. If not provided, uses the stream name.
Configure this setting directly using the following Meltano command:
meltano config target-weaviate set collection_name [value]Create Collection If Missing (create_collection_if_missing)
-
Environment variable:
TARGET_WEAVIATE_CREATE_COLLECTION_IF_MISSING -
Default Value:
true
Automatically create the collection if it doesn't exist.
Configure this setting directly using the following Meltano command:
meltano config target-weaviate set create_collection_if_missing [value]Primary Key (primary_key)
-
Environment variable:
TARGET_WEAVIATE_PRIMARY_KEY
List of property names to use as composite primary key for upsert operations. Required when load_method is 'upsert'. Example: ['id'] or ['retailer', 'product_id']
Configure this setting directly using the following Meltano command:
meltano config target-weaviate set primary_key [value]Other streams (stream_maps.__else__)
-
Environment variable:
TARGET_WEAVIATE_STREAM_MAPS___ELSE__
Currently, only setting this to __NULL__ is supported. This will remove all other streams.
Configure this setting directly using the following Meltano command:
meltano config target-weaviate set stream_maps __else__ [value]Vectorizer (vectorizer)
-
Environment variable:
TARGET_WEAVIATE_VECTORIZER
Vectorizer to use when creating a new collection. Examples: 'text2vec-cohere', 'text2vec-openai', 'none'. Only used if the collection doesn't exist and needs to be created.
Configure this setting directly using the following Meltano command:
meltano config target-weaviate set vectorizer [value]Weaviate API Key (weaviate_api_key)
-
Environment variable:
TARGET_WEAVIATE_WEAVIATE_API_KEY
Weaviate API key for authentication. Required for Weaviate Cloud.
Configure this setting directly using the following Meltano command:
meltano config target-weaviate set weaviate_api_key [value]Weaviate URL (weaviate_url)
-
Environment variable:
TARGET_WEAVIATE_WEAVIATE_URL
Weaviate instance URL (e.g., https://my-cluster.weaviate.network)
Configure this setting directly using the following Meltano command:
meltano config target-weaviate set weaviate_url [value]Expand To Show SDK Settings
Add Record Metadata (add_record_metadata)
-
Environment variable:
TARGET_WEAVIATE_ADD_RECORD_METADATA
Additional metadata to add to all records.
Configure this setting directly using the following Meltano command:
meltano config target-weaviate set add_record_metadata [value]Faker Locale (faker_config.locale)
-
Environment variable:
TARGET_WEAVIATE_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-weaviate set faker_config locale [value]Faker Seed (faker_config.seed)
-
Environment variable:
TARGET_WEAVIATE_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-weaviate set faker_config seed [value]Enable Schema Flattening (flattening_enabled)
-
Environment variable:
TARGET_WEAVIATE_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config target-weaviate set flattening_enabled [value]Max Flattening Depth (flattening_max_depth)
-
Environment variable:
TARGET_WEAVIATE_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config target-weaviate set flattening_max_depth [value]Load Method (load_method)
-
Environment variable:
TARGET_WEAVIATE_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-weaviate set load_method [value]User Stream Map Configuration (stream_map_config)
-
Environment variable:
TARGET_WEAVIATE_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-weaviate set stream_map_config [value]Validate Records (validate_records)
-
Environment variable:
TARGET_WEAVIATE_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-weaviate 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}
