Typesense DocumentGet

Typesense DocumentGet
Certified
Fetch one document from Typesense

Retrieves a single document by id from the specified collection.

yaml
type: io.kestra.plugin.typesense.DocumentGet

Examples

Get a document from a Typesense DB

yaml
id: typesense_get_document
namespace: company.team

tasks:
  - id: get_document
    type: io.kestra.plugin.typesense.DocumentGet
    documentId: "0"
    apiKey: "{{ secret('TYPESENSE_API_KEY') }}"
    port: 8108
    host: localhost
    collection: Countries

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

documentId *string

Document id

Typesense document id to fetch; must exist in the collection.

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

https booleanstring

Use HTTPS

Default false (HTTP). Set to true to call Typesense over HTTPS/TLS

pluginDefaultsRef string

Reference (ref) of the pluginDefaults to apply to this task.

Outputs

document object

Fetched document

Document map returned by Typesense for the requested id.

Clickhouse

Tasks that connect to ClickHouse via JDBC to run queries and loads.

Data

Weaviate

Tasks that manage and query vectors in Weaviate.

DataAI

Typesense DocumentGetCertifiedFetch one document from Typesense

Typesense DocumentGet

More Plugins in this Category

Clickhouse

Weaviate

Typesense DocumentGet
Certified
Fetch one document from Typesense