go.temporal.io/server@v1.23.0/common/persistence/nosql/nosqlplugin/cassandra/gocql/interfaces.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  //go:generate mockgen -copyright_file ../../../../../../LICENSE -package $GOPACKAGE -source $GOFILE -destination interfaces_mock.go
    26  
    27  package gocql
    28  
    29  import (
    30  	"context"
    31  )
    32  
    33  // Note: this file defines the minimal interface that is needed by Temporal's cassandra
    34  // persistence implementation and should be implemented for all gocql libraries if
    35  // they need to be used.
    36  // Please add more methods to the interface if needed by the cassandra implementation.
    37  
    38  type (
    39  	// Session is the interface for interacting with the database.
    40  	Session interface {
    41  		Query(string, ...interface{}) Query
    42  		NewBatch(BatchType) Batch
    43  		ExecuteBatch(Batch) error
    44  		MapExecuteBatchCAS(Batch, map[string]interface{}) (bool, Iter, error)
    45  		AwaitSchemaAgreement(ctx context.Context) error
    46  		Close()
    47  	}
    48  
    49  	// Query is the interface for query object.
    50  	Query interface {
    51  		Exec() error
    52  		Scan(...interface{}) error
    53  		ScanCAS(...interface{}) (bool, error)
    54  		MapScan(map[string]interface{}) error
    55  		MapScanCAS(map[string]interface{}) (bool, error)
    56  		Iter() Iter
    57  		PageSize(int) Query
    58  		PageState([]byte) Query
    59  		WithContext(context.Context) Query
    60  		WithTimestamp(int64) Query
    61  		Consistency(Consistency) Query
    62  		Bind(...interface{}) Query
    63  	}
    64  
    65  	// Batch is the interface for batch operation.
    66  	Batch interface {
    67  		Query(string, ...interface{})
    68  		WithContext(context.Context) Batch
    69  		WithTimestamp(int64) Batch
    70  	}
    71  
    72  	// Iter is the interface for executing and iterating over all resulting rows.
    73  	Iter interface {
    74  		Scan(...interface{}) bool
    75  		MapScan(map[string]interface{}) bool
    76  		PageState() []byte
    77  		Close() error
    78  	}
    79  
    80  	// BatchType is the type of the Batch operation
    81  	BatchType byte
    82  
    83  	// Consistency is the consistency level used by a Query
    84  	Consistency uint16
    85  
    86  	// SerialConsistency is the serial consistency level used by a Query
    87  	SerialConsistency uint16
    88  )