mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Nikolay TretyakandGitHub
87ea6512d4
<!-- Describe what has changed in this PR --> **What changed?** `Driver` interface (with two implementations) was added to the postgresql persistence package in order to support other drivers than `lib/pq`. Fixes https://github.com/temporalio/temporal/issues/1775 Essentially, this PR does https://github.com/temporalio/temporal/pull/4914 in a backward-compatible and extendable way <!-- Tell your future self why have you made these changes --> **Why?** Since `lib/pq` does not support multi-node clusters <!-- How have you verified this change? Tested locally? Added a unit test? Checked in staging env? --> **How did you test it?** Existing tests <!-- Assuming the worst case, what can be broken when deploying this change to production? --> **Potential risks** No, since you should explicitly change the driver in your config file. However, `connectAttributes` depend on the driver (e.g., `binary_parameters` is supported only by `lib/pq` and is not a part of postresql standard), so one should be careful changing drivers in production. <!-- Is this PR a hotfix candidate or require that a notification be sent to the broader community? (Yes/No) --> **Is hotfix candidate?** No
104 lines
3.1 KiB
Go
104 lines
3.1 KiB
Go
// The MIT License
|
|
//
|
|
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
|
|
//
|
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
// THE SOFTWARE.
|
|
|
|
package postgresql
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
|
|
"github.com/jmoiron/sqlx"
|
|
|
|
"go.temporal.io/server/common/persistence/schema"
|
|
"go.temporal.io/server/common/persistence/sql/sqlplugin"
|
|
"go.temporal.io/server/common/persistence/sql/sqlplugin/postgresql/driver"
|
|
postgresqlschemaV12 "go.temporal.io/server/schema/postgresql/v12"
|
|
)
|
|
|
|
// dbV12 represents a logical connection to mysql database
|
|
type dbV12 struct {
|
|
db
|
|
}
|
|
|
|
var _ sqlplugin.DB = (*dbV12)(nil)
|
|
var _ sqlplugin.Tx = (*dbV12)(nil)
|
|
|
|
// newDB returns an instance of DB, which is a logical
|
|
// connection to the underlying postgresql database
|
|
func newDBV12(
|
|
dbKind sqlplugin.DbKind,
|
|
dbName string,
|
|
dbDriver driver.Driver,
|
|
xdb *sqlx.DB,
|
|
tx *sqlx.Tx,
|
|
) *dbV12 {
|
|
mdb := &dbV12{
|
|
db: db{
|
|
dbKind: dbKind,
|
|
dbName: dbName,
|
|
dbDriver: dbDriver,
|
|
db: xdb,
|
|
tx: tx,
|
|
},
|
|
}
|
|
mdb.conn = xdb
|
|
if tx != nil {
|
|
mdb.conn = tx
|
|
}
|
|
mdb.converter = &converter{}
|
|
return mdb
|
|
}
|
|
|
|
// BeginTx starts a new transaction and returns a reference to the Tx object
|
|
func (pdb *dbV12) BeginTx(ctx context.Context) (sqlplugin.Tx, error) {
|
|
xtx, err := pdb.db.db.BeginTxx(ctx, nil)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return newDB(pdb.dbKind, pdb.dbName, pdb.dbDriver, pdb.db.db, xtx), nil
|
|
}
|
|
|
|
// PluginName returns the name of the mysql plugin
|
|
func (pdb *dbV12) PluginName() string {
|
|
return PluginNameV12
|
|
}
|
|
|
|
// ExpectedVersion returns expected version.
|
|
func (pdb *dbV12) ExpectedVersion() string {
|
|
switch pdb.dbKind {
|
|
case sqlplugin.DbKindMain:
|
|
return postgresqlschemaV12.Version
|
|
case sqlplugin.DbKindVisibility:
|
|
return postgresqlschemaV12.VisibilityVersion
|
|
default:
|
|
panic(fmt.Sprintf("unknown db kind %v", pdb.dbKind))
|
|
}
|
|
}
|
|
|
|
// VerifyVersion verify schema version is up to date
|
|
func (pdb *dbV12) VerifyVersion() error {
|
|
expectedVersion := pdb.ExpectedVersion()
|
|
return schema.VerifyCompatibleVersion(pdb, pdb.dbName, expectedVersion)
|
|
}
|