Files
tasks/common/persistence/sql/sqlplugin/interfaces.go
T
ba33c258f7 Matching task fairness SQL support (#8099)
## What changed?
Add SQL support for matching task fairness.

Based on #8043 with some changes to reduce code duplication (can be
applied to cassandra later).

## Why?
Support all persistence implementations.

## How did you test it?
- [x] covered by existing tests
- [x] added new unit test(s)

---------

Co-authored-by: sivagirish81 <[email protected]>
2025-07-31 05:01:00 -07:00

141 lines
3.2 KiB
Go

package sqlplugin
import (
"context"
"database/sql"
"github.com/jmoiron/sqlx"
"go.temporal.io/server/common/config"
"go.temporal.io/server/common/log"
"go.temporal.io/server/common/metrics"
"go.temporal.io/server/common/resolver"
)
type (
DbKind int
)
const (
DbKindUnknown DbKind = iota
DbKindMain
DbKindVisibility
)
type VersionedBlob struct {
Version int64
Data []byte
DataEncoding string
}
type (
// Plugin defines the interface for any SQL database that needs to implement
Plugin interface {
CreateDB(dbKind DbKind, cfg *config.SQL, r resolver.ServiceResolver, l log.Logger, mh metrics.Handler) (GenericDB, error)
}
// TableCRUD defines the API for interacting with the database tables
TableCRUD interface {
ClusterMetadata
Namespace
Visibility
QueueMessage
QueueMetadata
QueueV2Message
QueueV2Metadata
MatchingTask
MatchingTaskV2
MatchingTaskQueue
MatchingTaskQueueUserData
NexusEndpoints
HistoryNode
HistoryTree
HistoryShard
HistoryExecution
HistoryExecutionBuffer
HistoryExecutionActivity
HistoryExecutionChildWorkflow
HistoryExecutionTimer
HistoryExecutionRequestCancel
HistoryExecutionSignal
HistoryExecutionSignalRequest
HistoryExecutionChasm
HistoryImmediateTask
HistoryScheduledTask
HistoryTransferTask
HistoryTimerTask
HistoryReplicationTask
HistoryReplicationDLQTask
HistoryVisibilityTask
}
// AdminCRUD defines admin operations for CLI and test suites
AdminCRUD interface {
CreateSchemaVersionTables() error
ReadSchemaVersion(database string) (string, error)
UpdateSchemaVersion(database string, newVersion string, minCompatibleVersion string) error
WriteSchemaUpdateLog(oldVersion string, newVersion string, manifestMD5 string, desc string) error
ListTables(database string) ([]string, error)
DropTable(table string) error
DropAllTables(database string) error
CreateDatabase(database string) error
DropDatabase(database string) error
Exec(stmt string, args ...interface{}) error
}
// Tx defines the API for a SQL transaction
Tx interface {
TableCRUD
Commit() error
Rollback() error
}
// DB defines the API for regular SQL operations of a Temporal server
DB interface {
TableCRUD
GenericDB
BeginTx(ctx context.Context) (Tx, error)
IsDupEntryError(err error) bool
}
// AdminDB defines the API for admin SQL operations for CLI and testing suites
AdminDB interface {
AdminCRUD
GenericDB
ExpectedVersion() string
VerifyVersion() error
}
GenericDB interface {
DbName() string
PluginName() string
Close() error
}
// Conn defines the API for a single database connection
Conn interface {
Rebind(query string) string
ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error)
NamedExecContext(ctx context.Context, query string, arg interface{}) (sql.Result, error)
GetContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error
SelectContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error
PrepareNamedContext(ctx context.Context, query string) (*sqlx.NamedStmt, error)
}
)
func (k DbKind) String() string {
switch k {
case DbKindMain:
return "main"
case DbKindVisibility:
return "visibility"
default:
return "unknown"
}
}