collection cluster update operation initalized with objects

Author: hkulekci

src/Endpoints/Collections/Cluster.php

@@ -11,6 +11,7 @@
 
 use Qdrant\Endpoints\AbstractEndpoint;
 use Qdrant\Exception\InvalidArgumentException;
+use Qdrant\Models\Request\UpdateCollectionCluster;
 use Qdrant\Response;
 
 class Cluster extends AbstractEndpoint
@@ -33,13 +34,14 @@ public function info(): Response
      *
      * @throws InvalidArgumentException
      */
-    public function update(array $params, array $queryParams = []): Response
+    public function update(UpdateCollectionCluster $params, array $queryParams = []): Response
     {
         return $this->client->execute(
             $this->createRequest(
                 'POST',
                 '/collections/' . $this->getCollectionName() . '/cluster' . $this->queryBuild($queryParams),
-                $params)
+                $params->toArray()
+            )
         );
     }
 }

src/Models/Request/CollectionUpdate/AbortTransferOperation.php

@@ -0,0 +1,15 @@
+<?php
+/**
+ * @since     Mar 2023
+ * @author    Haydar KULEKCI <haydarkulekci@gmail.com>
+ */
+
+namespace Qdrant\Models\Request\CollectionUpdate;
+
+class AbortTransferOperation extends MoveShardOperation
+{
+    public function getKey(): string
+    {
+        return 'abort_transfer';
+    }
+}

src/Models/Request/CollectionUpdate/CreateShardingKeyOperation.php

@@ -0,0 +1,56 @@
+<?php
+/**
+ * @since     Mar 2023
+ * @author    Haydar KULEKCI <haydarkulekci@gmail.com>
+ */
+
+namespace Qdrant\Models\Request\CollectionUpdate;
+
+class CreateShardingKeyOperation implements Operation
+{
+    protected string $shardKey;
+    protected ?int $shardsNumber = null;
+    protected ?int $replicationFactor = null;
+    protected ?int $placement = null;
+
+    public function __construct(string $shardKey)
+    {
+        $this->shardKey = $shardKey;
+    }
+
+    public function getKey(): string
+    {
+        return 'create_sharding_key';
+    }
+
+    public function toArray(): array
+    {
+        return array_filter([
+            'shard_key' => $this->shardKey,
+            'shards_number' => $this->shardsNumber,
+            'replication_factor' => $this->replicationFactor,
+            'placement' => $this->placement,
+        ]);
+    }
+
+    public function setShardsNumber(int $shardsNumber): CreateShardingKeyOperation
+    {
+        $this->shardsNumber = $shardsNumber;
+
+        return $this;
+    }
+
+    public function setPlacement(int $placement): CreateShardingKeyOperation
+    {
+        $this->placement = $placement;
+
+        return $this;
+    }
+
+    public function setReplicationFactor(int $replicationFactor): CreateShardingKeyOperation
+    {
+        $this->replicationFactor = $replicationFactor;
+
+        return $this;
+    }
+}

src/Models/Request/CollectionUpdate/DropReplicaOperation.php

@@ -0,0 +1,28 @@
+<?php
+/**
+ * @since     Mar 2023
+ * @author    Haydar KULEKCI <haydarkulekci@gmail.com>
+ */
+
+namespace Qdrant\Models\Request\CollectionUpdate;
+
+class DropReplicaOperation implements Operation
+{
+    public function __construct(
+        protected int $shardId,
+        protected int $peerId
+    ) {}
+
+    public function toArray(): array
+    {
+        return [
+            'shard_id' => $this->shardId,
+            'peer_id' => $this->peerId,
+        ];
+    }
+
+    public function getKey(): string
+    {
+        return 'drop_replica';
+    }
+}

src/Models/Request/CollectionUpdate/DropShardingKeyOperation.php

@@ -0,0 +1,25 @@
+<?php
+/**
+ * @since     Mar 2023
+ * @author    Haydar KULEKCI <haydarkulekci@gmail.com>
+ */
+
+namespace Qdrant\Models\Request\CollectionUpdate;
+
+class DropShardingKeyOperation implements Operation
+{
+    public function __construct(protected string $shardKey)
+    {}
+
+    public function getKey(): string
+    {
+        return 'drop_sharding_key';
+    }
+
+    public function toArray(): array
+    {
+        return [
+            'shard_key' => $this->shardKey,
+        ];
+    }
+}

src/Models/Request/CollectionUpdate/MoveShardOperation.php

@@ -0,0 +1,40 @@
+<?php
+/**
+ * @since     Mar 2023
+ * @author    Haydar KULEKCI <haydarkulekci@gmail.com>
+ */
+
+namespace Qdrant\Models\Request\CollectionUpdate;
+
+class MoveShardOperation implements Operation
+{
+    protected ?string $method = null;
+
+    public function __construct(
+        protected int $shardId,
+        protected int $toPeerId,
+        protected int $fromPeerId,
+    ) {}
+
+    public function getKey(): string
+    {
+        return 'move_shard';
+    }
+
+    public function toArray(): array
+    {
+        return array_filter([
+            'shard_id' => $this->shardId,
+            'to_peer_id' => $this->toPeerId,
+            'from_peer_id' => $this->fromPeerId,
+            'method' => $this->method,
+        ]);
+    }
+
+    public function setMethod(string $method): MoveShardOperation
+    {
+        $this->method = $method;
+
+        return $this;
+    }
+}

src/Models/Request/CollectionUpdate/Operation.php

@@ -0,0 +1,15 @@
+<?php
+/**
+ * Operation
+ *
+ * @since     Oct 2023
+ * @author    Haydar KULEKCI <haydarkulekci@gmail.com>
+ */
+
+namespace Qdrant\Models\Request\CollectionUpdate;
+
+interface Operation
+{
+    public function getKey(): string;
+    public function toArray(): array;
+}

src/Models/Request/CollectionUpdate/ReplicateShardOperation.php

@@ -0,0 +1,15 @@
+<?php
+/**
+ * @since     Mar 2023
+ * @author    Haydar KULEKCI <haydarkulekci@gmail.com>
+ */
+
+namespace Qdrant\Models\Request\CollectionUpdate;
+
+class ReplicateShardOperation extends MoveShardOperation
+{
+    public function getKey(): string
+    {
+        return 'replicate_shard';
+    }
+}

src/Models/Request/UpdateCollectionCluster.php

@@ -0,0 +1,28 @@
+<?php
+/**
+ * UpdateCollectionCluster
+ *
+ * @since     Mar 2023
+ * @author    Haydar KULEKCI <haydarkulekci@gmail.com>
+ */
+
+namespace Qdrant\Models\Request;
+
+use Qdrant\Models\Request\CollectionUpdate\Operation;
+
+class UpdateCollectionCluster implements RequestModel
+{
+    /**
+     * @param Operation $operation
+     */
+    public function __construct(protected Operation $operation)
+    {
+    }
+
+    public function toArray(): array
+    {
+        return [
+            $this->operation->getKey() => $this->operation->toArray(),
+        ];
+    }
+}

tests/Integration/Endpoints/Collections/ClusterTest.php

@@ -7,6 +7,7 @@
 
 use Qdrant\Endpoints\Collections;
 use Qdrant\Exception\InvalidArgumentException;
+use Qdrant\Models\Request\CollectionUpdate\MoveShardOperation;
 use Qdrant\Tests\Integration\AbstractIntegration;
 
 class ClusterTest extends AbstractIntegration
@@ -40,13 +41,9 @@ public function testClusterUpdate(): void
         $this->createCollections('sample-collection');
         $cluster->setCollectionName('sample-collection');
 
-        $response = $cluster->update([
-            "move_shard" => [
-                "shard_id" => 0,
-                "to_peer_id" => 1,
-                "from_peer_id" => 0
-            ]
-        ]);
+        $operation = new MoveShardOperation(0, 1, 0);
+
+        $response = $cluster->update($operation);
     }
 
     protected function tearDown(): void