go.temporal.io/server@v1.23.0/common/persistence/sql/sqlplugin/history_replication_dlq_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  	// ReplicationDLQTasksRow represents a row in replication_tasks_dlq table
    34  	ReplicationDLQTasksRow struct {
    35  		SourceClusterName string
    36  		ShardID           int32
    37  		TaskID            int64
    38  		Data              []byte
    39  		DataEncoding      string
    40  	}
    41  
    42  	// ReplicationDLQTasksFilter contains the column names within replication_tasks_dlq table that
    43  	// can be used to filter results through a WHERE clause
    44  	ReplicationDLQTasksFilter struct {
    45  		ShardID           int32
    46  		SourceClusterName string
    47  		TaskID            int64
    48  	}
    49  
    50  	// ReplicationDLQTasksRangeFilter
    51  	ReplicationDLQTasksRangeFilter struct {
    52  		ShardID            int32
    53  		SourceClusterName  string
    54  		InclusiveMinTaskID int64
    55  		ExclusiveMaxTaskID int64
    56  		PageSize           int
    57  	}
    58  
    59  	// HistoryReplicationDLQTask is the SQL persistence interface for history replication tasks DLQ
    60  	HistoryReplicationDLQTask interface {
    61  		// InsertIntoReplicationDLQTasks puts the replication task into DLQ
    62  		InsertIntoReplicationDLQTasks(ctx context.Context, row []ReplicationDLQTasksRow) (sql.Result, error)
    63  		// RangeSelectFromReplicationDLQTasks returns one or more rows from replication_tasks_dlq table
    64  		RangeSelectFromReplicationDLQTasks(ctx context.Context, filter ReplicationDLQTasksRangeFilter) ([]ReplicationDLQTasksRow, error)
    65  		// DeleteFromReplicationDLQTasks deletes one row from replication_tasks_dlq table
    66  		DeleteFromReplicationDLQTasks(ctx context.Context, filter ReplicationDLQTasksFilter) (sql.Result, error)
    67  		// RangeDeleteFromReplicationDLQTasks deletes one or more rows from replication_tasks_dlq table
    68  		//  ReplicationDLQTasksRangeFilter - {PageSize} will be ignored
    69  		RangeDeleteFromReplicationDLQTasks(ctx context.Context, filter ReplicationDLQTasksRangeFilter) (sql.Result, error)
    70  	}
    71  )