go.temporal.io/server@v1.23.0/common/persistence/sql/sqlplugin/queue_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  	// QueueMessageRow represents a row in queue table
    36  	QueueMessageRow struct {
    37  		QueueType       persistence.QueueType
    38  		MessageID       int64
    39  		MessagePayload  []byte
    40  		MessageEncoding string
    41  	}
    42  
    43  	// QueueMessagesFilter
    44  	QueueMessagesFilter struct {
    45  		QueueType persistence.QueueType
    46  		MessageID int64
    47  	}
    48  
    49  	// QueueMessagesRangeFilter
    50  	QueueMessagesRangeFilter struct {
    51  		QueueType    persistence.QueueType
    52  		MinMessageID int64
    53  		MaxMessageID int64
    54  		PageSize     int
    55  	}
    56  
    57  	QueueMessage interface {
    58  		InsertIntoMessages(ctx context.Context, row []QueueMessageRow) (sql.Result, error)
    59  		SelectFromMessages(ctx context.Context, filter QueueMessagesFilter) ([]QueueMessageRow, error)
    60  		RangeSelectFromMessages(ctx context.Context, filter QueueMessagesRangeFilter) ([]QueueMessageRow, error)
    61  		DeleteFromMessages(ctx context.Context, filter QueueMessagesFilter) (sql.Result, error)
    62  		RangeDeleteFromMessages(ctx context.Context, filter QueueMessagesRangeFilter) (sql.Result, error)
    63  
    64  		GetLastEnqueuedMessageIDForUpdate(ctx context.Context, queueType persistence.QueueType) (int64, error)
    65  	}
    66  )