cursor

Documentation

Overview

Package cursor provides access to cursor registry.

Index

• func New(params *NewParams) *cursor
• type NewParams
• type Registry
  • func NewRegistry() *Registry
  • func (r *Registry) Cursor(username string, id int64) *cursor
  • func (r *Registry) DeleteCursor(username string, id int64)
  • func (r *Registry) StoreCursor(username string, c *cursor) int64

Functions

func New

func New(params *NewParams) *cursor

New creates a new cursor.

Types

type NewParams

type NewParams struct {
	Iter       types.DocumentsIterator
	DB         string
	Collection string
	BatchSize  int32
}

NewParams contains the parameters for creating a new cursor.

type Registry

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

Registry stores cursors.

TODO add cleanup TODO add metrics

func NewRegistry

func NewRegistry() *Registry

NewRegistry creates a new Registry.

func (*Registry) Cursor

func (r *Registry) Cursor(username string, id int64) *cursor

Cursor returns stored cursor by username and ID, or nil.

func (*Registry) DeleteCursor

func (r *Registry) DeleteCursor(username string, id int64)

DeleteCursor closes and deletes cursor.

func (*Registry) StoreCursor

func (r *Registry) StoreCursor(username string, c *cursor) int64

StoreCursor stores cursor and return its ID.