Search

Search documents in a Typesense DB.

yaml
type: "io.kestra.plugin.typesense.Search"

Examples

Search documents

yaml
id: typesense_search
namespace: company.team

tasks:
  - id: search
    type: io.kestra.plugin.typesense.Search
    apiKey: "{{ secret('TYPESENSE_API_KEY') }}"
    port: 8108
    host: localhost
    collection: Countries
    query: Paris
    queryBy: capital
    filter: "countryName: [France, England]"
    sortBy: "gdp:desc"

Properties

apiKey *string

The API key to connect to the typesense DB

collection *string

The name of the typesense collection

host *string

The host of the typesense DB

port *string

The port of the typesense DB

query *string

The query

queryBy *string

The fields to query

filter string

The filters to apply to the query

https booleanstring

Is HTTPS used

By default, HTTP protocol will be use. Set this value to true tu use HTTPS

sortBy string

The sorts to apply to the query

Outputs

totalHits integer

Hits number

Number of items hit by the search request

uri string

Format uri

URI to output

Results URI to an Amazon .ion file

​Search

Search