Weaviate SchemaCreate

Weaviate SchemaCreate
Certified
Create a Weaviate class schema

Creates a new Weaviate class with the provided properties. Fails if the class already exists; data types must match Weaviate schema types.

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

Examples

Send schema creation request to a Weaviate database.

yaml
id: create_weaviate_schema
namespace: company.team

tasks:
  - id: schema
    type: io.kestra.plugin.weaviate.SchemaCreate
    url: "https://demo-cluster-id.weaviate.network"
    apiKey: "{{ secret('WEAVIATE_API_KEY') }}"
    className: Movies
    fields:
      name:
        - string
      description:
        - string
      category:
        - string

Properties

className *string

Min length1

Class name where your data will be stored

url *string

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

apiKey string

Provide managed cluster API key

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

assets

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

io.kestra.core.models.assets.AssetsDeclaration

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.

io.kestra.core.models.assets.AssetIdentifier

id*string

Min length1

typestring

outputs

The assets produced as outputs.

io.kestra.plugin.ee.assets.Dataset

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.plugin.ee.assets.File

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.plugin.ee.assets.Table

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.plugin.ee.assets.VM

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.core.models.assets.External

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.core.models.assets.Custom

id*string

Min length1

Max length150

type*string

Min length1

Custom asset type

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

fields object

SubTypearray

Properties to add to the class

Map of property name to a list of Weaviate data types (e.g. string, int). All listed properties are created on the new class.

headers object

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.

Outputs

success boolean

Whether the schema creation succeeded