Typesense BulkIndex
CertifiedBulk upsert documents into Typesense
Typesense BulkIndex
Bulk upsert documents into Typesense
Streams records from an Amazon ION file in internal storage and upserts them into the target collection.
type: io.kestra.plugin.typesense.BulkIndexExamples
Index documents to a Typesense DB from an ION file
id: typesense_bulk_index
namespace: company.team
tasks:
- id: bulk_index
type: io.kestra.plugin.typesense.BulkIndex
apiKey: "{{ secret('TYPESENSE_API_KEY') }}"
port: 8108
host: localhost
collection: Countries
from: kestra://data/countries.ion
Properties
apiKey *string
Typesense API key
Admin or search key used for this request; must allow access to the target collection
collection *string
Collection name
Name of the Typesense collection; value is rendered before each call
from *string
Input ION file URI
kestra:// or other storage URI pointing to an Amazon ION file with one JSON document per line.
host *string
Typesense host
Hostname or IP address of the Typesense cluster node or load balancer
port *string
Typesense port
TCP port for the Typesense HTTP API; 8108 is the Typesense default
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150chunk integerstring
1000Bulk chunk size
Number of documents per Typesense bulk call. Default 1000; lower to reduce memory, raise to improve throughput.
https booleanstring
Use HTTPS
Default false (HTTP). Set to true to call Typesense over HTTPS/TLS
Outputs
size integer
Indexed document count
Total number of documents read from the input and sent to Typesense.
Metrics
records counter
Number of records
requests.count counter
Number of request
