go.temporal.io/server@v1.23.0/common/persistence/sql/sqlplugin/history_buffer.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  package sqlplugin
    26  
    27  import (
    28  	"context"
    29  	"database/sql"
    30  
    31  	"go.temporal.io/server/common/primitives"
    32  )
    33  
    34  type (
    35  	// BufferedEventsRow represents a row in buffered_events table
    36  	BufferedEventsRow struct {
    37  		ShardID      int32
    38  		NamespaceID  primitives.UUID
    39  		WorkflowID   string
    40  		RunID        primitives.UUID
    41  		Data         []byte
    42  		DataEncoding string
    43  	}
    44  
    45  	// BufferedEventsFilter contains the column names within buffered_events table that
    46  	// can be used to filter results through a WHERE clause
    47  	BufferedEventsFilter struct {
    48  		ShardID     int32
    49  		NamespaceID primitives.UUID
    50  		WorkflowID  string
    51  		RunID       primitives.UUID
    52  	}
    53  
    54  	// HistoryExecutionBuffer is the SQL persistence interface for history nodes and history execution buffer events
    55  	HistoryExecutionBuffer interface {
    56  		InsertIntoBufferedEvents(ctx context.Context, rows []BufferedEventsRow) (sql.Result, error)
    57  		SelectFromBufferedEvents(ctx context.Context, filter BufferedEventsFilter) ([]BufferedEventsRow, error)
    58  		DeleteFromBufferedEvents(ctx context.Context, filter BufferedEventsFilter) (sql.Result, error)
    59  	}
    60  )