collections

package
v0.0.35 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 25, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(opts ...core.ClientOption) *Client

func (*Client) CollectionClusterInfo

func (c *Client) CollectionClusterInfo(ctx context.Context, collectionName string) (*hookdeckgosdk.CollectionClusterInfoResponse, error)

Get cluster information for a collection

Name of the collection to retrieve the cluster info for

func (*Client) CreateCollection

func (c *Client) CreateCollection(ctx context.Context, collectionName string, request *hookdeckgosdk.CreateCollection) (*hookdeckgosdk.CreateCollectionResponse, error)

Create new collection with given parameters

Name of the new collection

func (*Client) CreateFieldIndex

func (c *Client) CreateFieldIndex(ctx context.Context, collectionName string, request *hookdeckgosdk.CreateFieldIndex) (*hookdeckgosdk.CreateFieldIndexResponse, error)

Create index for field in collection

Name of the collection

func (*Client) CreateShardKey

func (c *Client) CreateShardKey(ctx context.Context, collectionName string, request *hookdeckgosdk.CreateShardKeyRequest) (*hookdeckgosdk.CreateShardKeyResponse, error)

Name of the collection to create shards for

func (*Client) DeleteCollection

func (c *Client) DeleteCollection(ctx context.Context, collectionName string, request *hookdeckgosdk.DeleteCollectionRequest) (*hookdeckgosdk.DeleteCollectionResponse, error)

Drop collection and all associated data

Name of the collection to delete

func (*Client) DeleteFieldIndex

func (c *Client) DeleteFieldIndex(ctx context.Context, collectionName string, fieldName string, request *hookdeckgosdk.DeleteFieldIndexRequest) (*hookdeckgosdk.DeleteFieldIndexResponse, error)

Delete field index for collection

Name of the collection Name of the field where to delete the index

func (*Client) DeleteShardKey

func (c *Client) DeleteShardKey(ctx context.Context, collectionName string, request *hookdeckgosdk.DeleteShardKeyRequest) (*hookdeckgosdk.DeleteShardKeyResponse, error)

Name of the collection to create shards for

func (*Client) GetCollection

func (c *Client) GetCollection(ctx context.Context, collectionName string) (*hookdeckgosdk.GetCollectionResponse, error)

Get detailed information about specified existing collection

Name of the collection to retrieve

func (*Client) GetCollectionAliases

func (c *Client) GetCollectionAliases(ctx context.Context, collectionName string) (*hookdeckgosdk.GetCollectionAliasesResponse, error)

Get list of all aliases for a collection

Name of the collection

func (*Client) GetCollections

func (c *Client) GetCollections(ctx context.Context) (*hookdeckgosdk.GetCollectionsResponse, error)

Get list name of all existing collections

func (*Client) GetCollectionsAliases

func (c *Client) GetCollectionsAliases(ctx context.Context) (*hookdeckgosdk.GetCollectionsAliasesResponse, error)

Get list of all existing collections aliases

func (*Client) UpdateCollection

func (c *Client) UpdateCollection(ctx context.Context, collectionName string, request *hookdeckgosdk.UpdateCollection) (*hookdeckgosdk.UpdateCollectionResponse, error)

Update parameters of the existing collection

Name of the collection to update

func (*Client) UpdateCollectionCluster

func (c *Client) UpdateCollectionCluster(ctx context.Context, collectionName string, request *hookdeckgosdk.UpdateCollectionClusterRequest) (*hookdeckgosdk.UpdateCollectionClusterResponse, error)

Name of the collection on which to to apply the cluster update operation

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL