Rename schema to collection to match Weaviate's updated terminology

README.md

@@ -44,11 +44,11 @@ client = Weaviate::Client.new(
 )
 ```
 
-### Using the Schema endpoints
+### Using the Collections endpoints
 
 ```ruby
-# Creating a new data object class in the schema
-client.schema.create(
+# Creating a new collection
+client.collections.create(
     class_name: 'Question',
     description: 'Information from a Jeopardy! question',
     properties: [
@@ -70,36 +70,36 @@ client.schema.create(
     vectorizer: "text2vec-openai"
 )
 
-# Get a single class from the schema
-client.schema.get(class_name: 'Question')
+# Get a single collection
+client.collections.get(class_name: 'Question')
 
-# Get the schema
-client.schema.list()
+# List all collections
+client.collections.list()
 
-# Update settings of an existing schema class.
+# Update settings of an existing collection.
 # Does not support modifying existing properties.
-client.schema.update(
+client.collections.update(
     class_name: 'Question',
     description: 'Information from a Wheel of Fortune question'
 )
 
 # Adding a new property
-client.schema.add_property(
+client.collections.add_property(
     class_name: 'Question',
     property: {
         "dataType": ["boolean"],
         "name": "homepage"
     }
 )
 
-# Inspect the shards of a class
-client.schema.shards(class_name: 'Question')
+# Inspect the shards of a collection
+client.collections.shards(class_name: 'Question')
 
-# Remove a class (and all data in the instances) from the schema.
-client.schema.delete(class_name: 'Question')
+# Remove a collection (and all data in the instances).
+client.collections.delete(class_name: 'Question')
 
-# Creating a new data object class in the schema while configuring the vectorizer on the schema and on individual properties (Ollama example)
-client.schema.create(
+# Creating a new collection while configuring the vectorizer on the collection and on individual properties (Ollama example)
+client.collections.create(
     class_name: 'Question',
     description: 'Information from a Jeopardy! question',
     properties: [
@@ -140,9 +140,9 @@ client.schema.create(
     },
 )
 
-# Creating named schemas
+# Creating collections with named vectors
 
-client.schema.create(
+client.collections.create(
   class_name: 'ArticleNV',
   description: 'Articles with named vectors',
   properties: [
@@ -403,10 +403,10 @@ client.ready?
 
 ### Tenants
 
-Any schema can be multi-tenant by passing in these options for to `schema.create()`.
+Any collection can be multi-tenant by passing in these options for to `collections.create()`.
 
 ```ruby
-client.schema.create(
+client.collections.create(
     # Other keys...
     multi_tenant: true,
     auto_tenant_creation: true,

lib/weaviate.rb

@@ -6,6 +6,7 @@ module Weaviate
   autoload :Base, "weaviate/base"
   autoload :Client, "weaviate/client"
   autoload :Error, "weaviate/error"
+  autoload :Collection, "weaviate/collection"
   autoload :Schema, "weaviate/schema"
   autoload :Meta, "weaviate/meta"
   autoload :Objects, "weaviate/objects"

lib/weaviate/client.rb

@@ -40,8 +40,12 @@ def oidc
       Weaviate::OIDC.new(client: self).get
     end
 
+    def collections
+      @collections ||= Weaviate::Collection.new(client: self)
+    end
+
     def schema
-      @schema ||= Weaviate::Schema.new(client: self)
+      @schema ||= collections
     end
 
     def meta

lib/weaviate/collection.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+module Weaviate
+  class Collection < Base
+    PATH = "schema"
+
+    # Dumps the current Weaviate schema. The result contains an array of objects.
+    def list
+      response = client.connection.get(PATH)
+      response.body
+    end
+
+    # Get a single class from the schema
+    def get(class_name:)
+      response = client.connection.get("#{PATH}/#{class_name}")
+
+      if response.success?
+        response.body
+      elsif response.status == 404
+        response.reason_phrase
+      end
+    end
+
+    # Create a new data object class in the schema.
+    def create(
+      class_name:,
+      description: nil,
+      properties: nil,
+      multi_tenant: false,
+      auto_tenant_creation: false,
+      auto_tenant_activation: false,
+      vector_index_type: nil,
+      vector_index_config: nil,
+      vectorizer: nil,
+      module_config: nil,
+      inverted_index_config: nil,
+      replication_config: nil,
+      vector_config: nil        # added for named vector support
+    )
+      response = client.connection.post(PATH) do |req|
+        req.body = {}
+        req.body["class"] = class_name
+        req.body["description"] = description unless description.nil?
+        req.body["vectorIndexType"] = vector_index_type unless vector_index_type.nil?
+        req.body["vectorIndexConfig"] = vector_index_config unless vector_index_config.nil?
+        req.body["vectorizer"] = vectorizer unless vectorizer.nil?
+        req.body["moduleConfig"] = module_config unless module_config.nil?
+        req.body["properties"] = properties unless properties.nil?
+
+        if multi_tenant
+          req.body["multiTenancyConfig"] = {
+            enabled: multi_tenant,
+            autoTenantCreation: auto_tenant_creation,
+            autoTenantActivation: auto_tenant_activation
+          }
+        end
+
+        req.body["invertedIndexConfig"] = inverted_index_config unless inverted_index_config.nil?
+        req.body["replicationConfig"] = replication_config unless replication_config.nil?
+        req.body["vectorConfig"] = vector_config unless vector_config.nil?  # Added for multi vector support
+      end
+
+      response.body
+    end
+
+    # Remove a class (and all data in the instances) from the schema.
+    def delete(class_name:)
+      response = client.connection.delete("#{PATH}/#{class_name}")
+
+      if response.success?
+        response.body.empty?
+      else
+        response.body
+      end
+    end
+
+    # Update settings of an existing schema class.
+    # TODO: Fix it.
+    # This endpoint keeps returning the following error:
+    # => {"error"=>[{"message"=>"properties cannot be updated through updating the class. Use the add property feature (e.g. \"POST /v1/schema/{className}/properties\") to add additional properties"}]}
+    def update(
+      class_name:,
+      description: nil,
+      vector_index_type: nil,
+      vector_index_config: nil,
+      vectorizer: nil,
+      module_config: nil,
+      properties: nil,
+      inverted_index_config: nil,
+      replication_config: nil
+    )
+      response = client.connection.put("#{PATH}/#{class_name}") do |req|
+        req.body = {}
+        req.body["class"] = class_name unless class_name.nil?
+        req.body["description"] = description unless description.nil?
+        req.body["vectorIndexType"] = vector_index_type unless vector_index_type.nil?
+        req.body["vectorIndexConfig"] = vector_index_config unless vector_index_config.nil?
+        req.body["vectorizer"] = vectorizer unless vectorizer.nil?
+        req.body["moduleConfig"] = module_config unless module_config.nil?
+        req.body["properties"] = properties unless properties.nil?
+        req.body["invertedIndexConfig"] = inverted_index_config unless inverted_index_config.nil?
+        req.body["replicationConfig"] = replication_config unless replication_config.nil?
+      end
+
+      if response.success?
+      end
+      response.body
+    end
+
+    # Adds one or more tenants to a class.
+    def add_tenants(
+      class_name:,
+      tenants:
+    )
+      response = client.connection.post("#{PATH}/#{class_name}/tenants") do |req|
+        tenants_str = tenants.map { |t| %({"name": "#{t}"}) }.join(", ")
+        req.body = "[#{tenants_str}]"
+      end
+      response.body
+    end
+
+    # List tenants of a class.
+    def list_tenants(class_name:)
+      response = client.connection.get("#{PATH}/#{class_name}/tenants")
+      response.body
+    end
+
+    # Remove one or more tenants from a class.
+    def remove_tenants(
+      class_name:,
+      tenants:
+    )
+      response = client.connection.delete("#{PATH}/#{class_name}/tenants") do |req|
+        req.body = tenants
+      end
+
+      if response.success?
+      end
+
+      response.body
+    end
+
+    # Add a property to an existing schema class.
+    def add_property(
+      class_name:,
+      property:
+    )
+      response = client.connection.post("#{PATH}/#{class_name}/properties") do |req|
+        req.body = property
+      end
+
+      if response.success?
+      end
+      response.body
+    end
+
+    # Inspect the shards of a class
+    def shards(class_name:)
+      response = client.connection.get("#{PATH}/#{class_name}/shards")
+      response.body if response.success?
+    end
+
+    # Update shard status
+    def update_shard_status(class_name:, shard_name:, status:)
+      validate_status!(status)
+
+      response = client.connection.put("#{PATH}/#{class_name}/shards/#{shard_name}") do |req|
+        req.body = {}
+        req.body["status"] = status
+      end
+      response.body if response.success?
+    end
+
+    private
+
+    def validate_status!(status)
+      unless %w[READONLY READY].include?(status.to_s.upcase)
+        raise ArgumentError, 'status must be either "READONLY" or "READY"'
+      end
+    end
+  end
+end