milvus 0.10.1 → 0.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a4dd23dd2d85a1a231214808ee57ece287c47fde46084f726831dc47e7aaed7
-  data.tar.gz: 52bca3e02f864a52c5c85c9f1aa725a16641fedaafb4b5ed8a7c6964664b9fe8
+  metadata.gz: 914040de2cf35a3985d67dbd19de618e00d82262b61220df8bbf517cee40f72f
+  data.tar.gz: d88ca74f1a6674cefadd0d790b3a3c828da1f2e585a2cd9b4d3fa9dca492115a
 SHA512:
-  metadata.gz: 3c60bf9de09afaebc7cf0382529b07440680f50ed5f94c8ededb416f8cf29ddbaa7183527235c5daa12ce37412ca9b2b822e0b871d70fb67101ab291eb62c305
-  data.tar.gz: 7b5b2b34f19ee53b33e025f6e9c170584fcf4b86c647e79c6acf519b0a3560e3b68f02fbcc60bdaafd27e41165704cf07dfdc1f4a52ddee198327ca7f8cd0278
+  metadata.gz: 5092e0ec3696ce6d8e8a7a9d8df199f32f9ef4172f3aa65e0d415312da019c47763beef7df1e4714e3adee53f806f0bfd79f35e99884d8df8abb5745755f73a1
+  data.tar.gz: 9580e92290a0a3f132b39629ff4bc25ef759b7b2d608cf744218bd529e9e54ac328194584db757af76b56f03790793468e9e6b6bebadc173301403fb17fc52bc

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [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
+- Added docker-compose.yml with directions to run Milvus in Docker
+
 ## [0.10.1] - 2024-07-04 🇺🇸
 - Fixes and improvements to the gem.
 

data/Gemfile.lock

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

data/README.md

@@ -267,12 +267,83 @@ client.partitions.drop(
 )
 ```
 
+### Roles
+```ruby
+# List roles available on the server
+client.roles.list
+```
+```ruby
+# Describe the role
+client.roles.describe(role_name: 'public')
+```
+
+### Users
+```ruby
+# Create new user
+client.users.create(user_name: 'user_name', password: 'password')
+```
+```ruby
+# List of roles assigned to the user
+client.users.describe(user_name: 'user_name')
+```
+```ruby
+# List all users in the specified database.
+client.users.list
+```
+```ruby
+# Drop existing user
+client.users.drop(user_name: 'user_name')
+```
+```ruby
+# Update password for the user
+client.users.update_password(user_name: 'user_name', password: 'old_password', new_password: 'new_password')
+```
+```ruby
+# Grant role to the user
+client.users.grant_role(user_name: 'user_name', role_name: 'admin')
+```
+```ruby
+# 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
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+## 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 Milvus services and gem's code.
+
+For example inside docker container run `bin/console` and inside the ruby console:
+```ruby
+client = Milvus::Client.new(url: ENV["MILVUS_URL"])
+client.collections.list
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/patterns-ai-core/milvus.

data/docker-compose.yml

@@ -0,0 +1,77 @@
+services:
+  ruby_app:
+    image: ruby:bullseye
+    working_dir: /usr/src/app
+    volumes:
+      - .:/usr/src/app
+      - bundle:/usr/local/bundle
+    depends_on:
+      - standalone
+    environment:
+      MILVUS_URL: "http://standalone:19530"
+
+  etcd:
+    container_name: milvus-etcd
+    image: quay.io/coreos/etcd:v3.5.5
+    environment:
+      - ETCD_AUTO_COMPACTION_MODE=revision
+      - ETCD_AUTO_COMPACTION_RETENTION=1000
+      - ETCD_QUOTA_BACKEND_BYTES=4294967296
+      - ETCD_SNAPSHOT_COUNT=50000
+    volumes:
+      - ${DOCKER_VOLUME_DIRECTORY:-.}/volumes/etcd:/etcd
+    command: etcd -advertise-client-urls=http://127.0.0.1:2379 -listen-client-urls http://0.0.0.0:2379 --data-dir /etcd
+    healthcheck:
+      test: ["CMD", "etcdctl", "endpoint", "health"]
+      interval: 30s
+      timeout: 20s
+      retries: 3
+
+  minio:
+    container_name: milvus-minio
+    image: minio/minio:RELEASE.2023-03-20T20-16-18Z
+    environment:
+      MINIO_ACCESS_KEY: minioadmin
+      MINIO_SECRET_KEY: minioadmin
+    ports:
+      - "9001:9001"
+      - "9000:9000"
+    volumes:
+      - ${DOCKER_VOLUME_DIRECTORY:-.}/volumes/minio:/minio_data
+    command: minio server /minio_data --console-address ":9001"
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:9000/minio/health/live"]
+      interval: 30s
+      timeout: 20s
+      retries: 3
+
+  standalone:
+    container_name: milvus-standalone
+    image: milvusdb/milvus:v2.4.5
+    command: ["milvus", "run", "standalone"]
+    security_opt:
+      - seccomp:unconfined
+    environment:
+      ETCD_ENDPOINTS: etcd:2379
+      MINIO_ADDRESS: minio:9000
+    volumes:
+      - ${DOCKER_VOLUME_DIRECTORY:-.}/volumes/milvus:/var/lib/milvus
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:9091/healthz"]
+      interval: 30s
+      start_period: 90s
+      timeout: 20s
+      retries: 3
+    ports:
+      - "19530:19530"
+      - "9091:9091"
+    depends_on:
+      - "etcd"
+      - "minio"
+
+networks:
+  default:
+    name: milvus
+
+volumes:
+  bundle:

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
@@ -29,14 +38,28 @@ module Milvus
       @indexes ||= Milvus::Indexes.new(client: self)
     end
 
+    def roles
+      @roles ||= Milvus::Roles.new(client: self)
+    end
+
+    def users
+      @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/roles.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Milvus
+  class Roles < Base
+    PATH = "roles"
+
+    # 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
+
+    # This operation inserts data into a specific collection.
+    #
+    # @param role_name [String] The name of the collection to insert data into.
+    # @return [Hash] The response from the server.
+    def describe(role_name:)
+      response = client.connection.post("#{PATH}/describe") do |req|
+        req.body = {
+          roleName: role_name
+        }
+      end
+
+      response.body
+    end
+  end
+end

data/lib/milvus/users.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Milvus
+  class Users < Base
+    PATH = "users"
+
+    # Create a user
+    #
+    # @param user_name [String] Username for the user
+    # @param password [String] Password for the user
+    # @return [Hash] Server response
+    def create(user_name:, password:)
+      response = client.connection.post("#{PATH}/create") do |req|
+        req.body = {
+          userName: user_name,
+          password: password
+        }
+      end
+
+      response.body
+    end
+
+    # Describe a user
+    #
+    # @param user_name [String] Username for the user
+    # @return [Hash] Server response
+    def describe(user_name:)
+      response = client.connection.post("#{PATH}/describe") do |req|
+        req.body = {
+          userName: user_name
+        }
+      end
+
+      response.body
+    end
+
+    # List users
+    #
+    # @return [Hash] Server response
+    def list
+      response = client.connection.post("#{PATH}/list") do |req|
+        req.body = {}
+      end
+
+      response.body
+    end
+
+    # Drops a user
+    #
+    # @param user_name [String] Username for the user
+    # @return [Hash] Server response
+    def drop(user_name:)
+      response = client.connection.post("#{PATH}/drop") do |req|
+        req.body = {
+          userName: user_name
+        }
+      end
+
+      response.body
+    end
+
+    def update_password(user_name:, password:, new_password:)
+      response = client.connection.post("#{PATH}/update_password") do |req|
+        req.body = {
+          userName: user_name,
+          password: password,
+          newPassword: new_password
+        }
+      end
+
+      response.body
+    end
+
+    def grant_role(user_name:, role_name:)
+      response = client.connection.post("#{PATH}/grant_role") do |req|
+        req.body = {
+          userName: user_name,
+          roleName: role_name
+        }
+      end
+
+      response.body
+    end
+
+    def revoke_role(user_name:, role_name:)
+      response = client.connection.post("#{PATH}/revoke_role") do |req|
+        req.body = {
+          userName: user_name,
+          roleName: role_name
+        }
+      end
+
+      response.body
+    end
+  end
+end

data/lib/milvus/version.rb

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

data/lib/milvus.rb

@@ -11,4 +11,7 @@ module Milvus
   autoload :Entities, "milvus/entities"
   autoload :Indexes, "milvus/indexes"
   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.1
+  version: 0.10.3
 platform: ruby
 authors:
 - Andrei Bondarev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-04 00:00:00.000000000 Z
+date: 2024-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -60,7 +60,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- docker-compose.yml
 - lib/milvus.rb
+- lib/milvus/aliases.rb
 - lib/milvus/base.rb
 - lib/milvus/client.rb
 - lib/milvus/collections.rb
@@ -69,6 +71,8 @@ files:
 - lib/milvus/error.rb
 - lib/milvus/indexes.rb
 - lib/milvus/partitions.rb
+- lib/milvus/roles.rb
+- lib/milvus/users.rb
 - lib/milvus/version.rb
 - sig/milvus.rbs
 homepage: https://github.com/andreibondarev/milvus
@@ -93,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