batches

Documentation

Overview

Package batches contains support code for working with and testing batches of data.

Index

• func Batch(count int, fn func(begin, end int) error) error
• func Size() int
• func Window(batchSize, count int, fn func(begin, end int) error) error
• type Release
  • func Mutation() ([]types.Mutation, Release)

Functions

func Batch

func Batch(count int, fn func(begin, end int) error) error

Batch is a helper to perform some operation over a large number of values in a batch-oriented fashion. The indexes provided to the callback function are a half-open range [begin , end).

func Size

func Size() int

Size returns the default size for batch operations. Testing code should generally use a multiple of this value to ensure that batching has been correctly implemented.

func Window

func Window(batchSize, count int, fn func(begin, end int) error) error

Window is a helper to perform some operation over a large number of values in a batch-oriented fashion, using the supplied batch size. The indexes provided to the callback function are a half-open range [begin , end).

Types

type Release

type Release func()

The Release function must be called to return the underlying array back to the pool.

func Mutation

func Mutation() ([]types.Mutation, Release)

Mutation returns a slice of Size() capacity.