collection

Documentation

Index

• type Client
  • func NewClient(opts ...option.RequestOption) *Client
  • func (c *Client) Create(ctx context.Context, collectionName string, ...) (string, error)
  • func (c *Client) CreateIndex(ctx context.Context, collectionName string, ...) (string, error)
  • func (c *Client) Delete(ctx context.Context, collectionName string, opts ...option.RequestOption) (string, error)
  • func (c *Client) Get(ctx context.Context, collectionName string, opts ...option.RequestOption) (*zepgo.DocumentCollectionResponse, error)
  • func (c *Client) List(ctx context.Context, opts ...option.RequestOption) ([][]*zepgo.DocumentCollectionResponse, error)
  • func (c *Client) Update(ctx context.Context, collectionName string, ...) (string, error)

Types

type Client

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

func NewClient

func NewClient(opts ...option.RequestOption) *Client

func (*Client) Create

func (c *Client) Create(
	ctx context.Context,

	collectionName string,
	request *zepgo.CreateDocumentCollectionRequest,
	opts ...option.RequestOption,
) (string, error)

If a collection with the same name already exists, an error will be returned.

func (*Client) CreateIndex

func (c *Client) CreateIndex(
	ctx context.Context,

	collectionName string,
	request *zepgo.CollectionCreateIndexRequest,
	opts ...option.RequestOption,
) (string, error)

Creates an index for the specified DocumentCollection to improve query performance.

func (*Client) Delete

func (c *Client) Delete(
	ctx context.Context,

	collectionName string,
	opts ...option.RequestOption,
) (string, error)

If a collection with the same name already exists, it will be overwritten.

func (*Client) Get

func (c *Client) Get(
	ctx context.Context,

	collectionName string,
	opts ...option.RequestOption,
) (*zepgo.DocumentCollectionResponse, error)

Returns a DocumentCollection if it exists.

func (*Client) List

func (c *Client) List(
	ctx context.Context,
	opts ...option.RequestOption,
) ([][]*zepgo.DocumentCollectionResponse, error)

Returns a list of all DocumentCollections.

func (*Client) Update

func (c *Client) Update(
	ctx context.Context,

	collectionName string,
	request *zepgo.UpdateDocumentCollectionRequest,
	opts ...option.RequestOption,
) (string, error)