go.temporal.io/server@v1.23.0/common/persistence/sql/store.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  package sql
    26  
    27  import (
    28  	"fmt"
    29  
    30  	"go.temporal.io/server/common/config"
    31  	"go.temporal.io/server/common/persistence/sql/sqlplugin"
    32  	"go.temporal.io/server/common/resolver"
    33  )
    34  
    35  var supportedPlugins = map[string]sqlplugin.Plugin{}
    36  
    37  // RegisterPlugin will register a SQL plugin
    38  func RegisterPlugin(pluginName string, plugin sqlplugin.Plugin) {
    39  	if _, ok := supportedPlugins[pluginName]; ok {
    40  		panic("plugin " + pluginName + " already registered")
    41  	}
    42  	supportedPlugins[pluginName] = plugin
    43  }
    44  
    45  // NewSQLDB creates a returns a reference to a logical connection to the
    46  // underlying SQL database. The returned object is to tied to a single
    47  // SQL database and the object can be used to perform CRUD operations on
    48  // the tables in the database
    49  func NewSQLDB(
    50  	dbKind sqlplugin.DbKind,
    51  	cfg *config.SQL,
    52  	r resolver.ServiceResolver,
    53  ) (sqlplugin.DB, error) {
    54  	plugin, ok := supportedPlugins[cfg.PluginName]
    55  
    56  	if !ok {
    57  		return nil, fmt.Errorf("not supported plugin %v, only supported: %v", cfg.PluginName, supportedPlugins)
    58  	}
    59  
    60  	return plugin.CreateDB(dbKind, cfg, r)
    61  }
    62  
    63  // NewSQLAdminDB returns a AdminDB
    64  func NewSQLAdminDB(
    65  	dbKind sqlplugin.DbKind,
    66  	cfg *config.SQL,
    67  	r resolver.ServiceResolver,
    68  ) (sqlplugin.AdminDB, error) {
    69  	plugin, ok := supportedPlugins[cfg.PluginName]
    70  	if !ok {
    71  		return nil, fmt.Errorf("not supported plugin %v, only supported: %v", cfg.PluginName, supportedPlugins)
    72  	}
    73  
    74  	return plugin.CreateAdminDB(dbKind, cfg, r)
    75  }