Files
Rodrigo ZhouandDavid Reiss 8d881ba35e Add support for ES Scroll for Scan API (#4614)
<!-- Describe what has changed in this PR -->
**What changed?**
Add support for ES Scroll for Scan API.

This is a revert of https://github.com/temporalio/temporal/pull/4223 and
https://github.com/temporalio/temporal/pull/4249.

<!-- Tell your future self why have you made these changes -->
**Why?**
ES 7.10 hosted in AWS is the OSS flavor, not the default one which
includes support for PIT.

<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
**How did you test it?**
Add unit tests.

<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->
**Potential risks**
No.

<!-- Is this PR a hotfix candidate or require that a notification be
sent to the broader community? (Yes/No) -->
**Is hotfix candidate?**
2023-07-20 21:50:23 -07:00

91 lines
3.8 KiB
Go

// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
//
// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//go:generate mockgen -copyright_file ../../../../../../LICENSE -package $GOPACKAGE -source $GOFILE -destination client_mock.go
package client
import (
"context"
"time"
"github.com/olivere/elastic/v7"
enumspb "go.temporal.io/api/enums/v1"
)
const (
versionTypeExternal = "external"
minimumCloseIdleConnectionsInterval = 15 * time.Second
)
type (
// Client is a wrapper around Elasticsearch client library.
Client interface {
Get(ctx context.Context, index string, docID string) (*elastic.GetResult, error)
Search(ctx context.Context, p *SearchParameters) (*elastic.SearchResult, error)
Count(ctx context.Context, index string, query elastic.Query) (int64, error)
RunBulkProcessor(ctx context.Context, p *BulkProcessorParameters) (BulkProcessor, error)
// TODO (alex): move this to some admin client (and join with IntegrationTestsClient)
PutMapping(ctx context.Context, index string, mapping map[string]enumspb.IndexedValueType) (bool, error)
WaitForYellowStatus(ctx context.Context, index string) (string, error)
GetMapping(ctx context.Context, index string) (map[string]string, error)
OpenScroll(ctx context.Context, p *SearchParameters, keepAliveInterval string) (*elastic.SearchResult, error)
Scroll(ctx context.Context, id string, keepAliveInterval string) (*elastic.SearchResult, error)
CloseScroll(ctx context.Context, id string) error
IsPointInTimeSupported(ctx context.Context) bool
OpenPointInTime(ctx context.Context, index string, keepAliveInterval string) (string, error)
ClosePointInTime(ctx context.Context, id string) (bool, error)
}
CLIClient interface {
Client
Delete(ctx context.Context, indexName string, docID string, version int64) error
}
IntegrationTestsClient interface {
CreateIndex(ctx context.Context, index string) (bool, error)
IndexPutTemplate(ctx context.Context, templateName string, bodyString string) (bool, error)
IndexExists(ctx context.Context, indexName string) (bool, error)
DeleteIndex(ctx context.Context, indexName string) (bool, error)
IndexPutSettings(ctx context.Context, indexName string, bodyString string) (bool, error)
IndexGetSettings(ctx context.Context, indexName string) (map[string]*elastic.IndicesGetSettingsResponse, error)
PutMapping(ctx context.Context, index string, mapping map[string]enumspb.IndexedValueType) (bool, error)
}
// SearchParameters holds all required and optional parameters for executing a search.
SearchParameters struct {
Index string
Query elastic.Query
PageSize int
Sorter []elastic.Sorter
SearchAfter []interface{}
ScrollID string
PointInTime *elastic.PointInTime
}
)