Struct Schema 

pub struct Schema { /* private fields */ }

All schema related endpoints and functionality described in Weaviate schema API documentation

Implementations

impl Schema

pub async fn get_class(&self, class_name: &str) -> Result<Class, Box<dyn Error>>

Facilitates the retrieval of the configuration for a single class in the schema.

GET /v1/schema/{class_name}

use weaviate_community::WeaviateClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = WeaviateClient::builder("http://localhost:8080").build()?;
    let response = client.schema.get_class("Library").await;
    assert!(response.is_err());
    Ok(())
}

pub async fn get(&self) -> Result<Classes, Box<dyn Error>>

Facilitates the retrieval of the full Weaviate schema.

GET /v1/schema

use weaviate_community::WeaviateClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = WeaviateClient::builder("http://localhost:8080").build()?;
    let schema = client.schema.get().await?;
    println!("{:#?}", &schema);
    Ok(())
}

pub async fn create_class(&self, class: &Class) -> Result<Class, Box<dyn Error>>

Create a new data object class in the schema.

Note that from 1.5.0, creating a schema is optional, as Auto Schema is available. See for more info: Weaviate auto-schema documentation

POST /v1/schema

use weaviate_community::WeaviateClient;
use weaviate_community::collections::schema::Class;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let class = Class::builder("Library").build();
    let client = WeaviateClient::builder("http://localhost:8080").build()?;
    let res = client.schema.create_class(&class).await?;

    Ok(())
}

pub async fn delete(&self, class_name: &str) -> Result<bool, Box<dyn Error>>

Remove a class (and all data in the instances) from the schema.

DELETE v1/schema/{class_name}

use weaviate_community::WeaviateClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = WeaviateClient::builder("http://localhost:8080").build()?;
    let response = client.schema.delete("Library").await;

    Ok(())
}

pub async fn update(&self, class: &Class) -> Result<Class, Box<dyn Error>>

Update settings of an existing schema class.

Use this endpoint to alter an existing class in the schema. Note that not all settings are mutable. If an error about immutable fields is returned and you still need to update this particular setting, you will have to delete the class (and the underlying data) and recreate. This endpoint cannot be used to modify properties. A typical use case for this endpoint is to update configuration, such as the vectorIndexConfig. Note that even in mutable sections, such as vectorIndexConfig, some fields may be immutable.

You should attach a body to this PUT request with the entire new configuration of the class

pub async fn add_property( &self, class_name: &str, property: &Property, ) -> Result<Property, Box<dyn Error>>

Add a property to an existing class in the schema.

pub async fn get_shards( &self, class_name: &str, ) -> Result<Shards, Box<dyn Error>>

View all of the shards for a particular class.

pub async fn update_class_shard( &self, class_name: &str, shard_name: &str, status: ShardStatus, ) -> Result<Shard, Box<dyn Error>>

Update shard status

pub async fn list_tenants( &self, class_name: &str, ) -> Result<Tenants, Box<dyn Error>>

List tenants

pub async fn add_tenants( &self, class_name: &str, tenants: &Tenants, ) -> Result<Tenants, Box<dyn Error>>

Add tenant

pub async fn remove_tenants( &self, class_name: &str, tenants: &Vec<&str>, ) -> Result<bool, Box<dyn Error>>

Remove tenants

pub async fn update_tenants( &self, class_name: &str, tenants: &Tenants, ) -> Result<Tenants, Box<dyn Error>>

Update tenants

For updating tenants, both name and activity_status are required.

Note that tenant activity status setting is only available from Weaviate v1.21

Trait Implementations

impl Debug for Schema

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.