go.temporal.io/server@v1.23.0/common/persistence/visibility/store/elasticsearch/client/bulk_processor.go (about)

     1  // The MIT License
     2  //
     3  // Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
     4  //
     5  // Copyright (c) 2020 Uber Technologies, Inc.
     6  //
     7  // Permission is hereby granted, free of charge, to any person obtaining a copy
     8  // of this software and associated documentation files (the "Software"), to deal
     9  // in the Software without restriction, including without limitation the rights
    10  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    11  // copies of the Software, and to permit persons to whom the Software is
    12  // furnished to do so, subject to the following conditions:
    13  //
    14  // The above copyright notice and this permission notice shall be included in
    15  // all copies or substantial portions of the Software.
    16  //
    17  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    18  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    19  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    20  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    21  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    22  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    23  // THE SOFTWARE.
    24  
    25  //go:generate mockgen -copyright_file ../../../../../../LICENSE -package $GOPACKAGE -source $GOFILE -destination bulk_processor_mock.go
    26  
    27  package client
    28  
    29  import (
    30  	"time"
    31  
    32  	"github.com/olivere/elastic/v7"
    33  )
    34  
    35  type BulkableRequestType uint8
    36  
    37  const (
    38  	BulkableRequestTypeIndex BulkableRequestType = iota
    39  	BulkableRequestTypeDelete
    40  )
    41  
    42  type (
    43  	BulkProcessor interface {
    44  		Stop() error
    45  		Add(request *BulkableRequest)
    46  	}
    47  
    48  	// BulkProcessorParameters holds all required and optional parameters for executing bulk service
    49  	BulkProcessorParameters struct {
    50  		Name          string
    51  		NumOfWorkers  int
    52  		BulkActions   int
    53  		BulkSize      int
    54  		FlushInterval time.Duration
    55  		BeforeFunc    elastic.BulkBeforeFunc
    56  		AfterFunc     elastic.BulkAfterFunc
    57  	}
    58  
    59  	BulkableRequest struct {
    60  		RequestType BulkableRequestType
    61  		Index       string
    62  		ID          string
    63  		Version     int64
    64  		Doc         map[string]interface{}
    65  	}
    66  )