go.temporal.io/server@v1.23.0/common/persistence/sql/sqlplugin/history_timer_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  	"time"
    31  )
    32  
    33  type (
    34  	// TimerTasksRow represents a row in timer_tasks table
    35  	TimerTasksRow struct {
    36  		ShardID             int32
    37  		VisibilityTimestamp time.Time
    38  		TaskID              int64
    39  		Data                []byte
    40  		DataEncoding        string
    41  	}
    42  
    43  	// TimerTasksFilter contains the column names within timer_tasks table that
    44  	// can be used to filter results through a WHERE clause
    45  	TimerTasksFilter struct {
    46  		ShardID             int32
    47  		TaskID              int64
    48  		VisibilityTimestamp time.Time
    49  	}
    50  
    51  	// TimerTasksFilter contains the column names within timer_tasks table that
    52  	// can be used to filter results through a WHERE clause
    53  	TimerTasksRangeFilter struct {
    54  		ShardID                         int32
    55  		InclusiveMinTaskID              int64
    56  		InclusiveMinVisibilityTimestamp time.Time
    57  		ExclusiveMaxVisibilityTimestamp time.Time
    58  		PageSize                        int
    59  	}
    60  
    61  	// HistoryTimerTask is the SQL persistence interface for history timer tasks
    62  	HistoryTimerTask interface {
    63  		// InsertIntoTimerTasks inserts rows that into timer_tasks table.
    64  		InsertIntoTimerTasks(ctx context.Context, rows []TimerTasksRow) (sql.Result, error)
    65  		// RangeSelectFromTimerTasks returns one or more rows from timer_tasks table
    66  		RangeSelectFromTimerTasks(ctx context.Context, filter TimerTasksRangeFilter) ([]TimerTasksRow, error)
    67  		// DeleteFromTimerTasks deletes one or more rows from timer_tasks table
    68  		DeleteFromTimerTasks(ctx context.Context, filter TimerTasksFilter) (sql.Result, error)
    69  		// RangeDeleteFromTimerTasks deletes one or more rows from timer_tasks table
    70  		//  TimerTasksRangeFilter - {TaskID, PageSize} will be ignored
    71  		RangeDeleteFromTimerTasks(ctx context.Context, filter TimerTasksRangeFilter) (sql.Result, error)
    72  	}
    73  )