wait

Documentation

Index

• func ResourceHasState[T fmt.Stringer](ctx context.Context, validStates, badStates []T, ...) retry.CheckFn
• func ResourceIsAvailable(ctx context.Context, fn func(ctx context.Context) error) retry.CheckFn
• func ResourceIsGone(ctx context.Context, fn func(ctx context.Context) error) retry.CheckFn
• type ResourceGetter
• type Waiter
  • func New(rs ResourceGetter) *Waiter
  • func (w *Waiter) UntilAliasAvailable(ctx context.Context, workspace, alias string) error
  • func (w *Waiter) UntilAliasGone(ctx context.Context, workspace, alias string) error
  • func (w *Waiter) UntilCollectionGone(ctx context.Context, workspace, name string) error
  • func (w *Waiter) UntilCollectionHasDocuments(ctx context.Context, workspace, name string, count int64) error
  • func (w *Waiter) UntilCollectionHasNewDocuments(ctx context.Context, workspace, name string, count int64) error
  • func (w *Waiter) UntilCollectionReady(ctx context.Context, workspace, name string) error
  • func (w *Waiter) UntilKafkaIntegrationActive(ctx context.Context, integration string) error
  • func (w *Waiter) UntilMountActive(ctx context.Context, vID, workspace, collection string) error
  • func (w *Waiter) UntilMountGone(ctx context.Context, vID, workspace, collection string) error
  • func (w *Waiter) UntilQueryDone(ctx context.Context, queryID string) error
  • func (w *Waiter) UntilQueryLambdaTagPropagated(ctx context.Context, workspace, name, tag string) error
  • func (w *Waiter) UntilQueryLambdaVersionActive(ctx context.Context, workspace, name, version string) error
  • func (w *Waiter) UntilQueryLambdaVersionGone(ctx context.Context, workspace, name, version string) error
  • func (w *Waiter) UntilQueryable(ctx context.Context, workspace, name string, offsets []string) error
  • func (w *Waiter) UntilViewGone(ctx context.Context, workspace, name string) error
  • func (w *Waiter) UntilVirtualInstanceActive(ctx context.Context, id string) error
  • func (w *Waiter) UntilVirtualInstanceGone(ctx context.Context, id string) error
  • func (w *Waiter) UntilVirtualInstanceSuspended(ctx context.Context, id string) error
  • func (w *Waiter) UntilWorkspaceAvailable(ctx context.Context, workspace string) error
  • func (w *Waiter) UntilWorkspaceGone(ctx context.Context, workspace string) error

Functions

func ResourceHasState

func ResourceHasState[T fmt.Stringer](ctx context.Context, validStates, badStates []T,

	fn func(ctx context.Context) (T, error)) retry.CheckFn

ResourceHasState implements RetryFn to wait until the resource has the desired state, and if a bad state is encountered it will return ErrBadWaitState

func ResourceIsAvailable

func ResourceIsAvailable(ctx context.Context, fn func(ctx context.Context) error) retry.CheckFn

ResourceIsAvailable implements RetryFn to wait until the resource is present

func ResourceIsGone

func ResourceIsGone(ctx context.Context, fn func(ctx context.Context) error) retry.CheckFn

ResourceIsGone implements RetryFn to wait until the resource is gone

Types

type ResourceGetter

type ResourceGetter interface {
	retry.Retrier
	GetAlias(ctx context.Context, workspace string, name string) (openapi.Alias, error)
	GetCollection(ctx context.Context, workspace string, name string) (openapi.Collection, error)
	GetCollectionCommit(ctx context.Context, workspace string, name string,
		offsets []string) (openapi.GetCollectionCommitData, error)
	GetCollectionMount(ctx context.Context, id, collectionPath string) (openapi.CollectionMount, error)
	GetIntegration(ctx context.Context, name string) (openapi.Integration, error)
	GetQueryInfo(ctx context.Context, queryID string) (openapi.QueryInfo, error)
	GetQueryLambdaVersion(ctx context.Context, workspace, name, version string) (openapi.QueryLambdaVersion, error)
	GetView(ctx context.Context, workspace, name string) (openapi.View, error)
	GetVirtualInstance(ctx context.Context, id string) (openapi.VirtualInstance, error)
	GetWorkspace(ctx context.Context, name string) (openapi.Workspace, error)
}

type Waiter

type Waiter struct {
	QueryLambdaTagPropagation time.Duration
	// contains filtered or unexported fields
}

func New

func New(rs ResourceGetter) *Waiter

func (*Waiter) UntilAliasAvailable

func (w *Waiter) UntilAliasAvailable(ctx context.Context, workspace, alias string) error

UntilAliasAvailable waits until the alias is available.

func (*Waiter) UntilAliasGone

func (w *Waiter) UntilAliasGone(ctx context.Context, workspace, alias string) error

UntilAliasGone waits until the alias is gone.

func (*Waiter) UntilCollectionGone

func (w *Waiter) UntilCollectionGone(ctx context.Context, workspace, name string) error

UntilCollectionGone waits until a collection marked for deletion is gone, i.e. GetCollection() returns "not found".

func (*Waiter) UntilCollectionHasDocuments

func (w *Waiter) UntilCollectionHasDocuments(ctx context.Context, workspace, name string, count int64) error

UntilCollectionHasDocuments waits until the collection has at least count documents

func (*Waiter) UntilCollectionHasNewDocuments

func (w *Waiter) UntilCollectionHasNewDocuments(ctx context.Context, workspace, name string, count int64) error

UntilCollectionHasNewDocuments waits until the collection has at least count new documents (measured from when the method is called).

func (*Waiter) UntilCollectionReady

func (w *Waiter) UntilCollectionReady(ctx context.Context, workspace, name string) error

UntilCollectionReady waits until the collection is ready.

func (*Waiter) UntilKafkaIntegrationActive

func (w *Waiter) UntilKafkaIntegrationActive(ctx context.Context, integration string) error

UntilKafkaIntegrationActive waits until all topics in a Kafka integration are in ACTIVE state.

func (*Waiter) UntilMountActive

func (w *Waiter) UntilMountActive(ctx context.Context, vID, workspace, collection string) error

UntilMountActive waits until the collection mount is active, and queries can be issued to it on the virtual instance.

func (*Waiter) UntilMountGone

func (w *Waiter) UntilMountGone(ctx context.Context, vID, workspace, collection string) error

UntilMountGone waits until the collection mount is gone.

func (*Waiter) UntilQueryDone

func (w *Waiter) UntilQueryDone(ctx context.Context, queryID string) error

UntilQueryDone waits until queryID has either completed. Returns ErrBadWaitState if the query failed or was cancelled.

func (*Waiter) UntilQueryLambdaTagPropagated

func (w *Waiter) UntilQueryLambdaTagPropagated(ctx context.Context, workspace, name, tag string) error

UntilQueryLambdaTagPropagated waits until the query lambda tag has been propagated throughout the system.

func (*Waiter) UntilQueryLambdaVersionActive

func (w *Waiter) UntilQueryLambdaVersionActive(ctx context.Context, workspace, name, version string) error

UntilQueryLambdaVersionActive waits until the query lambda version is active. Returns an error if the query lambda contains invalid SQL.

func (*Waiter) UntilQueryLambdaVersionGone

func (w *Waiter) UntilQueryLambdaVersionGone(ctx context.Context, workspace, name, version string) error

UntilQueryLambdaVersionGone waits until a query lambda is deleted, i.e. GetQueryLambda() returns "not found".

func (*Waiter) UntilQueryable

func (w *Waiter) UntilQueryable(ctx context.Context, workspace, name string, offsets []string) error

UntilQueryable waits until the collection includes the documents at or after the specified offset(s).

func (*Waiter) UntilViewGone

func (w *Waiter) UntilViewGone(ctx context.Context, workspace, name string) error

UntilViewGone waits until a view marked for deletion is gone, i.e. GetView() returns "not found".

func (*Waiter) UntilVirtualInstanceActive

func (w *Waiter) UntilVirtualInstanceActive(ctx context.Context, id string) error

UntilVirtualInstanceActive waits until the Virtual Instance is active.

func (*Waiter) UntilVirtualInstanceGone

func (w *Waiter) UntilVirtualInstanceGone(ctx context.Context, id string) error

UntilVirtualInstanceGone waits until the Virtual Instance is gone.

func (*Waiter) UntilVirtualInstanceSuspended

func (w *Waiter) UntilVirtualInstanceSuspended(ctx context.Context, id string) error

UntilVirtualInstanceSuspended waits until the Virtual Instance is suspended.

func (*Waiter) UntilWorkspaceAvailable

func (w *Waiter) UntilWorkspaceAvailable(ctx context.Context, workspace string) error

UntilWorkspaceAvailable waits until the workspace is available.

func (*Waiter) UntilWorkspaceGone

func (w *Waiter) UntilWorkspaceGone(ctx context.Context, workspace string) error

UntilWorkspaceGone waits until the workspace is gone, i.e. GetWorkspace() returns "not found".