github.com/dolthub/dolt/go@v0.40.5-0.20240520175717-68db7794bea6/libraries/doltcore/dbfactory/dirtodbname.go (about)

     1  // Copyright 2023 Dolthub, Inc.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package dbfactory
    16  
    17  import (
    18  	"os"
    19  	"strings"
    20  	"unicode"
    21  
    22  	"github.com/dolthub/dolt/go/libraries/doltcore/dconfig"
    23  )
    24  
    25  // DirToDBName takes the physical directory name, |dirName|, and replaces any unsupported characters to create a
    26  // valid logical database name. For example, spaces are replaced with underscores.
    27  func DirToDBName(dirName string) string {
    28  	// this environment variable is used whether to replace hyphen and space characters in the database name with underscores.
    29  	if os.Getenv(dconfig.EnvDbNameReplace) == "" {
    30  		return dirName
    31  	}
    32  
    33  	dbName := strings.TrimSpace(dirName)
    34  	dbName = strings.Map(func(r rune) rune {
    35  		if unicode.IsSpace(r) || r == '-' {
    36  			return '_'
    37  		}
    38  		return r
    39  	}, dbName)
    40  
    41  	newDBName := strings.ReplaceAll(dbName, "__", "_")
    42  
    43  	for dbName != newDBName {
    44  		dbName = newDBName
    45  		newDBName = strings.ReplaceAll(dbName, "__", "_")
    46  	}
    47  
    48  	return dbName
    49  }