Merge pull request #1994 from qdrant/tiered-multitenancy

[v1.16] tiered multitenancy

qdrant-landing/content/documentation/headless/snippets/insert-points/with-custom-shard/_description.md

@@ -0,0 +1 @@
+This code snippet demonstrates how to insert point into Qdrant collection with custom sharding enabled. Request have an additional parameter, `shard_key`, which specifies routing information for the point being inserted.

qdrant-landing/content/documentation/headless/snippets/insert-points/with-custom-shard/csharp.md

@@ -0,0 +1,15 @@
+```csharp
+using Qdrant.Client;
+using Qdrant.Client.Grpc;
+
+var client = new QdrantClient("localhost", 6334);
+
+await client.UpsertAsync(
+	collectionName: "{collection_name}",
+	points: new List<PointStruct>
+	{
+		new() { Id = 111, Vectors = new[] { 0.1f, 0.2f, 0.3f } }
+	},
+	shardKeySelector: new ShardKeySelector { ShardKeys = { new List<ShardKey> { "user_1" } } }
+);
+```

qdrant-landing/content/documentation/headless/snippets/insert-points/with-custom-shard/go.md

@@ -0,0 +1,27 @@
+```go
+import (
+	"context"
+
+	"github.com/qdrant/go-client/qdrant"
+)
+
+client, err := qdrant.NewClient(&qdrant.Config{
+	Host: "localhost",
+	Port: 6334,
+})
+
+client.Upsert(context.Background(), &qdrant.UpsertPoints{
+	CollectionName: "{collection_name}",
+	Points: []*qdrant.PointStruct{
+		{
+			Id:      qdrant.NewIDNum(111),
+			Vectors: qdrant.NewVectors(0.1, 0.2, 0.3),
+		},
+	},
+	ShardKeySelector: &qdrant.ShardKeySelector{
+		ShardKeys: []*qdrant.ShardKey{
+			qdrant.NewShardKey("user_1"),
+		},
+	},
+})
+```

qdrant-landing/content/documentation/headless/snippets/insert-points/with-custom-shard/http.md

@@ -0,0 +1,12 @@
+```http
+PUT /collections/{collection_name}/points
+{
+    "points": [
+        {
+            "id": 1111,
+            "vector": [0.1, 0.2, 0.3]
+        },
+    ]
+    "shard_key": "user_1"
+}
+```

qdrant-landing/content/documentation/headless/snippets/insert-points/with-custom-shard/java.md

@@ -0,0 +1,30 @@
+```java
+import java.util.List;
+
+import static io.qdrant.client.PointIdFactory.id;
+import static io.qdrant.client.ShardKeySelectorFactory.shardKeySelector;
+import static io.qdrant.client.VectorsFactory.vectors;
+
+import io.qdrant.client.QdrantClient;
+import io.qdrant.client.QdrantGrpcClient;
+import io.qdrant.client.grpc.Points.PointStruct;
+import io.qdrant.client.grpc.Points.UpsertPoints;
+
+QdrantClient client =
+    new QdrantClient(QdrantGrpcClient.newBuilder("localhost", 6334, false).build());
+
+client
+    .upsertAsync(
+        UpsertPoints.newBuilder()
+            .setCollectionName("{collection_name}")
+            .addAllPoints(
+                List.of(
+                    PointStruct.newBuilder()
+                        .setId(id(111))
+                        .setVectors(vectors(0.1f, 0.2f, 0.3f))
+                        .build()))
+            .setShardKeySelector(shardKeySelector("user_1"))
+            .build()
+    )
+    .get();
+```

qdrant-landing/content/documentation/headless/snippets/insert-points/with-custom-shard/python.md

@@ -0,0 +1,16 @@
+```python
+from qdrant_client import QdrantClient, models
+
+client = QdrantClient(url="http://localhost:6333")
+
+client.upsert(
+    collection_name="{collection_name}",
+    points=[
+        models.PointStruct(
+            id=1111,
+            vector=[0.1, 0.2, 0.3],
+        ),
+    ],
+    shard_key_selector="user_1",
+)
+```

qdrant-landing/content/documentation/headless/snippets/insert-points/with-custom-shard/rust.md

@@ -0,0 +1,18 @@
+```rust
+use qdrant_client::qdrant::{PointStruct, UpsertPointsBuilder};
+use qdrant_client::Payload;
+
+client
+    .upsert_points(
+        UpsertPointsBuilder::new(
+            "{collection_name}",
+            vec![PointStruct::new(
+                111,
+                vec![0.1, 0.2, 0.3],
+                Payload::default(),
+            )],
+        )
+        .shard_key_selector("user_1".to_string()),
+    )
+    .await?;
+```

qdrant-landing/content/documentation/headless/snippets/insert-points/with-custom-shard/typescript.md

@@ -0,0 +1,15 @@
+```typescript
+import { QdrantClient } from "@qdrant/js-client-rest";
+
+const client = new QdrantClient({ host: "localhost", port: 6333 });
+
+client.upsert("{collection_name}", {
+    points: [
+        {
+            id: 1111,
+            vector: [0.1, 0.2, 0.3],
+        },
+    ],
+    shard_key: "user_1",
+});
+```

qdrant-landing/content/documentation/headless/snippets/insert-points/with-tenant-group-id-and-fallback-shard-key/_description.md

@@ -0,0 +1,2 @@
+This code snippet is for a PUT request to insert points into a collection, where each point has an ID, a payload containing a group ID, and a vector. The code illustrates partitioning vectors by user to ensure that each user can only access their own vectors. It emphasizes adding a `group_id` field to each vector in the collection, facilitating user-specific data access control. Additionally, it suggests using an appropriate naming convention for the key in the payload for flexibility in data structures.
+In addition, the snippet includes a shard key selector, allowing a dymamic routing between shared and dedicated shards based on the existance of `target` shard in the collection.

qdrant-landing/content/documentation/headless/snippets/insert-points/with-tenant-group-id-and-fallback-shard-key/csharp.md

@@ -0,0 +1,23 @@
+```csharp
+using Qdrant.Client;
+using Qdrant.Client.Grpc;
+
+var client = new QdrantClient("localhost", 6334);
+
+await client.UpsertAsync(
+	collectionName: "{collection_name}",
+	points: new List<PointStruct>
+	{
+		new()
+		{
+			Id = 1,
+			Vectors = new[] { 0.9f, 0.1f, 0.1f },
+			Payload = { ["group_id"] = "user_1" }
+		}
+	},
+	shardKeySelector: new ShardKeySelector { 
+		ShardKeys = { new List<ShardKey> { "user_1" } },
+		Fallback = new ShardKey { Keyword = "default" }
+	}
+);
+```

qdrant-landing/content/documentation/headless/snippets/insert-points/with-tenant-group-id-and-fallback-shard-key/go.md

@@ -0,0 +1,29 @@
+```go
+import (
+	"context"
+
+	"github.com/qdrant/go-client/qdrant"
+)
+
+client, err := qdrant.NewClient(&qdrant.Config{
+	Host: "localhost",
+	Port: 6334,
+})
+
+client.Upsert(context.Background(), &qdrant.UpsertPoints{
+	CollectionName: "{collection_name}",
+	Points: []*qdrant.PointStruct{
+		{
+			Id:      qdrant.NewIDNum(1),
+			Vectors: qdrant.NewVectors(0.9, 0.1, 0.1),
+			Payload: qdrant.NewValueMap(map[string]any{"group_id": "user_1"}),
+		}
+	},
+	ShardKeySelector: &qdrant.ShardKeySelector{
+		ShardKeys: []*qdrant.ShardKey{
+			qdrant.NewShardKey("user_1"),
+		},
+		Fallback: qdrant.NewShardKey("default"),
+	},
+})
+```

qdrant-landing/content/documentation/headless/snippets/insert-points/with-tenant-group-id-and-fallback-shard-key/http.md

@@ -0,0 +1,16 @@
+```http
+PUT /collections/{collection_name}/points
+{
+    "points": [
+        {
+            "id": 1,
+            "payload": {"group_id": "user_1"},
+            "vector": [0.9, 0.1, 0.1]
+        }
+    ],
+    "shard_key": {
+        "fallback": "default",
+        "target": "user_1"
+    }
+}
+```

qdrant-landing/content/documentation/headless/snippets/insert-points/with-tenant-group-id-and-fallback-shard-key/java.md

@@ -0,0 +1,34 @@
+```java
+import java.util.List;
+import java.util.Map;
+
+import static io.qdrant.client.ShardKeyFactory.shardKey;
+
+import io.qdrant.client.QdrantClient;
+import io.qdrant.client.QdrantGrpcClient;
+import io.qdrant.client.grpc.Points.PointStruct;
+
+import io.qdrant.client.grpc.Points.ShardKeySelector;
+
+QdrantClient client =
+    new QdrantClient(QdrantGrpcClient.newBuilder("localhost", 6334, false).build());
+
+client
+    .upsertAsync(
+        UpsertPoints.newBuilder()
+            .setCollectionName("{collection_name}")
+            .addAllPoints(
+                List.of(
+                    PointStruct.newBuilder()
+                        .setId(id(1))
+                        .setVectors(vectors(0.9f, 0.1f, 0.1f))
+                        .putAllPayload(Map.of("group_id", value("user_1")))
+                        .build()))
+            .setShardKeySelector(
+                ShardKeySelector.newBuilder()
+                    .addShardKeys(shardKey("user_1"))
+                    .setFallback(shardKey("default"))
+                    .build())
+            .build())
+    .get();
+```

qdrant-landing/content/documentation/headless/snippets/insert-points/with-tenant-group-id-and-fallback-shard-key/python.md

@@ -0,0 +1,16 @@
+```python
+client.upsert(
+    collection_name="{collection_name}",
+    points=[
+        models.PointStruct(
+            id=1,
+            payload={"group_id": "user_1"},
+            vector=[0.9, 0.1, 0.1],
+        ),
+    ],
+    shard_key_selector=models.ShardKeyWithFallback(
+        target="user_1",
+        fallback="default"
+    )
+)
+```

qdrant-landing/content/documentation/headless/snippets/insert-points/with-tenant-group-id-and-fallback-shard-key/rust.md

@@ -0,0 +1,26 @@
+```rust
+use qdrant_client::qdrant::{PointStruct, UpsertPointsBuilder};
+use qdrant_client::Qdrant;
+
+let client = Qdrant::from_url("http://localhost:6334").build()?;
+
+let shard_key_selector = ShardKeySelectorBuilder::with_shard_key("user_1")
+    .fallback("default")
+    .build();
+
+client
+    .upsert_points(
+        UpsertPointsBuilder::new(
+            "{collection_name}",
+            vec![
+                PointStruct::new(
+                    1,
+                    vec![0.9, 0.1, 0.1],
+                    [("group_id", "user_1".into())]
+                ),
+            ],
+        )
+        .shard_key_selector(shard_key_selector),
+    )
+    .await?;
+```

qdrant-landing/content/documentation/headless/snippets/insert-points/with-tenant-group-id-and-fallback-shard-key/typescript.md

@@ -0,0 +1,19 @@
+```typescript
+import { QdrantClient } from "@qdrant/js-client-rest";
+
+const client = new QdrantClient({ host: "localhost", port: 6333 });
+
+client.upsert("{collection_name}", {
+  points: [
+    {
+      id: 1,
+      payload: { group_id: "user_1" },
+      vector: [0.9, 0.1, 0.1],
+    }
+  ],
+  shard_key: {
+    target: "user_1",
+    fallback: "default"
+  }
+});
+```