go.temporal.io/server@v1.23.0/common/persistence/sql/sqlplugin/history_scheduled_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  	// HistoryScheduledTasksRow represents a row in history_scheduled_tasks table
    35  	HistoryScheduledTasksRow struct {
    36  		ShardID             int32
    37  		CategoryID          int32
    38  		VisibilityTimestamp time.Time
    39  		TaskID              int64
    40  		Data                []byte
    41  		DataEncoding        string
    42  	}
    43  
    44  	// HistoryScheduledTasksFilter contains the column names within history_scheduled_tasks table that
    45  	// can be used to filter results through a WHERE clause
    46  	HistoryScheduledTasksFilter struct {
    47  		ShardID             int32
    48  		CategoryID          int32
    49  		TaskID              int64
    50  		VisibilityTimestamp time.Time
    51  	}
    52  
    53  	// HistoryScheduledTasksFilter contains the column names within history_scheduled_tasks table that
    54  	// can be used to filter results through a WHERE clause
    55  	HistoryScheduledTasksRangeFilter struct {
    56  		ShardID                         int32
    57  		CategoryID                      int32
    58  		InclusiveMinTaskID              int64
    59  		InclusiveMinVisibilityTimestamp time.Time
    60  		ExclusiveMaxVisibilityTimestamp time.Time
    61  		PageSize                        int
    62  	}
    63  
    64  	// HistoryScheduledTask is the SQL persistence interface for history scheduled tasks
    65  	HistoryScheduledTask interface {
    66  		// InsertIntoHistoryScheduledTasks inserts rows that into history_scheduled_tasks table.
    67  		InsertIntoHistoryScheduledTasks(ctx context.Context, rows []HistoryScheduledTasksRow) (sql.Result, error)
    68  		// RangeSelectFromScheduledTasks returns one or more rows from history_scheduled_tasks table
    69  		RangeSelectFromHistoryScheduledTasks(ctx context.Context, filter HistoryScheduledTasksRangeFilter) ([]HistoryScheduledTasksRow, error)
    70  		// DeleteFromScheduledTasks deletes one or more rows from history_scheduled_tasks table
    71  		DeleteFromHistoryScheduledTasks(ctx context.Context, filter HistoryScheduledTasksFilter) (sql.Result, error)
    72  		// RangeDeleteFromScheduledTasks deletes one or more rows from history_scheduled_tasks table
    73  		//  ScheduledTasksRangeFilter - {TaskID, PageSize} will be ignored
    74  		RangeDeleteFromHistoryScheduledTasks(ctx context.Context, filter HistoryScheduledTasksRangeFilter) (sql.Result, error)
    75  	}
    76  )