Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Updated docstrings #50

Merged
merged 2 commits into from
Sep 3, 2024
Merged

docs: Updated docstrings #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c899aaa
docs: Improved docstrings
Anush008 Sep 2, 2024
64eca29
fix: typos
Anush008 Sep 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion qdrant/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ func (c *Client) GetSnapshotsClient() SnapshotsClient {
return c.GetGrpcClient().Snapshots()
}

// Get the low-level client for the qdrant gRPC service.
// Get the low-level client for the Qdrant gRPC service.
// https://github.com/qdrant/qdrant/blob/master/lib/api/src/grpc/proto/qdrant.proto
func (c *Client) GetQdrantClient() QdrantClient {
return c.GetGrpcClient().Qdrant()
Expand Down
133 changes: 119 additions & 14 deletions qdrant/collections.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,15 @@ import (
"context"
)

// Check the existence of a collection.
// Checks the existence of a collection.
//
// Parameters:
// - ctx: The context for the request.
// - collectionName: The name of the collection to check.
//
// Returns:
// - bool: True if the collection exists, false otherwise.
// - error: An error if the operation fails.
func (c *Client) CollectionExists(ctx context.Context, collectionName string) (bool, error) {
resp, err := c.GetCollectionsClient().CollectionExists(ctx, &CollectionExistsRequest{
CollectionName: collectionName,
Expand All @@ -15,7 +23,15 @@ func (c *Client) CollectionExists(ctx context.Context, collectionName string) (b
return resp.GetResult().GetExists(), nil
}

// Get detailed information about specified existing collection.
// Retrieves detailed information about a specified existing collection.
//
// Parameters:
// - ctx: The context for the request.
// - collectionName: The name of the collection to retrieve information for.
//
// Returns:
// - *CollectionInfo: Detailed information about the collection.
// - error: An error if the operation fails.
func (c *Client) GetCollection(ctx context.Context, collectionName string) (*CollectionInfo, error) {
resp, err := c.GetCollectionsClient().Get(ctx, &GetCollectionInfoRequest{
CollectionName: collectionName,
Expand All @@ -26,7 +42,14 @@ func (c *Client) GetCollection(ctx context.Context, collectionName string) (*Col
return resp.GetResult(), nil
}

// Get names of all existing collections.
// Retrieves the names of all existing collections.
//
// Parameters:
// - ctx: The context for the request.
//
// Returns:
// - []string: A slice of collection names.
// - error: An error if the operation fails.
func (c *Client) ListCollections(ctx context.Context) ([]string, error) {
resp, err := c.GetCollectionsClient().List(ctx, &ListCollectionsRequest{})
if err != nil {
Expand All @@ -39,7 +62,14 @@ func (c *Client) ListCollections(ctx context.Context) ([]string, error) {
return collections, nil
}

// Create new collection with given parameters.
// Creates a new collection with the given parameters.
//
// Parameters:
// - ctx: The context for the request.
// - request: The CreateCollection request containing collection parameters.
//
// Returns:
// - error: An error if the operation fails.
func (c *Client) CreateCollection(ctx context.Context, request *CreateCollection) error {
_, err := c.GetCollectionsClient().Create(ctx, request)
if err != nil {
Expand All @@ -48,7 +78,14 @@ func (c *Client) CreateCollection(ctx context.Context, request *CreateCollection
return nil
}

// Update parameters of the existing collection.
// Updates parameters of an existing collection.
//
// Parameters:
// - ctx: The context for the request.
// - request: The UpdateCollection request containing updated parameters.
//
// Returns:
// - error: An error if the operation fails.
func (c *Client) UpdateCollection(ctx context.Context, request *UpdateCollection) error {
_, err := c.GetCollectionsClient().Update(ctx, request)
if err != nil {
Expand All @@ -57,7 +94,14 @@ func (c *Client) UpdateCollection(ctx context.Context, request *UpdateCollection
return nil
}

// Drop collection and all associated data.
// Drops a collection and all associated data.
//
// Parameters:
// - ctx: The context for the request.
// - collectionName: The name of the collection to delete.
//
// Returns:
// - error: An error if the operation fails.
func (c *Client) DeleteCollection(ctx context.Context, collectionName string) error {
_, err := c.GetCollectionsClient().Delete(ctx, &DeleteCollection{
CollectionName: collectionName,
Expand All @@ -68,7 +112,15 @@ func (c *Client) DeleteCollection(ctx context.Context, collectionName string) er
return nil
}

// Create an alias for a collection.
// Creates an alias for a collection.
//
// Parameters:
// - ctx: The context for the request.
// - aliasName: The name of the alias to create.
// - collectionName: The name of the collection to alias.
//
// Returns:
// - error: An error if the operation fails.
func (c *Client) CreateAlias(ctx context.Context, aliasName, collectionName string) error {
_, err := c.GetCollectionsClient().UpdateAliases(ctx, &ChangeAliases{
Actions: []*AliasOperations{
Expand All @@ -88,7 +140,14 @@ func (c *Client) CreateAlias(ctx context.Context, aliasName, collectionName stri
return nil
}

// Delete an alias.
// Deletes an alias.
//
// Parameters:
// - ctx: The context for the request.
// - aliasName: The name of the alias to delete.
//
// Returns:
// - error: An error if the operation fails.
func (c *Client) DeleteAlias(ctx context.Context, aliasName string) error {
_, err := c.GetCollectionsClient().UpdateAliases(ctx, &ChangeAliases{
Actions: []*AliasOperations{
Expand All @@ -107,7 +166,15 @@ func (c *Client) DeleteAlias(ctx context.Context, aliasName string) error {
return nil
}

// Rename an alias.
// Renames an alias.
//
// Parameters:
// - ctx: The context for the request.
// - oldAliasName: The current name of the alias.
// - newAliasName: The new name for the alias.
//
// Returns:
// - error: An error if the operation fails.
func (c *Client) RenameAlias(ctx context.Context, oldAliasName, newAliasName string) error {
_, err := c.GetCollectionsClient().UpdateAliases(ctx, &ChangeAliases{
Actions: []*AliasOperations{
Expand All @@ -127,7 +194,15 @@ func (c *Client) RenameAlias(ctx context.Context, oldAliasName, newAliasName str
return nil
}

// List all aliases for a collection.
// Lists all aliases for a collection.
//
// Parameters:
// - ctx: The context for the request.
// - collectionName: The name of the collection to list aliases for.
//
// Returns:
// - []string: A slice of alias names.
// - error: An error if the operation fails.
func (c *Client) ListCollectionAliases(ctx context.Context, collectionName string) ([]string, error) {
resp, err := c.GetCollectionsClient().ListCollectionAliases(ctx, &ListCollectionAliasesRequest{
CollectionName: collectionName,
Expand All @@ -142,7 +217,14 @@ func (c *Client) ListCollectionAliases(ctx context.Context, collectionName strin
return aliases, nil
}

// List all aliases.
// Lists all aliases.
//
// Parameters:
// - ctx: The context for the request.
//
// Returns:
// - []*AliasDescription: A slice of AliasDescription objects.
// - error: An error if the operation fails.
func (c *Client) ListAliases(ctx context.Context) ([]*AliasDescription, error) {
resp, err := c.GetCollectionsClient().ListAliases(ctx, &ListAliasesRequest{})
if err != nil {
Expand All @@ -151,7 +233,14 @@ func (c *Client) ListAliases(ctx context.Context) ([]*AliasDescription, error) {
return resp.GetAliases(), nil
}

// Update aliases.
// Updates aliases.
//
// Parameters:
// - ctx: The context for the request.
// - actions: A slice of AliasOperations to perform.
//
// Returns:
// - error: An error if the operation fails.
func (c *Client) UpdateAliases(ctx context.Context, actions []*AliasOperations) error {
_, err := c.GetCollectionsClient().UpdateAliases(ctx, &ChangeAliases{
Actions: actions,
Expand All @@ -162,7 +251,15 @@ func (c *Client) UpdateAliases(ctx context.Context, actions []*AliasOperations)
return nil
}

// Create a shard key for a collection.
// Creates a shard key for a collection.
//
// Parameters:
// - ctx: The context for the request.
// - collectionName: The name of the collection to create a shard key for.
// - request: The CreateShardKey request containing shard key parameters.
//
// Returns:
// - error: An error if the operation fails.
func (c *Client) CreateShardKey(ctx context.Context, collectionName string, request *CreateShardKey) error {
_, err := c.GetCollectionsClient().CreateShardKey(ctx, &CreateShardKeyRequest{
CollectionName: collectionName,
Expand All @@ -174,7 +271,15 @@ func (c *Client) CreateShardKey(ctx context.Context, collectionName string, requ
return nil
}

// Delete a shard key for a collection.
// Deletes a shard key for a collection.
//
// Parameters:
// - ctx: The context for the request.
// - collectionName: The name of the collection to delete a shard key from.
// - request: The DeleteShardKey request containing shard key parameters.
//
// Returns:
// - error: An error if the operation fails.
func (c *Client) DeleteShardKey(ctx context.Context, collectionName string, request *DeleteShardKey) error {
_, err := c.GetCollectionsClient().DeleteShardKey(ctx, &DeleteShardKeyRequest{
CollectionName: collectionName,
Expand Down
Loading