Skip to content

Tune Bleve merge planning for full-text indexes #397

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ajroetker wants to merge 1 commit into from
Closed

Tune Bleve merge planning for full-text indexes #397

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 67 additions & 6 deletions src/store/db/indexes/full_text_index.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,50 @@ const (
fullTextMaxBatches = 100
fullTextPartitionSize = 100
fullTextBackfillBatchSize = 1_000

defaultFullTextMaxSegmentFileSize int64 = 256 << 20
defaultFullTextSegmentsPerMergeTask = 5
)

type bleveMergePlanOptions struct {
MaxSegmentFileSize int64
SegmentsPerMergeTask int
}

func (c FullTextIndexConfig) normalizedBleveMergePlanOptions() bleveMergePlanOptions {
maxSegmentFileSize := c.MaxSegmentFileSize
if maxSegmentFileSize == 0 {
maxSegmentFileSize = defaultFullTextMaxSegmentFileSize
}
segmentsPerMergeTask := c.SegmentsPerMergeTask
if segmentsPerMergeTask == 0 {
segmentsPerMergeTask = defaultFullTextSegmentsPerMergeTask
}
return bleveMergePlanOptions{
MaxSegmentFileSize: maxSegmentFileSize,
SegmentsPerMergeTask: segmentsPerMergeTask,
}
}

func (o bleveMergePlanOptions) validate() error {
if o.MaxSegmentFileSize < 1 {
return fmt.Errorf("max_segment_file_size must be positive, got %d", o.MaxSegmentFileSize)
}
if o.SegmentsPerMergeTask < 2 {
return fmt.Errorf("segments_per_merge_task must be at least 2, got %d", o.SegmentsPerMergeTask)
}
return nil
}

func (o bleveMergePlanOptions) runtimeConfig() map[string]any {
return map[string]any{
"scorchMergePlanOptions": map[string]any{
"maxSegmentFileSize": o.MaxSegmentFileSize,
"segmentsPerMergeTask": o.SegmentsPerMergeTask,
},
}
}

var fullTextRateLimiter *rate.Limiter = rate.NewLimiter(
10_000,
fullTextMaxBatches*fullTextPartitionSize,
Expand Down Expand Up @@ -298,6 +340,10 @@ func NewBleveIndexV2(
return nil, fmt.Errorf("parsing config: %w", err)
}
}
mergePlanOptions := c.normalizedBleveMergePlanOptions()
if err := mergePlanOptions.validate(); err != nil {
return nil, fmt.Errorf("validating Bleve merge plan options: %w", err)
}
indexPath := filepath.Join(dir, name)
bi := &BleveIndexV2{
logger: logger,
Expand All @@ -324,6 +370,10 @@ func (bi *BleveIndexV2) Type() IndexType {
return IndexTypeFullText
}

func (bi *BleveIndexV2) bleveRuntimeConfig() map[string]any {
return bi.conf.normalizedBleveMergePlanOptions().runtimeConfig()
}

// Open initializes or opens the Bleve index.
func (bi *BleveIndexV2) Open(
rebuild bool,
Expand Down Expand Up @@ -372,12 +422,17 @@ func (bi *BleveIndexV2) Open(
return fmt.Errorf("creating WALBuffer: %w", err)
}
if !bi.conf.MemOnly {
mergePlanOptions := bi.conf.normalizedBleveMergePlanOptions()
bi.logger.Info("Using Bleve merge plan options",
zap.Int64("max_segment_file_size", mergePlanOptions.MaxSegmentFileSize),
zap.Int("segments_per_merge_task", mergePlanOptions.SegmentsPerMergeTask))

foundExisting := false
bleveIndexPath := bi.indexPath + "/bleve"
_, statErr := os.Stat(bleveIndexPath)
if statErr == nil {
// Directory exists and not rebuilding, open existing index
bi.bidx, err = bleve.Open(bleveIndexPath)
bi.bidx, err = bleve.OpenUsing(bleveIndexPath, bi.bleveRuntimeConfig())
if err == nil {
bi.logger.Info("Opened existing Bleve index", zap.String("path", bleveIndexPath))
// No need to rebuild if we successfully opened existing index
Expand Down Expand Up @@ -422,7 +477,13 @@ func (bi *BleveIndexV2) Open(
bi.logger.Debug("Creating Bleve index with schema and mapping",
zap.Any("schema", tableSchema),
zap.Any("indexMapping", indexMapping))
bi.bidx, err = bleve.New(bleveIndexPath, indexMapping)
bi.bidx, err = bleve.NewUsing(
bleveIndexPath,
indexMapping,
bleve.Config.DefaultIndexType,
bleve.Config.DefaultKVStore,
bi.bleveRuntimeConfig(),
)
if err != nil {
return fmt.Errorf("creating bleve index at %s: %w", bleveIndexPath, err)
}
Expand Down Expand Up @@ -1087,12 +1148,12 @@ func (bi *BleveIndexV2) reloadMapping(newSchema *schema.TableSchema) error {

// Reopen with updated mapping
bleveIndexPath := bi.indexPath + "/bleve"
bi.bidx, err = bleve.OpenUsing(bleveIndexPath, map[string]any{
"updated_mapping": string(mappingBytes),
})
runtimeConfig := bi.bleveRuntimeConfig()
runtimeConfig["updated_mapping"] = string(mappingBytes)
bi.bidx, err = bleve.OpenUsing(bleveIndexPath, runtimeConfig)
if err != nil {
// Attempt to reopen without update on failure
bi.bidx, _ = bleve.Open(bleveIndexPath)
bi.bidx, _ = bleve.OpenUsing(bleveIndexPath, bi.bleveRuntimeConfig())
return fmt.Errorf("reopening index with updated mapping: %w", err)
}

Expand Down
114 changes: 114 additions & 0 deletions src/store/db/indexes/full_text_index_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,120 @@ func setupTestDB(t *testing.T) (*pebble.DB, string, func()) {
return db, tempDir, cleanup
}

func TestBleveMergePlanOptions(t *testing.T) {
tests := []struct {
name string
config FullTextIndexConfig
want bleveMergePlanOptions
wantErr string
}{
{
name: "defaults",
config: FullTextIndexConfig{},
want: bleveMergePlanOptions{
MaxSegmentFileSize: defaultFullTextMaxSegmentFileSize,
SegmentsPerMergeTask: defaultFullTextSegmentsPerMergeTask,
},
},
{
name: "custom",
config: FullTextIndexConfig{
MaxSegmentFileSize: 512 << 20,
SegmentsPerMergeTask: 7,
},
want: bleveMergePlanOptions{
MaxSegmentFileSize: 512 << 20,
SegmentsPerMergeTask: 7,
},
},
{
name: "negative max segment file size",
config: FullTextIndexConfig{
MaxSegmentFileSize: -1,
},
wantErr: "max_segment_file_size must be positive",
},
{
name: "single segment merge task",
config: FullTextIndexConfig{
SegmentsPerMergeTask: 1,
},
wantErr: "segments_per_merge_task must be at least 2",
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := tt.config.normalizedBleveMergePlanOptions()
err := got.validate()
if tt.wantErr != "" {
require.ErrorContains(t, err, tt.wantErr)
return
}
require.NoError(t, err)
require.Equal(t, tt.want, got)

runtimeConfig := got.runtimeConfig()
scorchOptions, ok := runtimeConfig["scorchMergePlanOptions"].(map[string]any)
require.True(t, ok)
require.Equal(t, got.MaxSegmentFileSize, scorchOptions["maxSegmentFileSize"])
require.Equal(t, got.SegmentsPerMergeTask, scorchOptions["segmentsPerMergeTask"])
})
}
}

func TestFullTextIndexConfigEqualNormalizesMergePlanDefaults(t *testing.T) {
implicitDefaults := FullTextIndexConfig{}
explicitDefaults := FullTextIndexConfig{
MaxSegmentFileSize: defaultFullTextMaxSegmentFileSize,
SegmentsPerMergeTask: defaultFullTextSegmentsPerMergeTask,
}
custom := FullTextIndexConfig{
MaxSegmentFileSize: 512 << 20,
SegmentsPerMergeTask: 7,
}

require.True(t, implicitDefaults.Equal(explicitDefaults))
require.False(t, implicitDefaults.Equal(custom))
}

func TestNewBleveIndexV2RejectsInvalidMergePlanOptions(t *testing.T) {
logger := zaptest.NewLogger(t).Sugar().Desugar()
db, tempDir, cleanup := setupTestDB(t)
defer cleanup()

tests := []struct {
name string
config FullTextIndexConfig
wantErr string
}{
{
name: "negative max segment file size",
config: FullTextIndexConfig{
MaxSegmentFileSize: -1,
},
wantErr: "max_segment_file_size must be positive",
},
{
name: "single segment merge task",
config: FullTextIndexConfig{
SegmentsPerMergeTask: 1,
},
wantErr: "segments_per_merge_task must be at least 2",
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
config, err := NewIndexConfig("test_index", tt.config)
require.NoError(t, err)

_, err = NewBleveIndexV2(logger, nil, db, tempDir, "test_index", config, nil)
require.ErrorContains(t, err, tt.wantErr)
})
}
}

func TestNewBleveIndexV2(t *testing.T) {
logger := zaptest.NewLogger(t).Sugar().Desugar()
db, tempDir, cleanup := setupTestDB(t)
Expand Down
Loading
Loading