CBG-2838: Rely on index 'IF NOT EXISTS' and idempotent deferred index builds fo… #7161
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…r simpler and lower-overhead index creation
torcolvin
reviewed
Oct 17, 2024
There was a problem hiding this comment.
As discussed offline, some improvements to this PR should be made:
- look for
IsIndexerRetryIndexErrorusage as that is where we are taking action on a retryable error. Potentially withCREATE INDEX .. IF NOT EXISTSthis error type will not be returned. - test this on CBS <7.1 which does not have
IF NOT EXISTS
…ation, handle not found error case in deferred build, swallow `ErrIndexBackgroundRetry` where we can fall back to collection-scoped wait
torcolvin
reviewed
Oct 21, 2024
torcolvin
reviewed
Oct 21, 2024
| @@ -123,7 +123,7 @@ func (im *indexManager) GetAllIndexes() ([]gocb.QueryIndex, error) { | |||
| return im.cluster.GetAllIndexes(im.bucketName, opts) | |||
| } | |||
|
|
|||
| // CreateIndex issues a CREATE INDEX query in the current bucket, using the form: | |||
There was a problem hiding this comment.
Do you want to change example also? This might be pedantic since this will be bucket.scope.collection
There was a problem hiding this comment.
It's still a valid example if using the default collection and it doesn't seem necessary to change.
| @@ -149,23 +149,23 @@ func CreateIndexIfNotExists(ctx context.Context, store N1QLStore, indexName stri | |||
|
|
|||
| // createIndex is a common function for CreateIndex and CreateIndexIfNotExists | |||
| func createIndex(ctx context.Context, store N1QLStore, indexName string, expression string, filterExpression string, ifNotExists bool, options *N1qlIndexOptions) error { | |||
| createClause := "CREATE INDEX" | |||
|
|
|||
| var ifNotExistsStr string | |||
| // Server 7.1+ - we can still safely _not_ use this when it's not available, because we have equivalent error handling inside this function to swallow `ErrAlreadyExists`. | |||
There was a problem hiding this comment.
this now needs to be 7.6+
torcolvin
approved these changes
Oct 22, 2024
bbrks
added a commit
that referenced
this pull request
Oct 22, 2024
1 task
torcolvin
pushed a commit
that referenced
this pull request
Oct 22, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
CBG-2838
Rely on index
IF NOT EXISTSand idempotent deferred index builds for simpler and lower-overhead index creation.According to the query docs, this is perfectly fine to do, and eliminates a lot of our manual
system:indexesqueries and retry/error handling logic?Now the only
system:indexescall we have to make is the final one for each collection, to make sure all of the indexes are finished building and are online.Integration Tests
GSI=true,xattrs=truehttps://jenkins.sgwdev.com/job/SyncGateway-Integration/2756/CBS 7.0.5https://jenkins.sgwdev.com/job/SyncGateway-Integration/2754/