db: remove FilterType option

RaduBerinde · RaduBerinde · commit cebacb9c0cf8 · 2025-12-04T12:56:21.000-08:00
Remove this legacy field.
diff --git a/bloom/bloom.go b/bloom/bloom.go
@@ -7,7 +7,6 @@ package bloom // import "github.com/cockroachdb/pebble/bloom"
 
 import (
 	"encoding/binary"
-	"fmt"
 	"sync"
 
 	"github.com/cockroachdb/pebble/internal/base"
@@ -228,21 +227,11 @@ func (p FilterPolicy) Name() string {
 }
 
 // MayContain implements the pebble.FilterPolicy interface.
-func (p FilterPolicy) MayContain(ftype base.FilterType, f, key []byte) bool {
-	switch ftype {
-	case base.TableFilter:
-		return tableFilter(f).MayContain(key)
-	default:
-		panic(fmt.Sprintf("unknown filter type: %v", ftype))
-	}
+func (p FilterPolicy) MayContain(f, key []byte) bool {
+	return tableFilter(f).MayContain(key)
 }
 
 // NewWriter implements the pebble.FilterPolicy interface.
-func (p FilterPolicy) NewWriter(ftype base.FilterType) base.FilterWriter {
-	switch ftype {
-	case base.TableFilter:
-		return newTableFilterWriter(int(p))
-	default:
-		panic(fmt.Sprintf("unknown filter type: %v", ftype))
-	}
+func (p FilterPolicy) NewWriter() base.FilterWriter {
+	return newTableFilterWriter(int(p))
 }
diff --git a/bloom/bloom_test.go b/bloom/bloom_test.go
@@ -9,7 +9,6 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/cockroachdb/pebble/internal/base"
 	"github.com/stretchr/testify/require"
 )
 
@@ -37,7 +36,7 @@ func (f tableFilter) String() string {
 }
 
 func newTableFilter(bitsPerKey int, keys ...[]byte) tableFilter {
-	w := FilterPolicy(bitsPerKey).NewWriter(base.TableFilter)
+	w := FilterPolicy(bitsPerKey).NewWriter()
 	for _, key := range keys {
 		w.AddKey(key)
 	}
@@ -210,7 +209,7 @@ func BenchmarkBloomFilter(b *testing.B) {
 	b.ResetTimer()
 	policy := FilterPolicy(10)
 	for i := 0; i < b.N; i++ {
-		w := policy.NewWriter(base.TableFilter)
+		w := policy.NewWriter()
 		for _, key := range keys {
 			w.AddKey(key)
 		}
diff --git a/cmd/pebble/db.go b/cmd/pebble/db.go
@@ -100,7 +100,6 @@ func newPebbleDB(dir string) DB {
 		l.BlockSize = 32 << 10       // 32 KB
 		l.IndexBlockSize = 256 << 10 // 256 KB
 		l.FilterPolicy = bloom.FilterPolicy(10)
-		l.FilterType = pebble.TableFilter
 	}
 	opts.Levels[6].FilterPolicy = pebble.NoFilterPolicy
 	opts.FlushSplitBytes = opts.TargetFileSizes[0]
diff --git a/external_test.go b/external_test.go
@@ -208,7 +208,6 @@ func buildSeparatedValuesDB(
 	o.Levels[0].BlockSize = 32 << 10       // 32 KB
 	o.Levels[0].IndexBlockSize = 256 << 10 // 256 KB
 	o.Levels[0].FilterPolicy = bloom.FilterPolicy(10)
-	o.Levels[0].FilterType = pebble.TableFilter
 	db, err := pebble.Open("", o)
 	require.NoError(tb, err)
 
diff --git a/internal/base/options.go b/internal/base/options.go
@@ -12,22 +12,6 @@ const (
 	SizeClassAwareBlockSizeThreshold = 60
 )
 
-// FilterType is the level at which to apply a filter: block or table.
-type FilterType int
-
-// The available filter types.
-const (
-	TableFilter FilterType = iota
-)
-
-func (t FilterType) String() string {
-	switch t {
-	case TableFilter:
-		return "table"
-	}
-	return "unknown"
-}
-
 // FilterWriter provides an interface for creating filter blocks. See
 // FilterPolicy for more details about filters.
 type FilterWriter interface {
@@ -59,20 +43,20 @@ type FilterPolicy interface {
 	// MayContain returns whether the encoded filter may contain given key.
 	// False positives are possible, where it returns true for keys not in the
 	// original set.
-	MayContain(ftype FilterType, filter, key []byte) bool
+	MayContain(filter, key []byte) bool
 
 	// NewWriter creates a new FilterWriter.
-	NewWriter(ftype FilterType) FilterWriter
+	NewWriter() FilterWriter
 }
 
 // NoFilterPolicy implements the "none" filter policy.
 var NoFilterPolicy FilterPolicy = noFilter{}
 
 type noFilter struct{}
 
-func (noFilter) Name() string                                         { return "none" }
-func (noFilter) MayContain(ftype FilterType, filter, key []byte) bool { return true }
-func (noFilter) NewWriter(ftype FilterType) FilterWriter              { panic("not implemented") }
+func (noFilter) Name() string                       { return "none" }
+func (noFilter) MayContain(filter, key []byte) bool { return true }
+func (noFilter) NewWriter() FilterWriter            { panic("not implemented") }
 
 // BlockPropertyFilter is used in an Iterator to filter sstables and blocks
 // within the sstable. It should not maintain any per-sstable state, and must
diff --git a/merging_iter_test.go b/merging_iter_test.go
@@ -575,7 +575,6 @@ func buildLevelsForMergingIterSeqSeek(
 			}
 			if writeBloomFilters {
 				writerOptions.FilterPolicy = filterPolicy
-				writerOptions.FilterType = base.TableFilter
 			}
 			if forceTwoLevelIndex {
 				if i == 0 && j == 0 {
diff --git a/options.go b/options.go
@@ -49,14 +49,6 @@ const (
 type SpanPolicy = base.SpanPolicy
 type ValueStoragePolicyAdjustment = base.ValueStoragePolicyAdjustment
 
-// FilterType exports the base.FilterType type.
-type FilterType = base.FilterType
-
-// Exported TableFilter constants.
-const (
-	TableFilter = base.TableFilter
-)
-
 // FilterWriter exports the base.FilterWriter type.
 type FilterWriter = base.FilterWriter
 
@@ -463,10 +455,6 @@ type LevelOptions struct {
 	// the previous level for all other levels.
 	FilterPolicy FilterPolicy
 
-	// FilterType is a legacy field. The default and only possible value is
-	// TableFilter.
-	FilterType FilterType
-
 	// IndexBlockSize is the target uncompressed size in bytes of each index
 	// block. When the index block size is larger than this target, two-level
 	// indexes are automatically enabled. Setting this option to a large value
@@ -1832,7 +1820,7 @@ func (o *Options) String() string {
 		fmt.Fprintf(&buf, "  block_size_threshold=%d\n", l.BlockSizeThreshold)
 		fmt.Fprintf(&buf, "  compression=%s\n", l.Compression().Name)
 		fmt.Fprintf(&buf, "  filter_policy=%s\n", l.FilterPolicy.Name())
-		fmt.Fprintf(&buf, "  filter_type=%s\n", l.FilterType)
+		fmt.Fprintf(&buf, "  filter_type=table\n")
 		fmt.Fprintf(&buf, "  index_block_size=%d\n", l.IndexBlockSize)
 		fmt.Fprintf(&buf, "  target_file_size=%d\n", o.TargetFileSizes[i])
 	}
@@ -2350,7 +2338,6 @@ func (o *Options) Parse(s string, hooks *ParseHooks) error {
 			case "filter_type":
 				switch value {
 				case "table":
-					l.FilterType = TableFilter
 				default:
 					// Tolerate unknown options, but log them.
 					if o.Logger != nil {
@@ -2629,7 +2616,6 @@ func (o *Options) MakeWriterOptions(level int, format sstable.TableFormat) sstab
 	writerOpts.BlockSizeThreshold = levelOpts.BlockSizeThreshold
 	writerOpts.Compression = levelOpts.Compression()
 	writerOpts.FilterPolicy = levelOpts.FilterPolicy
-	writerOpts.FilterType = levelOpts.FilterType
 	writerOpts.IndexBlockSize = levelOpts.IndexBlockSize
 	return writerOpts
 }
diff --git a/sstable/colblk_writer.go b/sstable/colblk_writer.go
@@ -8,7 +8,6 @@ import (
 	"bytes"
 	"context"
 	"encoding/binary"
-	"fmt"
 	"math"
 	"slices"
 	"sync"
@@ -151,12 +150,7 @@ func newColumnarWriter(
 		w.valueBlock = valblk.NewWriter(flushGovernor, &w.layout.physBlockMaker, func(compressedSize int) {})
 	}
 	if o.FilterPolicy != base.NoFilterPolicy {
-		switch o.FilterType {
-		case TableFilter:
-			w.filterBlock = newTableFilterWriter(o.FilterPolicy)
-		default:
-			panic(fmt.Sprintf("unknown filter type: %v", o.FilterType))
-		}
+		w.filterBlock = newTableFilterWriter(o.FilterPolicy)
 	}
 
 	numBlockPropertyCollectors := len(o.BlockPropertyCollectors)
diff --git a/sstable/filter.go b/sstable/filter.go
@@ -56,7 +56,7 @@ func newTableFilterReader(policy FilterPolicy, metrics *FilterMetricsTracker) *t
 }
 
 func (f *tableFilterReader) mayContain(data, key []byte) bool {
-	mayContain := f.policy.MayContain(TableFilter, data, key)
+	mayContain := f.policy.MayContain(data, key)
 	if f.metrics != nil {
 		if mayContain {
 			f.metrics.misses.Add(1)
@@ -77,7 +77,7 @@ type tableFilterWriter struct {
 func newTableFilterWriter(policy FilterPolicy) *tableFilterWriter {
 	return &tableFilterWriter{
 		policy: policy,
-		writer: policy.NewWriter(TableFilter),
+		writer: policy.NewWriter(),
 	}
 }
 
diff --git a/sstable/options.go b/sstable/options.go
@@ -41,14 +41,6 @@ var ignoredInternalProperties = map[string]struct{}{
 	"rocksdb.compression_options":          {},
 }
 
-// FilterType exports the base.FilterType type.
-type FilterType = base.FilterType
-
-// Exported TableFilter constants.
-const (
-	TableFilter = base.TableFilter
-)
-
 // FilterWriter exports the base.FilterWriter type.
 type FilterWriter = base.FilterWriter
 
@@ -199,15 +191,6 @@ type WriterOptions struct {
 	// The default value is NoFilterPolicy.
 	FilterPolicy FilterPolicy
 
-	// FilterType defines whether an existing filter policy is applied at a
-	// block-level or table-level. Block-level filters use less memory to create,
-	// but are slower to access as a check for the key in the index must first be
-	// performed to locate the filter block. A table-level filter will require
-	// memory proportional to the number of keys in an sstable to create, but
-	// avoids the index lookup when determining if a key is present. Table-level
-	// filters should be preferred except under constrained memory situations.
-	FilterType FilterType
-
 	// IndexBlockSize is the target uncompressed size in bytes of each index
 	// block. When the index block size is larger than this target, two-level
 	// indexes are automatically enabled. Setting this option to a large value
diff --git a/sstable/reader_iter_test.go b/sstable/reader_iter_test.go
@@ -733,7 +733,7 @@ func (c *controllableFilterPolicy) Name() string {
 	return c.name
 }
 
-func (c *controllableFilterPolicy) MayContain(ftype FilterType, filter, key []byte) bool {
+func (c *controllableFilterPolicy) MayContain(filter, key []byte) bool {
 	return c.mayContainResult
 }
 
diff --git a/sstable/reader_lazy_loading_test.go b/sstable/reader_lazy_loading_test.go
@@ -113,7 +113,7 @@ type testFilterPolicyImpl struct{}
 
 func (testFilterPolicyImpl) Name() string { return "test.filter" }
 
-func (testFilterPolicyImpl) MayContain(ftype FilterType, filter, key []byte) bool {
+func (testFilterPolicyImpl) MayContain(filter, key []byte) bool {
 	// For the test, return false for keys starting with "nonexistent" to simulate bloom filter miss
 	prefix := "nonexistent"
 	if len(key) >= len(prefix) && string(key[:len(prefix)]) == prefix {
@@ -122,7 +122,7 @@ func (testFilterPolicyImpl) MayContain(ftype FilterType, filter, key []byte) boo
 	return true
 }
 
-func (testFilterPolicyImpl) NewWriter(ftype FilterType) FilterWriter {
+func (testFilterPolicyImpl) NewWriter() FilterWriter {
 	return &testFilterWriter{}
 }
 
diff --git a/sstable/reader_test.go b/sstable/reader_test.go
@@ -389,17 +389,14 @@ func TestReader(t *testing.T) {
 		"bloom10bit": {
 			// The standard policy.
 			FilterPolicy: bloom.FilterPolicy(10),
-			FilterType:   base.TableFilter,
 		},
 		"bloom1bit": {
 			// A policy with many false positives.
 			FilterPolicy: bloom.FilterPolicy(1),
-			FilterType:   base.TableFilter,
 		},
 		"bloom100bit": {
 			// A policy unlikely to have false positives.
 			FilterPolicy: bloom.FilterPolicy(100),
-			FilterType:   base.TableFilter,
 		},
 	}
 
diff --git a/sstable/rowblk_writer.go b/sstable/rowblk_writer.go
@@ -1739,12 +1739,7 @@ func newRowWriter(writable objstorage.Writable, o WriterOptions) *RawRowWriter {
 	}
 
 	if o.FilterPolicy != base.NoFilterPolicy {
-		switch o.FilterType {
-		case TableFilter:
-			w.filter = newTableFilterWriter(o.FilterPolicy)
-		default:
-			panic(fmt.Sprintf("unknown filter type: %v", o.FilterType))
-		}
+		w.filter = newTableFilterWriter(o.FilterPolicy)
 	}
 
 	w.props.ComparerName = o.Comparer.Name
diff --git a/sstable/table_test.go b/sstable/table_test.go
@@ -385,14 +385,14 @@ type countingFilterPolicy struct {
 	trueNegatives  int
 }
 
-func (c *countingFilterPolicy) MayContain(ftype FilterType, filter, key []byte) bool {
+func (c *countingFilterPolicy) MayContain(filter, key []byte) bool {
 	got := true
 	if c.degenerate {
 		// When degenerate is true, we override the embedded FilterPolicy's
 		// MayContain method to always return true. Doing so is a valid, if
 		// inefficient, implementation of the FilterPolicy interface.
 	} else {
-		got = c.FilterPolicy.MayContain(ftype, filter, key)
+		got = c.FilterPolicy.MayContain(filter, key)
 	}
 	wordCount := hamletWordCount()
 	_, want := wordCount[string(key)]
@@ -422,7 +422,7 @@ func TestWriterRoundTrip(t *testing.T) {
 				t.Run(fmt.Sprintf("bloom=%s", name), func(t *testing.T) {
 					fs := vfs.NewMem()
 					err := buildHamletTestSST(
-						fs, "test.sst", block.DefaultCompression, fp, TableFilter,
+						fs, "test.sst", block.DefaultCompression, fp,
 						nil /* comparer */, blockSize, indexBlockSize,
 					)
 					require.NoError(t, err)
@@ -525,7 +525,7 @@ func TestMetaIndexEntriesSorted(t *testing.T) {
 	defer leaktest.AfterTest(t)()
 	fs := vfs.NewMem()
 	err := buildHamletTestSST(fs, "test.sst", block.DefaultCompression, nil, /* filter policy */
-		TableFilter, nil, 4096, 4096)
+		nil, 4096, 4096)
 	require.NoError(t, err)
 	f, err := fs.Open("test.sst")
 	require.NoError(t, err)
diff --git a/sstable/test_fixtures.go b/sstable/test_fixtures.go
@@ -122,7 +122,6 @@ func buildHamletTestSST(
 	filename string,
 	compression *block.CompressionProfile,
 	fp FilterPolicy,
-	ftype FilterType,
 	comparer *Comparer,
 	blockSize int,
 	indexBlockSize int,
@@ -141,7 +140,6 @@ func buildHamletTestSST(
 		Comparer:       comparer,
 		Compression:    compression,
 		FilterPolicy:   fp,
-		FilterType:     ftype,
 		IndexBlockSize: indexBlockSize,
 		MergerName:     "nullptr",
 		TableFormat:    fixtureFormat,
@@ -257,7 +255,7 @@ func (tf TestFixtureInfo) Build(fs vfs.FS, filename string) error {
 	}
 
 	return buildHamletTestSST(
-		fs, filename, tf.Compression, fp, base.TableFilter,
+		fs, filename, tf.Compression, fp,
 		comparer,
 		fixtureBlockSize,
 		tf.IndexBlockSize,

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,6 @@ import (`
`9`	`9`	`"strings"`
`10`	`10`	`"testing"`
`11`	`11`
`12`		`- "github.com/cockroachdb/pebble/internal/base"`
`13`	`12`	`"github.com/stretchr/testify/require"`
`14`	`13`	`)`
`15`	`14`
`@@ -37,7 +36,7 @@ func (f tableFilter) String() string {`
`37`	`36`	`}`
`38`	`37`
`39`	`38`	`func newTableFilter(bitsPerKey int, keys ...[]byte) tableFilter {`
`40`		`- w := FilterPolicy(bitsPerKey).NewWriter(base.TableFilter)`
	`39`	`+ w := FilterPolicy(bitsPerKey).NewWriter()`
`41`	`40`	`for _, key := range keys {`
`42`	`41`	`w.AddKey(key)`
`43`	`42`	`}`
`@@ -210,7 +209,7 @@ func BenchmarkBloomFilter(b *testing.B) {`
`210`	`209`	`b.ResetTimer()`
`211`	`210`	`policy := FilterPolicy(10)`
`212`	`211`	`for i := 0; i < b.N; i++ {`
`213`		`- w := policy.NewWriter(base.TableFilter)`
	`212`	`+ w := policy.NewWriter()`
`214`	`213`	`for _, key := range keys {`
`215`	`214`	`w.AddKey(key)`
`216`	`215`	`}`
Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,6 @@ func newPebbleDB(dir string) DB {`
`100`	`100`	`l.BlockSize = 32 << 10 // 32 KB`
`101`	`101`	`l.IndexBlockSize = 256 << 10 // 256 KB`
`102`	`102`	`l.FilterPolicy = bloom.FilterPolicy(10)`
`103`		`- l.FilterType = pebble.TableFilter`
`104`	`103`	`}`
`105`	`104`	`opts.Levels[6].FilterPolicy = pebble.NoFilterPolicy`
`106`	`105`	`opts.FlushSplitBytes = opts.TargetFileSizes[0]`
Original file line number	Diff line number	Diff line change
`@@ -575,7 +575,6 @@ func buildLevelsForMergingIterSeqSeek(`
`575`	`575`	`}`
`576`	`576`	`if writeBloomFilters {`
`577`	`577`	`writerOptions.FilterPolicy = filterPolicy`
`578`		`- writerOptions.FilterType = base.TableFilter`
`579`	`578`	`}`
`580`	`579`	`if forceTwoLevelIndex {`
`581`	`580`	`if i == 0 && j == 0 {`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ func newTableFilterReader(policy FilterPolicy, metrics FilterMetricsTracker) t`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`func (f *tableFilterReader) mayContain(data, key []byte) bool {`
`59`		`- mayContain := f.policy.MayContain(TableFilter, data, key)`
	`59`	`+ mayContain := f.policy.MayContain(data, key)`
`60`	`60`	`if f.metrics != nil {`
`61`	`61`	`if mayContain {`
`62`	`62`	`f.metrics.misses.Add(1)`
`@@ -77,7 +77,7 @@ type tableFilterWriter struct {`
`77`	`77`	`func newTableFilterWriter(policy FilterPolicy) *tableFilterWriter {`
`78`	`78`	`return &tableFilterWriter{`
`79`	`79`	`policy: policy,`
`80`		`- writer: policy.NewWriter(TableFilter),`
	`80`	`+ writer: policy.NewWriter(),`
`81`	`81`	`}`
`82`	`82`	`}`
`83`	`83`