vendure-data-hub-plugin

Reference

Complete reference documentation for all Data Hub adapters.

Adapters Catalog - Browse all extractors, operators, and loaders

Contents

1. Step Types - All pipeline step types
2. Extractors - All data extractors
3. Loaders - All entity loaders
4. Operators - All transform operators (curated guide)
5. Operators Complete - Auto-generated complete operator reference (all 61 operators)
6. Feed Generators - Product feed generators
7. Search Sinks - Search engine integrations

Quick Reference

Extractors (9)

Code	Description
httpApi	REST API with pagination, authentication, retry
graphql	External GraphQL endpoints with cursor/offset/Relay pagination
vendureQuery	Vendure entity queries with automatic pagination
file	Parse files (CSV, JSON, XML, XLSX, NDJSON, TSV)
database	SQL databases (PostgreSQL, MySQL, SQLite, MSSQL, Oracle)
s3	S3-compatible storage (AWS, MinIO, DigitalOcean Spaces)
ftp	FTP/SFTP servers
cdc	Change Data Capture - poll database tables for changes
webhook	Incoming webhook payloads

Loaders (24 - 16 Entity + 4 Order Operations + 1 Deletion + 1 Inventory + 2 External API)

Code	Description
productUpsert	Upsert products by slug/SKU with facets and assets
variantUpsert	Update variants by SKU with multi-currency prices
customerUpsert	Create/update customers with addresses and groups
customerGroupUpsert	Create/update customer groups with member assignments
collectionUpsert	Create/update collections with parent relationships
facetUpsert	Create/update facets for categorization
facetValueUpsert	Create/update facet values within facets
promotionUpsert	Create/update promotions with conditions and actions
orderUpsert	Order create/update for migrations with state transitions and line management
orderNote	Add notes to existing orders
orderTransition	Transition order states
applyCoupon	Apply coupon codes to orders
shippingMethodUpsert	Create/update shipping methods with calculators
stockLocationUpsert	Create/update stock locations
stockAdjust	Adjust stock levels by SKU
inventoryAdjust	Adjust inventory levels by SKU and location
assetAttach	Attach existing assets to entities
assetImport	Import assets from external URLs
taxRateUpsert	Create/update tax rates with category and zone
paymentMethodUpsert	Create/update payment methods with handlers
channelUpsert	Create/update channels with currencies and languages
entityDeletion	Delete any of 13 entity types by slug, SKU, ID, code, email, or name
restPost	POST data to custom REST endpoints
graphqlMutation	Send records as GraphQL mutations to external APIs

Operator Categories (61 operators)

Category	Operators
Data (8)	set, copy, rename, remove, map, template, hash, uuid
String (12)	trim, uppercase, lowercase, slugify, split, join, concat, replace, extractRegex, replaceRegex, stripHtml, truncate
Numeric (9)	math, toNumber, toString, currency, unit, parseNumber, formatNumber, toCents, round
Date (5)	dateFormat, dateParse, dateAdd, dateDiff, now
Logic (4)	when, ifThenElse, switch, deltaFilter
JSON (4)	pick, omit, parseJson, stringifyJson
Enrichment (5)	lookup, enrich, coalesce, default, httpLookup
Aggregation (8)	aggregate, multiJoin, flatten, count, unique, first, last, expand
File (3)	imageResize, imageConvert, pdfGenerate
Validation (2)	validateRequired, validateFormat
Advanced (1)	script

Feed Types (4)

Adapter Code	Platform
googleMerchant	Google Merchant Center / Google Shopping
metaCatalog	Meta/Facebook/Instagram Catalog
amazonFeed	Amazon Seller Central
customFeed	Custom CSV, JSON, or XML format

Sink Types (7)

Code	Engine
elasticsearch	Elasticsearch
opensearch	OpenSearch
meilisearch	MeiliSearch
algolia	Algolia
typesense	Typesense
queueProducer	RabbitMQ Queue
webhook	HTTP Webhook (POST/PUT/PATCH)

API Notes

• startDataHubPipelineRun: This mutation does not accept seed records. To provide seed data to a pipeline, use the webhook trigger (records passed in the request body) or the dataHubTestWithSeedData mutation for dry-run testing.

This site is open source. Improve this page.