go.temporal.io/server@v1.23.0/common/persistence/sql/sqlplugin/history_transfer_tasks.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  
    32  type (
    33  	// TransferTasksRow represents a row in transfer_tasks table
    34  	TransferTasksRow struct {
    35  		ShardID      int32
    36  		TaskID       int64
    37  		Data         []byte
    38  		DataEncoding string
    39  	}
    40  
    41  	// TransferTasksFilter contains the column names within transfer_tasks table that
    42  	// can be used to filter results through a WHERE clause
    43  	TransferTasksFilter struct {
    44  		ShardID int32
    45  		TaskID  int64
    46  	}
    47  
    48  	// TransferTasksRangeFilter contains the column names within transfer_tasks table that
    49  	// can be used to filter results through a WHERE clause
    50  	TransferTasksRangeFilter struct {
    51  		ShardID            int32
    52  		InclusiveMinTaskID int64
    53  		ExclusiveMaxTaskID int64
    54  		PageSize           int
    55  	}
    56  
    57  	// HistoryTransferTask is the SQL persistence interface for history transfer tasks
    58  	HistoryTransferTask interface {
    59  		// InsertIntoTransferTasks inserts rows that into transfer_tasks table.
    60  		InsertIntoTransferTasks(ctx context.Context, rows []TransferTasksRow) (sql.Result, error)
    61  		// RangeSelectFromTransferTasks returns rows that match filter criteria from transfer_tasks table.
    62  		RangeSelectFromTransferTasks(ctx context.Context, filter TransferTasksRangeFilter) ([]TransferTasksRow, error)
    63  		// DeleteFromTransferTasks deletes one rows from transfer_tasks table.
    64  		DeleteFromTransferTasks(ctx context.Context, filter TransferTasksFilter) (sql.Result, error)
    65  		// RangeDeleteFromTransferTasks deletes one or more rows from transfer_tasks table.
    66  		//  TransferTasksRangeFilter - {PageSize} will be ignored
    67  		RangeDeleteFromTransferTasks(ctx context.Context, filter TransferTasksRangeFilter) (sql.Result, error)
    68  	}
    69  )