go.temporal.io/server@v1.23.0/common/persistence/sql/sqlplugin/history_node.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  	// HistoryNodeRow represents a row in history_node table
    36  	HistoryNodeRow struct {
    37  		ShardID      int32
    38  		TreeID       primitives.UUID
    39  		BranchID     primitives.UUID
    40  		NodeID       int64
    41  		PrevTxnID    int64
    42  		TxnID        int64
    43  		Data         []byte
    44  		DataEncoding string
    45  	}
    46  
    47  	// HistoryNodeSelectFilter contains the column names within history_node table that
    48  	// can be used to filter results through a WHERE clause
    49  	HistoryNodeSelectFilter struct {
    50  		ShardID      int32
    51  		TreeID       primitives.UUID
    52  		BranchID     primitives.UUID
    53  		MinNodeID    int64
    54  		MinTxnID     int64
    55  		MaxNodeID    int64
    56  		MaxTxnID     int64
    57  		PageSize     int
    58  		MetadataOnly bool
    59  		ReverseOrder bool
    60  	}
    61  
    62  	// HistoryNodeDeleteFilter contains the column names within history_node table that
    63  	// can be used to filter results through a WHERE clause
    64  	HistoryNodeDeleteFilter struct {
    65  		ShardID   int32
    66  		TreeID    primitives.UUID
    67  		BranchID  primitives.UUID
    68  		MinNodeID int64
    69  	}
    70  
    71  	// HistoryNode is the SQL persistence interface for history nodes
    72  	HistoryNode interface {
    73  		InsertIntoHistoryNode(ctx context.Context, row *HistoryNodeRow) (sql.Result, error)
    74  		DeleteFromHistoryNode(ctx context.Context, row *HistoryNodeRow) (sql.Result, error)
    75  		RangeSelectFromHistoryNode(ctx context.Context, filter HistoryNodeSelectFilter) ([]HistoryNodeRow, error)
    76  		RangeDeleteFromHistoryNode(ctx context.Context, filter HistoryNodeDeleteFilter) (sql.Result, error)
    77  	}
    78  )