mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Daniel KimandGitHub
6ac5c584d7
## What changed? SQL config now supports passing a connect function. ## Why? It's currently not possible to embed a Temporal server to a host application where the database connection is managed by the host application and is provided as a database connector. This allows the host application to pass a db connector rather than the the individual sql config strings. ## How did you test it? I have embedded this code into a custom application and verified that the connector is working properly. ## Potential risks This is a non-breaking change with very minimal risks. ## Is hotfix candidate? No.
105 lines
3.3 KiB
Go
105 lines
3.3 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 mysql
|
|
|
|
import (
|
|
"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/persistence/sql"
|
|
"go.temporal.io/server/common/persistence/sql/sqlplugin"
|
|
"go.temporal.io/server/common/persistence/sql/sqlplugin/mysql/session"
|
|
"go.temporal.io/server/common/resolver"
|
|
)
|
|
|
|
const (
|
|
// PluginName is the name of the plugin
|
|
PluginName = "mysql8"
|
|
)
|
|
|
|
type plugin struct{}
|
|
|
|
var _ sqlplugin.Plugin = (*plugin)(nil)
|
|
|
|
func init() {
|
|
sql.RegisterPlugin(PluginName, &plugin{})
|
|
}
|
|
|
|
// CreateDB initialize the db object
|
|
func (p *plugin) CreateDB(
|
|
dbKind sqlplugin.DbKind,
|
|
cfg *config.SQL,
|
|
r resolver.ServiceResolver,
|
|
logger log.Logger,
|
|
metricsHandler metrics.Handler,
|
|
) (sqlplugin.DB, error) {
|
|
connect := func() (*sqlx.DB, error) {
|
|
if cfg.Connect != nil {
|
|
return cfg.Connect(cfg)
|
|
}
|
|
return p.createDBConnection(dbKind, cfg, r)
|
|
}
|
|
handle := sqlplugin.NewDatabaseHandle(connect, isConnNeedsRefreshError, logger, metricsHandler)
|
|
db := newDB(dbKind, cfg.DatabaseName, handle, nil)
|
|
return db, nil
|
|
}
|
|
|
|
// CreateAdminDB initialize the db object
|
|
func (p *plugin) CreateAdminDB(
|
|
dbKind sqlplugin.DbKind,
|
|
cfg *config.SQL,
|
|
r resolver.ServiceResolver,
|
|
logger log.Logger,
|
|
metricsHandler metrics.Handler,
|
|
) (sqlplugin.AdminDB, error) {
|
|
connect := func() (*sqlx.DB, error) {
|
|
if cfg.Connect != nil {
|
|
return cfg.Connect(cfg)
|
|
}
|
|
return p.createDBConnection(dbKind, cfg, r)
|
|
}
|
|
handle := sqlplugin.NewDatabaseHandle(connect, isConnNeedsRefreshError, logger, metricsHandler)
|
|
db := newDB(dbKind, cfg.DatabaseName, handle, nil)
|
|
return db, nil
|
|
}
|
|
|
|
// CreateDBConnection creates a returns a reference to a logical connection to the
|
|
// underlying SQL database. The returned object is to tied to a single
|
|
// SQL database and the object can be used to perform CRUD operations on
|
|
// the tables in the database
|
|
func (p *plugin) createDBConnection(
|
|
dbKind sqlplugin.DbKind,
|
|
cfg *config.SQL,
|
|
resolver resolver.ServiceResolver,
|
|
) (*sqlx.DB, error) {
|
|
mysqlSession, err := session.NewSession(dbKind, cfg, resolver)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return mysqlSession.DB, nil
|
|
}
|