Receives rows and inserts, updates, deletes or upserts them into a registered database table provider, according to its configured mode. The providerId attribute selects which registered database table provider performs the write; the mode attribute selects the operation, one of insert, update, delete or updateOrInsert, and update, delete and updateOrInsert all require the row to carry an identifier. Providers available for this step include the category, group membership, organisation, points row, products and product options table providers; sales data should normally be written with SalesDataInserter instead of this step. Each configured Column maps a value from the incoming row onto a field expected by the provider, and when setIntoAttribute is set the entity that was created or updated is stored under that name as a pipeline attribute for later steps to use.

Implements: PipelineStep

---

Properties

---

Methods

getFormPath() · getDescription() · getProviderId() · isAutoFlush() · getNext() · getNextStep() · getMode() · getColumns() · getSetIntoAttribute() · getSkipIfBlankColumns()

getFormPath()

Returns: String

Path to the Velocity template used by the pipeline management UI to edit this step's configuration.

getDescription()

Returns: String

Human-readable summary of this step, shown to administrators managing the pipeline.

getProviderId()

Returns: String

Identifier of the registered database table provider that this step writes rows to.

isAutoFlush()

Returns: boolean

Whether the Hibernate session is periodically refreshed while processing rows, done every 100 rows to keep memory usage down on large imports.

getNext()

Returns: PipelineStep

The single next step that rows are passed to after being written to the provider.

getNextStep()

Returns: PipelineStep

The single next step that rows are passed to after being written to the provider. Equivalent to getNext.

getMode()

Returns: String

The database operation this step performs on incoming rows: one of insert, update, delete or updateOrInsert. Update, delete and updateOrInsert require the row to carry an identifier.

getColumns()

Returns: List<Column>

Columns that map values from the incoming row onto fields expected by the target provider.

getSetIntoAttribute()

Returns: String

Name of the pipeline attribute that the entity created or updated by this step is stored under, for later steps to read, or null if the result is not stored as an attribute.

getSkipIfBlankColumns()

Returns: List<Integer>

Zero-indexed column numbers that, if blank in a row, cause that row to be skipped rather than written to the provider.