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