go.temporal.io/server@v1.23.0/common/persistence/sql/version_checker.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  	"go.temporal.io/server/common/config"
    29  	"go.temporal.io/server/common/persistence/sql/sqlplugin"
    30  	"go.temporal.io/server/common/resolver"
    31  )
    32  
    33  // VerifyCompatibleVersion ensures that the installed version of temporal and visibility
    34  // is greater than or equal to the expected version.
    35  func VerifyCompatibleVersion(
    36  	cfg config.Persistence,
    37  	r resolver.ServiceResolver,
    38  ) error {
    39  
    40  	if err := checkMainDatabase(cfg, r); err != nil {
    41  		return err
    42  	}
    43  	if cfg.StandardVisibilityConfigExist() {
    44  		return checkVisibilityDatabase(cfg, r)
    45  	}
    46  	return nil
    47  }
    48  
    49  func checkMainDatabase(
    50  	cfg config.Persistence,
    51  	r resolver.ServiceResolver,
    52  ) error {
    53  	ds, ok := cfg.DataStores[cfg.DefaultStore]
    54  	if ok && ds.SQL != nil {
    55  		return checkCompatibleVersion(ds.SQL, r, sqlplugin.DbKindMain)
    56  	}
    57  	return nil
    58  }
    59  
    60  func checkVisibilityDatabase(
    61  	cfg config.Persistence,
    62  	r resolver.ServiceResolver,
    63  ) error {
    64  	ds, ok := cfg.DataStores[cfg.VisibilityStore]
    65  	if ok && ds.SQL != nil {
    66  		return checkCompatibleVersion(ds.SQL, r, sqlplugin.DbKindVisibility)
    67  	}
    68  	return nil
    69  }
    70  
    71  func checkCompatibleVersion(
    72  	cfg *config.SQL,
    73  	r resolver.ServiceResolver,
    74  	dbKind sqlplugin.DbKind,
    75  ) error {
    76  	db, err := NewSQLAdminDB(dbKind, cfg, r)
    77  	if err != nil {
    78  		return err
    79  	}
    80  	defer func() { _ = db.Close() }()
    81  
    82  	return db.VerifyVersion()
    83  }