shard

Documentation

Overview

Package shard ports DatoriumDB document sharding helpers (CRC32 of the sharding prefix → 8-bit slot).

Index

• func RawSlot(input string) byte
• func RawSlotHex(input string) string
• func Slot(documentID string) byte
• func SlotHex(documentID string) string
• func ValidateFullCoverage(ranges []Range) error
• type Range
  • func ParseRange(raw string) (Range, error)
  • func (r Range) Contains(slot byte) bool

Functions

func RawSlot

func RawSlot(input string) byte

RawSlot returns the 8-bit shard slot for an arbitrary byte string using CRC32 with no document-ID prefix detection. Search result shards use this.

func RawSlotHex

func RawSlotHex(input string) string

RawSlotHex returns the two-character uppercase hex form of RawSlot.

func Slot

func Slot(documentID string) byte

Slot returns the 8-bit shard slot for a document ID using CRC32 of the sharding prefix. Periods in the first six rune positions are ignored for prefix detection. If there is no later period, the whole ID is used.

func SlotHex

func SlotHex(documentID string) string

SlotHex returns the two-character uppercase hex form of Slot.

func ValidateFullCoverage

func ValidateFullCoverage(ranges []Range) error

ValidateFullCoverage ensures ranges cover every slot 0x00-0xFF without overlap.

Types

type Range

type Range struct {
	Start byte
	End   byte
	Raw   string
}

Range describes an inclusive hex shard range such as "00-7F".

func ParseRange

func ParseRange(raw string) (Range, error)

ParseRange parses "AA-BB" or a single slot "7A".

func (Range) Contains

func (r Range) Contains(slot byte) bool

Contains reports whether slot is inside r.