go.temporal.io/server@v1.23.0/common/persistence/sql/sqlplugin/queue_v2_message.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  	"go.temporal.io/server/common/persistence"
    32  )
    33  
    34  type (
    35  	// QueueV2MessageRow represents a row in queue_messages table
    36  	QueueV2MessageRow struct {
    37  		QueueType       persistence.QueueV2Type
    38  		QueueName       string
    39  		QueuePartition  int64
    40  		MessageID       int64
    41  		MessagePayload  []byte
    42  		MessageEncoding string
    43  	}
    44  
    45  	// QueueV2MessagesFilter is used to filter rows in queue_messages table
    46  	QueueV2MessagesFilter struct {
    47  		QueueType    persistence.QueueV2Type
    48  		QueueName    string
    49  		Partition    int64
    50  		MinMessageID int64
    51  		MaxMessageID int64 // used for RangeDelete
    52  		PageSize     int   // used for RangeSelect
    53  	}
    54  
    55  	// QueueV2Filter is used to filter rows in queues table
    56  	QueueV2Filter struct {
    57  		QueueType persistence.QueueV2Type
    58  		QueueName string
    59  		Partition int
    60  	}
    61  
    62  	QueueV2Message interface {
    63  		InsertIntoQueueV2Messages(ctx context.Context, row []QueueV2MessageRow) (sql.Result, error)
    64  		RangeSelectFromQueueV2Messages(ctx context.Context, filter QueueV2MessagesFilter) ([]QueueV2MessageRow, error)
    65  		RangeDeleteFromQueueV2Messages(ctx context.Context, filter QueueV2MessagesFilter) (sql.Result, error)
    66  		GetLastEnqueuedMessageIDForUpdateV2(ctx context.Context, filter QueueV2Filter) (int64, error)
    67  	}
    68  )