FacetSearch

Search documents in a Typesense DB with a facet search.

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

Examples

Search documents with facet

yaml
id: typesense_facet_search
namespace: company.team

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

Properties

apiKey *string

The API key to connect to the typesense DB

collection *string

The name of the typesense collection

facetBy *string

The query

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

​Facet​Search

FacetSearch