lsst.dax.apdb.factory Namespace Reference
Functions | |
| Apdb | make_apdb (ApdbConfig config) |
| ApdbReplica | make_apdb_replica (ApdbConfig config) |
| type[ApdbConfig] | config_type_for_name (str type_name) |
Function Documentation
◆ config_type_for_name()
| type[ApdbConfig] lsst.dax.apdb.factory.config_type_for_name | ( | str | type_name | ) |
Return ApdbConfig class matching type name.
Parameters
----------
type_name : `str`
Short type name of Apdb implementation, for now "sql" and "cassandra"
are supported.
Returns
-------
type : `type` [`ApdbConfig`]
Subclass of `ApdbConfig` class.
Raises
------
TypeError
Raised if ``type_name`` does not match any known types.
Definition at line 90 of file factory.py.
90def config_type_for_name(type_name: str) -> type[ApdbConfig]:
91 """Return ApdbConfig class matching type name.
92
93 Parameters
94 ----------
95 type_name : `str`
96 Short type name of Apdb implementation, for now "sql" and "cassandra"
97 are supported.
98
99 Returns
100 -------
101 type : `type` [`ApdbConfig`]
102 Subclass of `ApdbConfig` class.
103
104 Raises
105 ------
106 TypeError
107 Raised if ``type_name`` does not match any known types.
108 """
109 if type_name == "sql":
110 from .sql import ApdbSqlConfig
111
112 return ApdbSqlConfig
113 elif type_name == "cassandra":
114 from .cassandra import ApdbCassandraConfig
115
116 return ApdbCassandraConfig
117
118 raise TypeError(f"Unknown Apdb implementation type name: {type_name}")
◆ make_apdb()
| Apdb lsst.dax.apdb.factory.make_apdb | ( | ApdbConfig | config | ) |
Create Apdb instance based on Apdb configuration.
Parameters
----------
config : `ApdbConfig`
Configuration object, sub-class of ApdbConfig.
Returns
-------
apdb : `Apdb`
Instance of a specific Apdb sub-class.
Raises
------
TypeError
Raised if type of ``config`` does not match any known types.
Definition at line 34 of file factory.py.
34def make_apdb(config: ApdbConfig) -> Apdb:
35 """Create Apdb instance based on Apdb configuration.
36
37 Parameters
38 ----------
39 config : `ApdbConfig`
40 Configuration object, sub-class of ApdbConfig.
41
42 Returns
43 -------
44 apdb : `Apdb`
45 Instance of a specific Apdb sub-class.
46
47 Raises
48 ------
49 TypeError
50 Raised if type of ``config`` does not match any known types.
51 """
52 from .cassandra import ApdbCassandra, ApdbCassandraConfig
53 from .sql import ApdbSql, ApdbSqlConfig
54
55 if type(config) is ApdbSqlConfig:
56 return ApdbSql(config)
57 elif type(config) is ApdbCassandraConfig:
58 return ApdbCassandra(config)
59 raise TypeError(f"Unknown type of config object: {type(config)}")
60
61
◆ make_apdb_replica()
| ApdbReplica lsst.dax.apdb.factory.make_apdb_replica | ( | ApdbConfig | config | ) |
Create ApdbReplica instance based on Apdb configuration.
Parameters
----------
config : `ApdbConfig`
Configuration object, sub-class of ApdbConfig.
Returns
-------
apdb_replica : `ApdbReplica`
Instance of a specific ApdbReplica sub-class.
Raises
------
TypeError
Raised if type of ``config`` does not match any known types.
Definition at line 62 of file factory.py.
62def make_apdb_replica(config: ApdbConfig) -> ApdbReplica:
63 """Create ApdbReplica instance based on Apdb configuration.
64
65 Parameters
66 ----------
67 config : `ApdbConfig`
68 Configuration object, sub-class of ApdbConfig.
69
70 Returns
71 -------
72 apdb_replica : `ApdbReplica`
73 Instance of a specific ApdbReplica sub-class.
74
75 Raises
76 ------
77 TypeError
78 Raised if type of ``config`` does not match any known types.
79 """
80 from .cassandra import ApdbCassandra, ApdbCassandraConfig
81 from .sql import ApdbSql, ApdbSqlConfig
82
83 if type(config) is ApdbSqlConfig:
84 return ApdbSql(config).get_replica()
85 elif type(config) is ApdbCassandraConfig:
86 return ApdbCassandra(config).get_replica()
87 raise TypeError(f"Unknown type of config object: {type(config)}")
88
89
Generated on Mon Apr 21 2025 07:10:13 for LSST Applications by
1.13.2