
Typesense DocumentIndex
CertifiedUpsert one document into Typesense
Typesense DocumentIndex
Upsert one document into Typesense
Writes a single JSON document to the target collection using Typesense upsert semantics (create or replace).
type: io.kestra.plugin.typesense.DocumentIndexExamples
Index a document to a Typesense DB
id: typesense_index_document
namespace: company.team
tasks:
- id: index_document
type: io.kestra.plugin.typesense.DocumentIndex
document: { "countryName":"France", "capital": "Paris", "gdp": 123456}
apiKey: "{{ secret('TYPESENSE_API_KEY') }}"
port: 8108
host: localhost
collection: Countries
Properties
apiKey *Requiredstring
Typesense API key
Admin or search key used for this request; must allow access to the target collection
collection *Requiredstring
Collection name
Name of the Typesense collection; value is rendered before each call
document *Requiredobject
Document body
Map of fields to upsert. Keys must match the collection schema; nested objects are not flattened.
host *Requiredstring
Typesense host
Hostname or IP address of the Typesense cluster node or load balancer
port *Requiredstring
Typesense port
TCP port for the Typesense HTTP API; 8108 is the Typesense default
https booleanstring
Use HTTPS
Default false (HTTP). Set to true to call Typesense over HTTPS/TLS
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.