go.temporal.io/server@v1.23.0/common/persistence/sql/sqlplugin/namespace.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/primitives"
    32  )
    33  
    34  type (
    35  	// NamespaceRow represents a row in namespace table
    36  	NamespaceRow struct {
    37  		ID                  primitives.UUID
    38  		Name                string
    39  		Data                []byte
    40  		DataEncoding        string
    41  		IsGlobal            bool
    42  		NotificationVersion int64
    43  	}
    44  
    45  	// NamespaceFilter contains the column names within namespace table that
    46  	// can be used to filter results through a WHERE clause. When ID is not
    47  	// nil, it will be used for WHERE condition. If ID is nil and Name is non-nil,
    48  	// Name will be used for WHERE condition. When both ID and Name are nil,
    49  	// no WHERE clause will be used
    50  	NamespaceFilter struct {
    51  		ID            *primitives.UUID
    52  		Name          *string
    53  		GreaterThanID *primitives.UUID
    54  		PageSize      *int
    55  	}
    56  
    57  	// NamespaceMetadataRow represents a row in namespace_metadata table
    58  	NamespaceMetadataRow struct {
    59  		NotificationVersion int64
    60  	}
    61  
    62  	// Namespace is the SQL persistence interface for namespaces
    63  	Namespace interface {
    64  		InsertIntoNamespace(ctx context.Context, rows *NamespaceRow) (sql.Result, error)
    65  		UpdateNamespace(ctx context.Context, row *NamespaceRow) (sql.Result, error)
    66  		// SelectFromNamespace returns namespaces that match filter criteria. Either ID or
    67  		// Name can be specified to filter results. If both are not specified, all rows
    68  		// will be returned
    69  		SelectFromNamespace(ctx context.Context, filter NamespaceFilter) ([]NamespaceRow, error)
    70  		// DeleteNamespace deletes a single row. One of ID or Name MUST be specified
    71  		DeleteFromNamespace(ctx context.Context, filter NamespaceFilter) (sql.Result, error)
    72  
    73  		LockNamespaceMetadata(ctx context.Context) (*NamespaceMetadataRow, error)
    74  		UpdateNamespaceMetadata(ctx context.Context, row *NamespaceMetadataRow) (sql.Result, error)
    75  		SelectFromNamespaceMetadata(ctx context.Context) (*NamespaceMetadataRow, error)
    76  	}
    77  )