features

type AllDocsPagerOptions ¶ added in v0.10.4

type AllDocsPagerOptions interface {
	*cloudantv1.PostAllDocsOptions | *cloudantv1.PostPartitionAllDocsOptions
}

AllDocsPagerOptions defines options for paginating through all documents or partitioned all documents in a Cloudant database.

type ChangesFollower ¶

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

ChangesFollower is a helper for using the changes feed.

There are two modes of operation:

StartOneOff() to fetch the changes from the supplied since sequence
until there are no further pending changes.
Start() to fetch the changes from the supplied since sequence
and then continuing to listen indefinitely for further new changes.

The starting sequence ID can be changed for either mode by using "Since". By default when using:

StartOneOff() the feed will start from the beginning.
Start() the feed will start from "now".

In either mode the response stream can be terminated early by calling Stop(). By default ChangesFollower will suppress transient errors indefinitely and endeavour to run to completion or listen forever. For applications where that behaviour is not desirable an alternate option is available where a duration may be specified to limit the time since the last successful response that transient errors will be suppressed. It should be noted that some errors considered terminal, for example, the database not existing or invalid credentials are never suppressed and will return an Error immediately. The named attributes for "PostChangesOptions" are used to configure the behaviour of the ChangesFollower. However, a subset of the attributes are invalid as they are configured internally by the implementation and will cause an Error to be returned if supplied. These invalid options are:

• Descending
• Feed
• Heartbeat
• LastEventID
• Timeout

Only the value of "_selector" is permitted for the PostChangesOptions's "Filter" option. Selector based filters perform better than JS based filters and using one of the alternative JS based filter types will cause ChangesFollower to return an Error. It should also be noted that the "Limit" parameter will truncate the response at the given number of changes in either operating mode. The ChangesFollower requires the Cloudant client to have HTTP timeout of at least 1 minute. The default client configuration has a sufficiently long timeout.

func NewChangesFollower(c *cloudantv1.CloudantV1, o *cloudantv1.PostChangesOptions) (*ChangesFollower, error)

func NewChangesFollowerWithContext(ctx context.Context, c *cloudantv1.CloudantV1, o *cloudantv1.PostChangesOptions) (*ChangesFollower, error)

func (cf *ChangesFollower) SetErrorTolerance(d time.Duration) error

func (cf *ChangesFollower) Start() (<-chan ChangesItem, error)

func (cf *ChangesFollower) StartOneOff() (<-chan ChangesItem, error)

func (cf *ChangesFollower) Stop()

type ChangesItem ¶

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

ChangesItem is a wrapper structure around cloudantv1.ChangesResultItem with addtitional attribute Error for errors received during the run.

func (ci ChangesItem) Item() (cloudantv1.ChangesResultItem, error)

type DesignDocsPagerOptions ¶ added in v0.10.4

type DesignDocsPagerOptions interface {
	*cloudantv1.PostDesignDocsOptions
}

DesignDocsPagerOptions defines options for paginating through design documents in a Cloudant database.

type FindPagerOptions ¶ added in v0.10.4

type FindPagerOptions interface {
	*cloudantv1.PostFindOptions | *cloudantv1.PostPartitionFindOptions
}

FindPagerOptions defines options for paginating through queries or partitioned queries in a Cloudant database.

type Mode ¶

type Mode int

Mode are enums for changes follower's operation mode.

const (
	// Finite mode is an alias for StartOneOff()
	Finite Mode = iota
	// Listen mode is an alias for Start()
	Listen
)

type Pager ¶ added in v0.10.4

type Pager[T PaginatedRow] interface {
	// HasNext returns false if there are no more pages.
	HasNext() bool

	// GetNext retrieves the next page of results.
	GetNext() ([]T, error)

	// GetNextWithContext retrieves the next page of results with user provided context.
	GetNextWithContext(context.Context) ([]T, error)

	// GetAll retrieves all elements from the pager.
	GetAll() ([]T, error)

	// GetAllWithContext retrieves all the elements from the pager with user provided context.
	GetAllWithContext(context.Context) ([]T, error)
}

Pager is an interface for pagination of Cloudant query operations.

type PaginatedRow ¶ added in v0.10.4

type PaginatedRow interface {
	cloudantv1.DocsResultRow | cloudantv1.ViewResultRow | cloudantv1.Document | cloudantv1.SearchResultRow
}

PaginatedRow defines a response object for Pager operations

type Pagination ¶ added in v0.10.4

type Pagination[T PaginatedRow] interface {
	// Pager returns new Pager.
	Pager() (Pager[T], error)

	// Pages returns an iterator for all pages from the pager.
	Pages() iter.Seq2[[]T, error]

	// PagesWithContext returns an iterator for all pages from the pager queried with user provided context.
	PagesWithContext(context.Context) iter.Seq2[[]T, error]

	// Rows returns an iterator for all elements from the pager.
	Rows() iter.Seq2[T, error]

	// RowsWithContext returns an iterator for all elements from the pager queried with user provided context.
	RowsWithContext(context.Context) iter.Seq2[T, error]
}

func NewAllDocsPagination[O AllDocsPagerOptions](c *cloudantv1.CloudantV1, o O) Pagination[cloudantv1.DocsResultRow]

func NewDesignDocsPagination[O DesignDocsPagerOptions](c *cloudantv1.CloudantV1, o O) Pagination[cloudantv1.DocsResultRow]

func NewFindPagination[O FindPagerOptions](c *cloudantv1.CloudantV1, o O) Pagination[cloudantv1.Document]

func NewSearchPagination[O SearchPagerOptions](c *cloudantv1.CloudantV1, o O) Pagination[cloudantv1.SearchResultRow]

func NewViewPagination[O ViewPagerOptions](c *cloudantv1.CloudantV1, o O) Pagination[cloudantv1.ViewResultRow]

type SearchPagerOptions ¶ added in v0.10.4

type SearchPagerOptions interface {
	*cloudantv1.PostSearchOptions | *cloudantv1.PostPartitionSearchOptions
}

SearchPagerOptions defines options for paginating through searches or partitioned searches in a Cloudant database.

type TransientErrorSuppression ¶

type TransientErrorSuppression int

TransientErrorSuppression are enums for changes follower's transient errors suppression mode.

const (
	// Always suppress transient errors
	Always TransientErrorSuppression = iota
	// Never suppress transient errors
	Never
	// Timer specifies a time duration for suppressing transient errors
	Timer
)

type ViewPagerOptions ¶ added in v0.10.4

type ViewPagerOptions interface {
	*cloudantv1.PostViewOptions | *cloudantv1.PostPartitionViewOptions
}

ViewPagerOptions defines options for paginating through views or partitioned views in a Cloudant database.