Weaviate Query

Weaviate Query

Certified

Run GraphQL query against Weaviate

Executes a raw GraphQL query on Weaviate. Defaults to storing all rows to Kestra storage as ION; other fetch modes can return rows inline or skip storage.

yaml
type: io.kestra.plugin.weaviate.Query

Execute a GraphQL query to fetch data from a Weaviate database.

yaml
id: weaviate_query
namespace: company.team

tasks:
  - id: query
    type: io.kestra.plugin.weaviate.Query
    url: https://demo-cluster-id.weaviate.network
    apiKey: "{{ secret('WEAVIATE_API_KEY') }}"
    fetchType: FETCH
    query: |
      {
        Get {
          Question(limit: 5) {
            question
            answer
            category
          }
        }
      }


Query data from a Weaviate database using Generative Search with OpenAI

yaml
id: weaviate_generative_search
namespace: company.team

tasks:
  - id: query
    type: io.kestra.plugin.weaviate.Query
    url: https://demo-cluster-id.weaviate.network
    apiKey: "{{ secret('WEAVIATE_API_KEY') }}"
    headers:
      X-OpenAI-Api-Key: "{{ secret('OPENAI_API_KEY') }}"
    fetchType: FETCH
    query: |
      {
        Get {
          Question(limit: 5, nearText: {concepts: ["biology"]}) {
            question
            answer
            category
          }
        }
      }
Properties
Min length1

GraphQL query

Min length1

Configure Weaviate endpoint URL

Full http or https host for the Weaviate cluster, including port when not default. Example: localhost: 8080 or https://cluster-id.weaviate.network

Provide managed cluster API key

Optional bearer-style key for hosted Weaviate; if omitted, requests use anonymous access.

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.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset 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.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
DefaultSTORE
Possible Values
STOREFETCHFETCH_ONENONE

Select fetch behavior

Defaults to STORE (writes all rows to Kestra storage as ION and returns the URI). FETCH returns all rows inline, FETCH_ONE returns the first row, NONE skips result materialization for DDL-type queries.

Set custom request headers

Key/value headers appended to every call, e.g. extra auth tokens for upstream services. The plugin also sends an X-Weaviate-Client-Integration header identifying itself; setting that key here overrides it.

Map containing the first row of fetched data.

Only populated if using fetchType=FETCH_ONE.

List containing the fetched data.

Only populated if using fetchType=FETCH.

The number of fetched rows.

Formaturi

Kestra's internal storage URI of the stored data.

Only populated if using fetchType=STORE.