document

Documentation

Index

• type Client
  • func NewClient(opts ...option.RequestOption) *Client
  • func (c *Client) BatchDelete(ctx context.Context, collectionName string, request []string, ...) (string, error)
  • func (c *Client) BatchGet(ctx context.Context, collectionName string, ...) ([][]*zepgo.DocumentResponse, error)
  • func (c *Client) BatchUpdate(ctx context.Context, collectionName string, ...) (string, error)
  • func (c *Client) CreateMultiple(ctx context.Context, collectionName string, ...) ([]string, error)
  • func (c *Client) Delete(ctx context.Context, collectionName string, documentUUID string, ...) (string, error)
  • func (c *Client) Get(ctx context.Context, collectionName string, documentUUID string, ...) (*zepgo.DocumentResponse, error)
  • func (c *Client) Search(ctx context.Context, collectionName string, ...) (*zepgo.DocumentSearchResultPage, error)
  • func (c *Client) Update(ctx context.Context, collectionName string, documentUUID string, ...) (string, error)

Types

type Client

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

func NewClient

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

func (*Client) BatchDelete

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

	collectionName string,
	request []string,
	opts ...option.RequestOption,
) (string, error)

Deletes specified Documents from a DocumentCollection.

func (*Client) BatchGet

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

	collectionName string,
	request *zepgo.GetDocumentListRequest,
	opts ...option.RequestOption,
) ([][]*zepgo.DocumentResponse, error)

Returns Documents from a DocumentCollection specified by UUID or ID.

func (*Client) BatchUpdate

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

	collectionName string,
	request []*zepgo.UpdateDocumentListRequest,
	opts ...option.RequestOption,
) (string, error)

Updates Documents in a specified DocumentCollection.

func (*Client) CreateMultiple

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

	collectionName string,
	request []*zepgo.CreateDocumentRequest,
	opts ...option.RequestOption,
) ([]string, error)

Creates Documents in a specified DocumentCollection and returns their UUIDs.

func (*Client) Delete

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

	collectionName string,

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

Delete specified Document from a DocumentCollection.

func (*Client) Get

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

	collectionName string,

	documentUUID string,
	opts ...option.RequestOption,
) (*zepgo.DocumentResponse, error)

Returns specified Document from a DocumentCollection.

func (*Client) Search

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

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

Searches Documents in a DocumentCollection based on provided search criteria.

func (*Client) Update

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

	collectionName string,

	documentUUID string,
	request *zepgo.UpdateDocumentRequest,
	opts ...option.RequestOption,
) (string, error)