go.temporal.io/server@v1.23.0/common/persistence/sql/sqlplugin/matching_task.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  	// TasksRow represents a row in tasks table
    34  	TasksRow struct {
    35  		RangeHash    uint32
    36  		TaskQueueID  []byte
    37  		TaskID       int64
    38  		Data         []byte
    39  		DataEncoding string
    40  	}
    41  
    42  	// TasksFilter contains the column names within tasks table that
    43  	// can be used to filter results through a WHERE clause
    44  	TasksFilter struct {
    45  		RangeHash          uint32
    46  		TaskQueueID        []byte
    47  		TaskID             *int64
    48  		InclusiveMinTaskID *int64
    49  		ExclusiveMaxTaskID *int64
    50  		Limit              *int
    51  		PageSize           *int
    52  	}
    53  
    54  	// MatchingTask is the SQL persistence interface for matching tasks
    55  	MatchingTask interface {
    56  		InsertIntoTasks(ctx context.Context, rows []TasksRow) (sql.Result, error)
    57  		// SelectFromTasks retrieves one or more rows from the tasks table
    58  		// Required filter params - {namespaceID, taskqueueName, taskType, inclusiveMinTaskID, exclusiveMaxTaskID, pageSize}
    59  		SelectFromTasks(ctx context.Context, filter TasksFilter) ([]TasksRow, error)
    60  		// DeleteFromTasks deletes a row from tasks table
    61  		// Required filter params:
    62  		//  to delete single row
    63  		//     - {namespaceID, taskqueueName, taskType, taskID}
    64  		//  to delete multiple rows
    65  		//    - {namespaceID, taskqueueName, taskType, exclusiveMaxTaskID, limit }
    66  		//    - this will delete upto limit number of tasks less than the given max task id
    67  		DeleteFromTasks(ctx context.Context, filter TasksFilter) (sql.Result, error)
    68  	}
    69  )