go.temporal.io/server@v1.23.0/common/persistence/sql/sqlplugin/cluster_metadata.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  	"go.temporal.io/server/common/persistence"
    33  )
    34  
    35  type (
    36  	// ClusterMetadataRow represents a row in the cluster_metadata table
    37  	ClusterMetadataRow struct {
    38  		ClusterName  string
    39  		Data         []byte
    40  		DataEncoding string
    41  		Version      int64
    42  	}
    43  
    44  	// ClusterMembershipRow represents a row in the cluster_membership table
    45  	ClusterMembershipRow struct {
    46  		Role           persistence.ServiceType
    47  		HostID         []byte
    48  		RPCAddress     string
    49  		RPCPort        uint16
    50  		SessionStart   time.Time
    51  		LastHeartbeat  time.Time
    52  		RecordExpiry   time.Time
    53  		InsertionOrder uint64
    54  	}
    55  
    56  	ClusterMetadataFilter struct {
    57  		ClusterName string
    58  		PageSize    *int
    59  	}
    60  
    61  	// ClusterMembershipFilter is used for GetClusterMembership queries
    62  	ClusterMembershipFilter struct {
    63  		RPCAddressEquals    string
    64  		HostIDEquals        []byte
    65  		HostIDGreaterThan   []byte
    66  		RoleEquals          persistence.ServiceType
    67  		LastHeartbeatAfter  time.Time
    68  		RecordExpiryAfter   time.Time
    69  		SessionStartedAfter time.Time
    70  		MaxRecordCount      int
    71  	}
    72  
    73  	// PruneClusterMembershipFilter is used for PruneClusterMembership queries
    74  	PruneClusterMembershipFilter struct {
    75  		PruneRecordsBefore time.Time
    76  	}
    77  
    78  	// ClusterMetadata is the SQL persistence interface for cluster metadata
    79  	ClusterMetadata interface {
    80  		SaveClusterMetadata(ctx context.Context, row *ClusterMetadataRow) (sql.Result, error)
    81  		GetClusterMetadata(ctx context.Context, filter *ClusterMetadataFilter) (*ClusterMetadataRow, error)
    82  		ListClusterMetadata(ctx context.Context, filter *ClusterMetadataFilter) ([]ClusterMetadataRow, error)
    83  		DeleteClusterMetadata(ctx context.Context, filter *ClusterMetadataFilter) (sql.Result, error)
    84  		WriteLockGetClusterMetadata(ctx context.Context, filter *ClusterMetadataFilter) (*ClusterMetadataRow, error)
    85  		GetClusterMembers(ctx context.Context, filter *ClusterMembershipFilter) ([]ClusterMembershipRow, error)
    86  		UpsertClusterMembership(ctx context.Context, row *ClusterMembershipRow) (sql.Result, error)
    87  		PruneClusterMembership(ctx context.Context, filter *PruneClusterMembershipFilter) (sql.Result, error)
    88  	}
    89  )