milvus 0.10.2 → 0.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c38f7235b815b1f48dd2d61e445b99ca675f974d1dddeba02796bf02e353fdd1
-  data.tar.gz: 4af6a551675f63cb17ee6f2c80a8ca000ea98ff028eeefa71f9593061ac04969
+  metadata.gz: 914040de2cf35a3985d67dbd19de618e00d82262b61220df8bbf517cee40f72f
+  data.tar.gz: d88ca74f1a6674cefadd0d790b3a3c828da1f2e585a2cd9b4d3fa9dca492115a
 SHA512:
-  metadata.gz: 37d2666740b3e9df096e5f8b024a72fff37b60c53810f8dcbd5f0b14c4a008060d5cad78109664b74d7e2e76d21c8559cbb6c079b046032acd09491c5a3c3109
-  data.tar.gz: 7c10d887561876c02e6f869807b01c339b2412137e3cefb584ce5451da815eafec06f5c4ea83bbd231862b9742aad08d711566a2660193016b9eb809eca7798b
+  metadata.gz: 5092e0ec3696ce6d8e8a7a9d8df199f32f9ef4172f3aa65e0d415312da019c47763beef7df1e4714e3adee53f806f0bfd79f35e99884d8df8abb5745755f73a1
+  data.tar.gz: 9580e92290a0a3f132b39629ff4bc25ef759b7b2d608cf744218bd529e9e54ac328194584db757af76b56f03790793468e9e6b6bebadc173301403fb17fc52bc

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.10.3] - 2024-10-01
+- Weaviate::Client constructor accepts customer logger: to be passed in
+- Added Alias management
+
 ## [0.10.2] - 2024-07-28
 - Added Roles management
 - Added Users management

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    milvus (0.10.2)
+    milvus (0.10.3)
       faraday (>= 2.0.1, < 3)
 
 GEM

data/README.md

@@ -22,11 +22,6 @@ Available for paid consulting engagements! [Email me](mailto:andrei@sourcelabs.i
 ## API Docs
 https://docs.zilliz.com/reference/restful/data-plane-v2
 
-## TODOs
-- [X] Support for [User endpoints](https://docs.zilliz.com/reference/restful/user-operations-v2)
-- [X] Support for [Role endpoints](https://docs.zilliz.com/reference/restful/role-operations-v2)
-- [ ] Support for [Alias endpoints](https://docs.zilliz.com/reference/restful/alias-operations-v2)
-
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -311,6 +306,27 @@ client.users.grant_role(user_name: 'user_name', role_name: 'admin')
 # Revoke role from the user 
 client.users.revoke_role(user_name: 'user_name', role_name: 'admin')
 ```
+### Aliases
+```ruby
+# Lists all existing collection aliases in the specified database
+client.aliases.list
+```
+```ruby
+# Describes the details of a specific alias
+client.aliases.describe
+```
+```ruby
+# Reassigns the alias of one collection to another.
+client.aliases.alter
+```
+```ruby
+# Drops a specified alias
+client.aliases.drop
+```
+```ruby
+# Creates an alias for an existing collection
+client.aliases.create
+```
 
 ## Development
 
@@ -320,7 +336,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Development with Docker
 
-Run `docker compose run --rm ruby_app bash` and install required gems (`bundle install`). It will give you a fully working development environment with Milvius services and gem's code.
+Run `docker compose run --rm ruby_app bash` and install required gems (`bundle install`). It will give you a fully working development environment with Milvus services and gem's code.
 
 For example inside docker container run `bin/console` and inside the ruby console:
 ```ruby

data/lib/milvus/aliases.rb

@@ -0,0 +1,78 @@
+# https://docs.zilliz.com/reference/restful/alias-operations-v2
+
+module Milvus
+  class Aliases < Base
+    PATH = "aliases"
+
+    # Lists available roles on the server
+    #
+    # @return [Hash] The response from the server
+    def list
+      response = client.connection.post("#{PATH}/list") do |req|
+        req.body = {}
+      end
+
+      response.body
+    end
+
+    # Describes the details of a specific alias
+    #
+    # @param alias_name [String] The name of the alias to describe
+    # @return [Hash] The response from the server
+    def describe(alias_name:)
+      response = client.connection.post("#{PATH}/describe") do |req|
+        req.body = {
+          aliasName: alias_name
+        }
+      end
+
+      response.body
+    end
+
+    # Reassigns the alias of one collection to another
+    #
+    # @param alias_name [String] The alias of the collection
+    # @param collection_name [String] The name of the target collection to reassign an alias to
+    # @return [Hash] The response from the server
+    def alter(alias_name:, collection_name:)
+      response = client.connection.post("#{PATH}/alter") do |req|
+        req.body = {
+          aliasName: alias_name,
+          collectionName: collection_name
+        }
+      end
+
+      response.body
+    end
+
+    # This operation drops a specified alias
+    #
+    # @param alias_name [String] The alias to drop
+    # @return [Hash] The response from the server
+    def drop(alias_name:)
+      response = client.connection.post("#{PATH}/drop") do |req|
+        req.body = {
+          aliasName: alias_name
+        }
+      end
+
+      response.body
+    end
+
+    # This operation creates an alias for an existing collection. A collection can have multiple aliases, while an alias can be associated with only one collection.
+    #
+    # @param alias_name [String] The alias of the collection
+    # @param collection_name [String] The name of the target collection to reassign an alias to
+    # @return [Hash] The response from the server
+    def create(alias_name:, collection_name:)
+      response = client.connection.post("#{PATH}/create") do |req|
+        req.body = {
+          aliasName: alias_name,
+          collectionName: collection_name
+        }
+      end
+
+      response.body
+    end
+  end
+end

data/lib/milvus/client.rb

@@ -4,13 +4,22 @@ require "faraday"
 
 module Milvus
   class Client
-    attr_reader :url, :api_key
+    attr_reader :url, :api_key, :adapter, :raise_error, :logger
 
     API_VERSION = "v2/vectordb"
 
-    def initialize(url:, api_key: nil)
+    def initialize(
+      url:,
+      api_key: nil,
+      adapter: Faraday.default_adapter,
+      raise_error: false,
+      logger: nil
+    )
       @url = url
       @api_key = api_key
+      @adapter = adapter
+      @raise_error = raise_error
+      @logger = logger || Logger.new($stdout)
     end
 
     def collections
@@ -37,14 +46,20 @@ module Milvus
       @users ||= Milvus::Users.new(client: self)
     end
 
+    def aliases
+      @aliases ||= Milvus::Aliases.new(client: self)
+    end
+
     def connection
       @connection ||= Faraday.new(url: "#{url}/#{API_VERSION}/") do |faraday|
         if api_key
           faraday.request :authorization, :Bearer, api_key
         end
         faraday.request :json
+        faraday.response :logger, logger, {headers: true, bodies: true, errors: true}
+        faraday.response :raise_error if raise_error
         faraday.response :json, content_type: /\bjson$/
-        faraday.adapter Faraday.default_adapter
+        faraday.adapter adapter
       end
     end
   end

data/lib/milvus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Milvus
-  VERSION = "0.10.2"
+  VERSION = "0.10.3"
 end

data/lib/milvus.rb

@@ -13,4 +13,5 @@ module Milvus
   autoload :Partitions, "milvus/partitions"
   autoload :Roles, "milvus/roles"
   autoload :Users, "milvus/users"
+  autoload :Aliases, "milvus/aliases"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: milvus
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.10.3
 platform: ruby
 authors:
 - Andrei Bondarev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-28 00:00:00.000000000 Z
+date: 2024-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -62,6 +62,7 @@ files:
 - Rakefile
 - docker-compose.yml
 - lib/milvus.rb
+- lib/milvus/aliases.rb
 - lib/milvus/base.rb
 - lib/milvus/client.rb
 - lib/milvus/collections.rb
@@ -96,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
+rubygems_version: 3.5.20
 signing_key:
 specification_version: 4
 summary: Ruby wrapper for the Milvus vector search database API