package parts

Import Path
	github.com/polarsignals/frostdb/parts (on go.dev)

Dependency Relation
	imports 9 packages, and imported by 2 packages

Involved Source Files

	    arrow.go
	    parquet.go
	    part.go
Package-Level Type Names (total 3)

	/* sort by: alphabet | popularity */
	 type Option (func)

		As Outputs Of (at least 2)
			func WithCompactionLevel(level int) Option
			func WithRelease(release func()) Option
		As Inputs Of (at least 4)
			func NewArrowPart(tx uint64, record arrow.Record, size uint64, schema *dynparquet.Schema, options ...Option) Part
			func NewParquetPart(tx uint64, buf *dynparquet.SerializedBuffer, options ...Option) Part
			func github.com/polarsignals/frostdb/index.(*FileCompaction).Compact(compact []Part, options ...Option) ([]Part, int64, int64, error)
			func github.com/polarsignals/frostdb/index.Level.Compact(parts []Part, options ...Option) ([]Part, int64, int64, error)

	 type Part (interface)

		Methods (total 13)
			( Part) AsSerializedBuffer(schema *dynparquet.Schema) (*dynparquet.SerializedBuffer, error)
			( Part) CompactionLevel() int
			( Part) Least() (*dynparquet.DynamicRow, error)
			( Part) Most() (*dynparquet.DynamicRow, error)
			( Part) NumRows() int64
			( Part) OverlapsWith(schema *dynparquet.Schema, otherPart Part) (bool, error)
			( Part) Record() arrow.Record
				Record returns the Arrow record for the part. If the part is not an Arrow
				record part, nil is returned.

			( Part) Release()
			( Part) Retain()
			( Part) SerializeBuffer(schema *dynparquet.Schema, w dynparquet.ParquetWriter) error
			( Part) Size() int64
			( Part) TX() uint64
			( Part) Write(io.Writer) error
		Implements (at least one exported)
			 Part : github.com/apache/arrow-go/v18/arrow/scalar.Releasable
		As Outputs Of (at least 7)
			func FindMaximumNonOverlappingSet(schema *dynparquet.Schema, parts []Part) ([]Part, []Part, error)
			func FindMaximumNonOverlappingSet(schema *dynparquet.Schema, parts []Part) ([]Part, []Part, error)
			func NewArrowPart(tx uint64, record arrow.Record, size uint64, schema *dynparquet.Schema, options ...Option) Part
			func NewParquetPart(tx uint64, buf *dynparquet.SerializedBuffer, options ...Option) Part
			func github.com/polarsignals/frostdb/index.(*FileCompaction).Compact(compact []Part, options ...Option) ([]Part, int64, int64, error)
			func github.com/polarsignals/frostdb/index.Level.Compact(parts []Part, options ...Option) ([]Part, int64, int64, error)
			func github.com/polarsignals/frostdb/index.(*Node).Part() Part
		As Inputs Of (at least 10)
			func FindMaximumNonOverlappingSet(schema *dynparquet.Schema, parts []Part) ([]Part, []Part, error)
			func NewPartSorter(schema *dynparquet.Schema, parts []Part) *PartSorter
			func Part.OverlapsWith(schema *dynparquet.Schema, otherPart Part) (bool, error)
			func github.com/polarsignals/frostdb/index.(*FileCompaction).Compact(compact []Part, options ...Option) ([]Part, int64, int64, error)
			func github.com/polarsignals/frostdb/index.(*FileCompaction).Snapshot(_ []Part, _ func(Part) error, dir string) error
			func github.com/polarsignals/frostdb/index.Level.Compact(parts []Part, options ...Option) ([]Part, int64, int64, error)
			func github.com/polarsignals/frostdb/index.Level.Snapshot(parts []Part, writer func(Part) error, dir string) error
			func github.com/polarsignals/frostdb/index.(*LSM).InsertPart(part Part)
			func github.com/polarsignals/frostdb/index.(*Node).Insert(part Part)
			func github.com/polarsignals/frostdb/index.(*Node).Prepend(part Part) *index.Node

	 type PartSorter (struct)

		Methods (total 4)
			(*PartSorter) Err() error
			(*PartSorter) Len() int
			(*PartSorter) Less(i, j int) bool
			(*PartSorter) Swap(i, j int)
		Implements (at least one exported)
			*PartSorter : sort.Interface
		As Outputs Of (at least one exported)
			func NewPartSorter(schema *dynparquet.Schema, parts []Part) *PartSorter


Package-Level Functions (total 6)

	 func FindMaximumNonOverlappingSet(schema *dynparquet.Schema, parts []Part) ([]Part, []Part, error)
		FindMaximumNonOverlappingSet removes the minimum number of parts from the
		given slice in order to return the maximum non-overlapping set of parts.
		The function returns the non-overlapping parts first and any overlapping
		parts second. The parts returned are in sorted order according to their Least
		row.

	 func NewArrowPart(tx uint64, record arrow.Record, size uint64, schema *dynparquet.Schema, options ...Option) Part
		NewArrowPart returns a new Arrow part.

	 func NewParquetPart(tx uint64, buf *dynparquet.SerializedBuffer, options ...Option) Part
	 func NewPartSorter(schema *dynparquet.Schema, parts []Part) *PartSorter
	 func WithCompactionLevel(level int) Option
	 func WithRelease(release func()) Option

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.