lsst.dax.apdb.factory Namespace Reference

Functions
type[ApdbSql|ApdbCassandra]	apdb_type (ApdbConfig config)
Apdb	make_apdb (ApdbConfig config)
ApdbReplica	make_apdb_replica (ApdbConfig config)

Function Documentation

apdb_type()

type[ApdbSql | ApdbCassandra] lsst.dax.apdb.factory.apdb_type

(

ApdbConfig

config

)

Return Apdb type on Apdb configuration.

Parameters
----------
config : `ApdbConfig`
    Configuration object, sub-class of ApdbConfig.

Returns
-------
type : `type` [`Apdb`]
    Subclass of `Apdb` class.

Raises
------
TypeError
    Raised if type of ``config`` does not match any known types.

Definition at line 35 of file factory.py.

def apdb_type(config: ApdbConfig) -> type[ApdbSql | ApdbCassandra]:
    """Return Apdb type on Apdb configuration.
 
    Parameters
    ----------
    config : `ApdbConfig`
        Configuration object, sub-class of ApdbConfig.
 
    Returns
    -------
    type : `type` [`Apdb`]
        Subclass of `Apdb` class.
 
    Raises
    ------
    TypeError
        Raised if type of ``config`` does not match any known types.
    """
    from .cassandra import ApdbCassandra, ApdbCassandraConfig
    from .sql import ApdbSql, ApdbSqlConfig
 
    if type(config) is ApdbSqlConfig:
        return ApdbSql
    elif type(config) is ApdbCassandraConfig:
        return ApdbCassandra
    raise TypeError(f"Unknown type of config object: {type(config)}")
 
 

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 63 of file factory.py.

def make_apdb(config: ApdbConfig) -> Apdb:
    """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.
    """
    from .cassandra import ApdbCassandra, ApdbCassandraConfig
    from .sql import ApdbSql, ApdbSqlConfig
 
    if type(config) is ApdbSqlConfig:
        return ApdbSql(config)
    elif type(config) is ApdbCassandraConfig:
        return ApdbCassandra(config)
    raise TypeError(f"Unknown type of config object: {type(config)}")
 
 

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 91 of file factory.py.

def make_apdb_replica(config: ApdbConfig) -> ApdbReplica:
    """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.
    """
    from .cassandra import ApdbCassandra, ApdbCassandraConfig
    from .sql import ApdbSql, ApdbSqlConfig
 
    if type(config) is ApdbSqlConfig:
        return ApdbSql(config).get_replica()
    elif type(config) is ApdbCassandraConfig:
        return ApdbCassandra(config).get_replica()
    raise TypeError(f"Unknown type of config object: {type(config)}")