tatami

package module

Go to main page

Versions in this module

v0

v0.3.0

Jul 2, 2026

Changes in this version

+ const DefaultBatchBudgetBytes

+ const FlagBlockTreeDict

type AggStats

+ LeavesVisited int

type Aggregator

+ func (a *Aggregator) SearchPhrase(query string, k int) ([]SearchResult, AggStats, error)

+ func (a *Aggregator) Summary() *search.RoutingIndex

type Cluster

+ func OpenClusterWithRoutingFile(paths []string, routingPath string, opts ClusterOptions) (*Cluster, error)

+ func (c *Cluster) Bigram() *search.BigramRouting

+ func (c *Cluster) PersistRouting(path string) error

+ func (c *Cluster) QueryPhrase(query string, k int) ([]ClusterHit, QueryStats, error)

+ func (c *Cluster) QueryPhraseWith(query string, k int, stats search.GlobalStats) ([]ClusterHit, QueryStats, error)

+ func (c *Cluster) SearchPhrase(query string, k int) ([]SearchResult, QueryStats, error)

+ func (c *Cluster) SearchPhraseWith(query string, k int, stats search.GlobalStats) ([]SearchResult, QueryStats, error)

+ func (c *Cluster) WithBigramRouting(br *search.BigramRouting) *Cluster

+ type ClusterPlanOptions struct

+ Dims int

+ Iters int

+ Seed int

+ Shards int

+ Slack float64

+ type ContentClusterer struct

+ func FitClusterer(sample [][]string, opts ClusterPlanOptions) *ContentClusterer

+ func (c *ContentClusterer) Assign(tokens []string) int

+ func (c *ContentClusterer) AssignVec(v []float32) int

+ func (c *ContentClusterer) SetCapacity(totalDocs int, slack float64)

+ func (c *ContentClusterer) Shards() int

+ func (c *ContentClusterer) Vector(tokens []string) []float32

type SearchBuilder

+ func (b *SearchBuilder) EachBigram(fn func(a, bb string, df int, maxFreq uint32))

type SearchBuilderOptions

+ BigramKeep map[search.BigramKey]bool

+ Bigrams bool

type SearchSegment

+ func (s *SearchSegment) SearchTermsSeeded(terms []string, k int, stats search.GlobalStats, seed search.Score) []search.Hit

+ type StreamingOptions struct

+ BatchBudgetBytes int

+ Snippet bool

+ SnippetRunes int

+ Writer WriterOptions

+ type StreamingSearchBuilder struct

+ func NewStreamingSearchBuilder(path, scratchDir string, opts StreamingOptions) (*StreamingSearchBuilder, error)

+ func (b *StreamingSearchBuilder) Add(doc SearchDoc)

+ func (b *StreamingSearchBuilder) Close() (err error)

+ func (b *StreamingSearchBuilder) NumDocs() int

v0.2.0

Jun 26, 2026

Changes in this version

+ const DefaultCacheSize

+ const DefaultMaxInFlight

+ const DefaultMaxK

+ const DefaultQueryTimeout

+ const DefaultSnippetRunes

+ type AggStats struct

+ Candidates int

+ Leaves int

+ ShardsVisited int

+ type Aggregator struct

+ func OpenAggregator(leaves []*Cluster) *Aggregator

+ func (a *Aggregator) Close() error

+ func (a *Aggregator) NumDocs() int

+ func (a *Aggregator) NumLeaves() int

+ func (a *Aggregator) NumShards() int

+ func (a *Aggregator) Search(query string, k int) ([]SearchResult, AggStats, error)

+ func (a *Aggregator) Stats() search.GlobalStats

+ type Cluster struct

+ func OpenCluster(paths []string, opts ClusterOptions) (*Cluster, error)

+ func OpenClusterWithRouting(paths []string, routing *search.RoutingIndex, opts ClusterOptions) *Cluster

+ func (c *Cluster) CacheLen() int

+ func (c *Cluster) Close() error

+ func (c *Cluster) NumDocs() int

+ func (c *Cluster) NumShards() int

+ func (c *Cluster) Query(query string, k int) ([]ClusterHit, QueryStats, error)

+ func (c *Cluster) QueryWith(query string, k int, stats search.GlobalStats) ([]ClusterHit, QueryStats, error)

+ func (c *Cluster) Routing() *search.RoutingIndex

+ func (c *Cluster) Search(query string, k int) ([]SearchResult, QueryStats, error)

+ func (c *Cluster) SearchWith(query string, k int, stats search.GlobalStats) ([]SearchResult, QueryStats, error)

+ type ClusterHit struct

+ Doc uint32

+ Score float32

+ Shard int

+ type ClusterOptions struct

+ CacheSize int

+ type QueryStats struct

+ Candidates int

+ Threshold float32

+ Visited int

type SearchBuilder

+ func NewSearchBuilderWith(opts SearchBuilderOptions) *SearchBuilder

+ type SearchBuilderOptions struct

+ Snippet bool

+ SnippetRunes int

type SearchResult

+ DocID string

+ Snippet string

type SearchSegment

+ func (s *SearchSegment) SearchTermsWith(terms []string, k int, stats search.GlobalStats) []search.Hit

+ func (s *SearchSegment) SnippetOnly() bool

+ type Server struct

+ func NewServer(c *Cluster, opts ServerOptions) *Server

+ func (s *Server) Drain()

+ func (s *Server) Handler() http.Handler

+ type ServerOptions struct

+ DefaultK int

+ MaxInFlight int

+ MaxK int

+ Timeout time.Duration

v0.1.0

Jun 26, 2026

Changes in this version

+ const DefaultPageMaxValues

+ const DefaultRowGroupMaxBytes

+ const DefaultRowGroupMaxRows

+ const FlagHasBlobRegion

+ const FlagHasDictRegion

+ const FlagHasIndexRegion

+ const FlagRoleSearchSeg

+ const FlagSorted

+ const HeaderSize

+ const Magic

+ const ManifestName

+ const PageHeaderSize

+ const TrailerSize

+ const VersionMajor

+ const VersionMinor

+ var ErrClosed = errors.New("tatami: writer is closed")

+ var ErrNotFound = errors.New("tatami: not found")

+ func MergeSegments(segs []*SearchSegment, outPath string, opts WriterOptions) error

+ type Batch struct

+ Columns []Column

+ type ChecksumAlgo uint8

+ const ChecksumCRC32C

+ const ChecksumNone

+ const ChecksumXXH64

+ type Codec uint8

+ const CodecLZ4

+ const CodecNone

+ const CodecZstd

+ const CodecZstdDict

+ func (c Codec) String() string

+ type CollHit struct

+ Member string

+ type Collection struct

+ func OpenCollection(dir string) (*Collection, error)

+ func (c *Collection) AddFile(rel string) error

+ func (c *Collection) Compact() error

+ func (c *Collection) Lookup(key any) (CollHit, bool, int, error)

+ func (c *Collection) Members() []manifest.Member

+ func (c *Collection) Merge(inRels []string, outRel string, opts WriterOptions, createdMillis uint64) error

+ func (c *Collection) Prune(pred *Pred) ([]manifest.Member, error)

+ func (c *Collection) Scan(pred *Pred, projection ...string) (*CollectionScan, error)

+ type CollectionScan struct

+ Columns []string

+ FilesScanned int

+ FilesTotal int

+ Rows [][]any

+ Schema *Schema

+ type Column struct

+ Data any

+ Valid []bool

+ func (c Column) At(i int) any

+ type ColumnStat struct

+ BlobCompressed int64

+ BlobDict bool

+ BlobRuns int

+ BlobUncompressed int64

+ Codec Codec

+ Encoding Encoding

+ HasBloom bool

+ HasPageIndex bool

+ HasZone bool

+ IsSortKey bool

+ Name string

+ NullCount int64

+ NumPages int64

+ NumValues int64

+ TotalCompressed int64

+ TotalUncompressed int64

+ Type LogicalType

+ type Encoding uint8

+ const EncBitmap

+ const EncBitpackFOR

+ const EncDelta

+ const EncDictionary

+ const EncFSST

+ const EncGroupVar

+ const EncPForDelta

+ const EncPlain

+ const EncRLE

+ func (e Encoding) String() string

+ type Field struct

+ BlobSeparated bool

+ BloomFilter bool

+ DictHint bool

+ Element LogicalType

+ Name string

+ Nullable bool

+ SortKey bool

+ Type LogicalType

+ type FileInfo struct

+ Columns []ColumnStat

+ CompressedTotal uint64

+ DictUncompressed int64

+ Header Header

+ KeyValue []KeyValue

+ NumBlooms int

+ NumDicts int

+ NumRowGroups int

+ RowCount uint64

+ Schema *Schema

+ SortColumn string

+ Sorted bool

+ UncompressedTotal uint64

+ type Header struct

+ Checksum ChecksumAlgo

+ CreatedMphis uint64

+ CreatorID uint32

+ DefaultCodec Codec

+ FileUUID [16]byte

+ Flags uint16

+ FooterOffset uint64

+ PageSizeHint uint32

+ RowCount uint64

+ VersionMajor uint16

+ VersionMinor uint16

+ type Index struct

+ func NewIndex(segs []*SearchSegment) *Index

+ func OpenIndex(paths []string) (*Index, error)

+ func (ix *Index) Close() error

+ func (ix *Index) NumDocs() int

+ func (ix *Index) Query(query string, k int) []IndexHit

+ func (ix *Index) Search(query string, k int) ([]SearchResult, error)

+ func (ix *Index) Segments() []*SearchSegment

+ func (ix *Index) SelectMerge(p search.MergePolicy) []int

+ type IndexHit struct

+ Doc uint32

+ Score float32

+ Segment int

+ type KeyValue struct

+ Key string

+ Value string

+ type LogicalType uint8

+ const TypeBlobRef

+ const TypeBool

+ const TypeBytes

+ const TypeFloat32

+ const TypeFloat64

+ const TypeInt16

+ const TypeInt32

+ const TypeInt64

+ const TypeInt8

+ const TypeList

+ const TypeString

+ const TypeTimestampMicros

+ const TypeUint16

+ const TypeUint32

+ const TypeUint64

+ const TypeUint8

+ func (t LogicalType) String() string

+ type Op uint8

+ const OpBetween

+ const OpEQ

+ const OpGE

+ const OpGT

+ const OpIsNull

+ const OpLE

+ const OpLT

+ const OpNE

+ type PageKind uint8

+ const PageBlob

+ const PageData

+ const PageDict

+ const PageIdx

+ type Pred struct

+ func And(kids ...*Pred) *Pred

+ func Between(col string, lo, hi any) *Pred

+ func Eq(col string, val any) *Pred

+ func Ge(col string, val any) *Pred

+ func Gt(col string, val any) *Pred

+ func IsNull(col string) *Pred

+ func Le(col string, val any) *Pred

+ func Lt(col string, val any) *Pred

+ func Ne(col string, val any) *Pred

+ func Or(kids ...*Pred) *Pred

+ type Reader struct

+ func Open(r io.ReaderAt, size int64) (*Reader, error)

+ func OpenFile(path string) (*Reader, *os.File, error)

+ func (r *Reader) Header() Header

+ func (r *Reader) Info() FileInfo

+ func (r *Reader) Lookup(key any) (RowRef, bool, error)

+ func (r *Reader) Meta(key string) (string, bool)

+ func (r *Reader) NumRowGroups() int

+ func (r *Reader) NumRows() uint64

+ func (r *Reader) ReadColumn(group, col int) (Column, error)

+ func (r *Reader) ReadRowGroup(group int) ([]Column, error)

+ func (r *Reader) RowGroupRows(g int) int

+ func (r *Reader) Scan(pred *Pred, projection ...string) (*ScanResult, error)

+ func (r *Reader) Schema() *Schema

+ type RowRef struct

+ Group int

+ Row int

+ type ScanResult struct

+ Columns []string

+ GroupsScanned int

+ GroupsTotal int

+ Rows [][]any

+ Schema *Schema

+ type Schema struct

+ Fields []Field

+ func NewSchema(fields ...Field) (*Schema, error)

+ type SearchBuilder struct

+ func NewSearchBuilder() *SearchBuilder

+ func (b *SearchBuilder) Add(doc SearchDoc)

+ func (b *SearchBuilder) NumDocs() int

+ func (b *SearchBuilder) Write(path string, opts WriterOptions) error

+ type SearchDoc struct

+ Anchor string

+ Body string

+ DocID string

+ Title string

+ URL string

+ type SearchResult struct

+ Doc uint32

+ Score float32

+ Title string

+ URL string

+ type SearchSegment struct

+ func OpenSearch(path string) (*SearchSegment, error)

+ func (s *SearchSegment) Close() error

+ func (s *SearchSegment) Delete(docID string) (bool, error)

+ func (s *SearchSegment) DeleteDense(d uint32) bool

+ func (s *SearchSegment) Inverted() *search.Inverted

+ func (s *SearchSegment) LiveDocs() int

+ func (s *SearchSegment) NumDeleted() int

+ func (s *SearchSegment) NumDocs() int

+ func (s *SearchSegment) NumTerms() int

+ func (s *SearchSegment) Query(query string, k int) []search.Hit

+ func (s *SearchSegment) Search(query string, k int) ([]SearchResult, error)

+ type Tri uint8

+ type Writer struct

+ func Create(path string, schema *Schema, opts WriterOptions) (*Writer, *os.File, error)

+ func NewWriter(w io.WriterAt, schema *Schema, opts WriterOptions) (*Writer, error)

+ func (w *Writer) Append(batch Batch) error

+ func (w *Writer) AttachInverted(termDict, postings, skips, live []byte, numTerms, numDocs uint64)

+ func (w *Writer) Close() error

+ func (w *Writer) SetMeta(key, value string)

+ type WriterOptions struct

+ BlobRunTargetBytes int

+ CreatedMillis uint64

+ CreatorID uint32

+ PageMaxValues int

+ PageSizeHint int

+ RowGroupMaxBytes int

+ RowGroupMaxRows int

+ UUID [16]byte

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL