sharding

Documentation

Index

• type AggregatedShardFn
• type HashType
  • func (t HashType) AggregatedShardFn() (AggregatedShardFn, error)
  • func (t HashType) MustShardFn() ShardFn
  • func (t HashType) ShardFn() (ShardFn, error)
  • func (t *HashType) UnmarshalYAML(unmarshal func(interface{}) error) error
• type ShardFn
• type ShardSet
  • func MustParseShardSet(s string) ShardSet
  • func ParseShardSet(s string) (ShardSet, error)
  • func (ss ShardSet) Add(p uint32)
  • func (ss ShardSet) AddBetween(minInclusive, maxExclusive uint32)
  • func (ss ShardSet) Contains(p uint32) bool
  • func (ss ShardSet) ParseRange(s string) error
  • func (ss *ShardSet) UnmarshalYAML(f func(interface{}) error) error

Types

type AggregatedShardFn

type AggregatedShardFn func(chunkedID id.ChunkedID, numShards int) uint32

AggregatedShardFn maps a chunked id to a shard.

type HashType

type HashType string

HashType is the hashing type.

const (
	// Murmur32Hash represents the murmur3 hash.
	Murmur32Hash HashType = "murmur32"

	DefaultHash = Murmur32Hash
)

List of supported hashing types.

func (HashType) AggregatedShardFn

func (t HashType) AggregatedShardFn() (AggregatedShardFn, error)

AggregatedShardFn returns the sharding function for computing aggregated shards.

func (HashType) MustShardFn

func (t HashType) MustShardFn() ShardFn

MustShardFn returns the sharding function, or panics if an error is encountered.

func (HashType) ShardFn

func (t HashType) ShardFn() (ShardFn, error)

ShardFn returns the sharding function.

func (*HashType) UnmarshalYAML

func (t *HashType) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML unmarshals YAML object into a hash type.

type ShardFn

type ShardFn func(id []byte, numShards uint32) uint32

ShardFn maps a id to a shard.

type ShardSet

type ShardSet map[uint32]struct{}

ShardSet is a collection of shards organized as a set. The shards contained in the set can be discontinuous.

func MustParseShardSet

func MustParseShardSet(s string) ShardSet

MustParseShardSet parses a shard set from the input string, and panics if parsing is unsuccessful.

func ParseShardSet

func ParseShardSet(s string) (ShardSet, error)

ParseShardSet parses a shard set from the input string.

func (ShardSet) Add

func (ss ShardSet) Add(p uint32)

Add adds the shard to the set.

func (ShardSet) AddBetween

func (ss ShardSet) AddBetween(minInclusive, maxExclusive uint32)

AddBetween adds shards between the given min (inclusive) and max (exclusive).

func (ShardSet) Contains

func (ss ShardSet) Contains(p uint32) bool

Contains returns true if the shard set contains the given shard.

func (ShardSet) ParseRange

func (ss ShardSet) ParseRange(s string) error

ParseRange parses a range of shards and adds them to the set.

func (*ShardSet) UnmarshalYAML

func (ss *ShardSet) UnmarshalYAML(f func(interface{}) error) error

UnmarshalYAML unmarshals YAML into a shard set. The following formats are supported: * StartShard..EndShard, e.g., 0..63. * Single shard, e.g., 5. * Array containing shard ranges and single shards.