OpenSearch Upsert

Overview

You can use this Snap to executes an upsert (insert or update) on the specified OpenSearch index. To maintain data consistency, this Snap fetches the mapping (schema) of the OpenSearch index and permits the upload of fields defined in the mapping (with matching field types). Learn more about Set up an OpenSearch index.


OpenSearch Upsert Overview

  • Write-type Snap
  • Works in Ultra Tasks when the Batch size is set to 1.

Prerequisites

Snap views

View Description Examples of upstream and downstream Snaps
Input This Snap has at the most one document input view. One field in the input record must be of vector type. Mapper
Output This Snap has at the most one document output view. The output document contains the created and/or updated data. By default, there is no output view selected. Mapper
Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

  • Stop Pipeline Execution Stops the current pipeline execution when an error occurs.
  • Discard Error Data and Continue Ignores the error, discards that record, and continues with the remaining records.
  • Route Error Data to Error View Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap settings

Legend:
  • Expression icon (): JavaScript syntax to access SnapLogic Expressions to set field values dynamically (if enabled). If disabled, you can provide a static value. Learn more.
  • SnapGPT (): Generates SnapLogic Expressions based on natural language using SnapGPT. Learn more.
  • Suggestion icon (): Populates a list of values dynamically based on your Account configuration.
  • Upload : Uploads files. Learn more.
Learn more about the icons in the Snap settings dialog.
Field / field set Type Description
Label String

Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: OpenSearch Upsertt

Example: ProductSimilarityRecommendation
Index name String/Expression/Suggestion

Required. Specify the name of the OpenSearch index from which you want to query records.

Default value: N/A

Example: document_embeddings
Record ID String/Expression
Specify the document ID for the upsert operation (update/insert). The ID must be 512 characters or less in length.
Note:
  • If a record with the same ID already exists in the index, it will be updated; otherwise, it will be inserted.
  • If the field is left blank, a random ID will be automatically generated.

Default value: 1

Example: product_embeddings
Batch size String/Expression

Specify the number of documents the Snap will batch before processing a request.

Note:
  • There is no upper limit on the batch size in terms of the number of documents; however, the maximum bulk body size is limited to within 5,000,000 bytes.
  • Set the Batch size to 1 if your pipelines run in Ultra mode.
  • This field does not support input values from the upstream Snap.

Default value: N/A

Example: 10
Snap execution Dropdown list
Select one of the three modes in which the Snap executes. Available options are:
  • Validate & Execute: Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.
  • Execute only: Performs full execution of the Snap during pipeline execution without generating preview data.
  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Default value: Execute only

Example: Validate & Execute

Examples