go.temporal.io/server@v1.23.0/common/persistence/sql/sqlplugin/history_tree.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  	// HistoryTreeRow represents a row in history_tree table
    36  	HistoryTreeRow struct {
    37  		ShardID      int32
    38  		TreeID       primitives.UUID
    39  		BranchID     primitives.UUID
    40  		Data         []byte
    41  		DataEncoding string
    42  	}
    43  
    44  	// HistoryTreeSelectFilter contains the column names within history_tree table that
    45  	// can be used to filter results through a WHERE clause
    46  	HistoryTreeSelectFilter struct {
    47  		ShardID int32
    48  		TreeID  primitives.UUID
    49  	}
    50  
    51  	// HistoryTreeDeleteFilter contains the column names within history_tree table that
    52  	// can be used to filter results through a WHERE clause
    53  	HistoryTreeDeleteFilter struct {
    54  		ShardID  int32
    55  		TreeID   primitives.UUID
    56  		BranchID primitives.UUID
    57  	}
    58  
    59  	// HistoryTreeBranchPage is a struct which represents a page of history tree branches to query.
    60  	HistoryTreeBranchPage struct {
    61  		ShardID  int32
    62  		TreeID   primitives.UUID
    63  		BranchID primitives.UUID
    64  		Limit    int
    65  	}
    66  
    67  	// HistoryTree is the SQL persistence interface for history trees
    68  	HistoryTree interface {
    69  		InsertIntoHistoryTree(ctx context.Context, row *HistoryTreeRow) (sql.Result, error)
    70  		SelectFromHistoryTree(ctx context.Context, filter HistoryTreeSelectFilter) ([]HistoryTreeRow, error)
    71  		DeleteFromHistoryTree(ctx context.Context, filter HistoryTreeDeleteFilter) (sql.Result, error)
    72  		PaginateBranchesFromHistoryTree(ctx context.Context, filter HistoryTreeBranchPage) ([]HistoryTreeRow, error)
    73  	}
    74  )