// 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 ( "fmt" "strings" "github.com/jmoiron/sqlx" "go.temporal.io/api/serviceerror" "go.temporal.io/server/common/clock" "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/postgresql/driver" "go.temporal.io/server/common/persistence/sql/sqlplugin/postgresql/session" "go.temporal.io/server/common/resolver" ) const ( // PluginName is the name of the plugin PluginName = "postgres12" PluginNamePGX = "postgres12_pgx" ) var ( defaultDatabaseNames = []string{ "postgres", // normal PostgreSQL default DB name "defaultdb", // special behavior for Aiven: #1389 } ) type plugin struct { d driver.Driver } var _ sqlplugin.Plugin = (*plugin)(nil) func init() { sql.RegisterPlugin(PluginName, &plugin{&driver.PQDriver{}}) sql.RegisterPlugin(PluginNamePGX, &plugin{&driver.PGXDriver{}}) } // CreateDB initialize the db object func (d *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 d.createDBConnection(cfg, r) } needsRefresh := d.d.IsConnNeedsRefreshError handle := sqlplugin.NewDatabaseHandle(connect, needsRefresh, logger, metricsHandler, clock.NewRealTimeSource()) db := newDB(dbKind, cfg.DatabaseName, d.d, handle, nil) return db, nil } // CreateAdminDB initialize the adminDB object func (d *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 d.createDBConnection(cfg, r) } needsRefresh := d.d.IsConnNeedsRefreshError handle := sqlplugin.NewDatabaseHandle(connect, needsRefresh, logger, metricsHandler, clock.NewRealTimeSource()) db := newDB(dbKind, cfg.DatabaseName, d.d, 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 (d *plugin) createDBConnection( cfg *config.SQL, resolver resolver.ServiceResolver, ) (*sqlx.DB, error) { if cfg.DatabaseName != "" { postgresqlSession, err := session.NewSession(cfg, d.d, resolver) if err != nil { return nil, err } return postgresqlSession.DB, nil } // database name not provided // try defaults defer func() { cfg.DatabaseName = "" }() var errors []error for _, databaseName := range defaultDatabaseNames { cfg.DatabaseName = databaseName if postgresqlSession, err := session.NewSession( cfg, d.d, resolver, ); err == nil { return postgresqlSession.DB, nil } else { errors = append(errors, err) } } return nil, serviceerror.NewUnavailable( fmt.Sprintf("unable to connect to DB, tried default DB names: %v, errors: %v", strings.Join(defaultDatabaseNames, ","), errors), ) }