Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

# This file is part of daf_butler. 

# 

# Developed for the LSST Data Management System. 

# This product includes software developed by the LSST Project 

# (http://www.lsst.org). 

# See the COPYRIGHT file at the top-level directory of this distribution 

# for details of code ownership. 

# 

# This program is free software: you can redistribute it and/or modify 

# it under the terms of the GNU General Public License as published by 

# the Free Software Foundation, either version 3 of the License, or 

# (at your option) any later version. 

# 

# This program is distributed in the hope that it will be useful, 

# but WITHOUT ANY WARRANTY; without even the implied warranty of 

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

# GNU General Public License for more details. 

# 

# You should have received a copy of the GNU General Public License 

# along with this program. If not, see <http://www.gnu.org/licenses/>. 

 

from __future__ import annotations 

 

__all__ = ("RegistryConfig",) 

 

from typing import Type, TYPE_CHECKING 

 

from lsst.utils import doImport 

 

from ..core import ConfigSubset 

from ..core.repoRelocation import replaceRoot 

from .connectionString import ConnectionStringFactory 

 

34 ↛ 35line 34 didn't jump to line 35, because the condition on line 34 was never trueif TYPE_CHECKING: 

from .interfaces import Database 

 

 

class RegistryConfig(ConfigSubset): 

component = "registry" 

requiredKeys = ("db",) 

defaultConfigFile = "registry.yaml" 

 

def getDialect(self): 

"""Parses the `db` key of the config and returns the database dialect. 

 

Returns 

------- 

dialect : `str` 

Dialect found in the connection string. 

""" 

conStr = ConnectionStringFactory.fromConfig(self) 

return conStr.get_backend_name() 

 

def getDatabaseClass(self) -> Type[Database]: 

"""Returns the `Database` class targeted by configuration values. 

 

The appropriate class is determined by parsing the `db` key to extract 

the dialect, and then looking that up under the `engines` key of the 

registry config. 

""" 

dialect = self.getDialect() 

if dialect not in self["engines"]: 

raise ValueError(f"Connection string dialect has no known aliases. Received: {dialect}") 

databaseClass = self["engines", dialect] 

return doImport(databaseClass) 

 

def makeDefaultDatabaseUri(self, root: str): 

"""Return a default 'db' URI for the registry configured here that is 

appropriate for a new empty repository with the given root. 

 

Parameters 

---------- 

root : `str` 

Filesystem path to the root of the data repository. 

 

Returns 

------- 

uri : `str` 

URI usable as the 'db' string in a `RegistryConfig`. 

""" 

DatabaseClass = self.getDatabaseClass() 

return DatabaseClass.makeDefaultUri(root) 

 

def replaceRoot(self, root: str): 

"""Replace any occurrences of `BUTLER_ROOT_TAG` in the connection 

with the given root directory. 

""" 

self["db"] = replaceRoot(self["db"], root) 

 

@property 

def connectionString(self): 

"""Return the connection string to the underlying database 

(`sqlalchemy.engine.url.URL`). 

""" 

return ConnectionStringFactory.fromConfig(self)