lsst.dax.apdb.sql.config.ApdbSqlConfig Class Reference

Inheritance diagram for lsst.dax.apdb.sql.config.ApdbSqlConfig:

Public Member Functions
tuple[str, str]	check_ra_dec (cls, Iterable[str] v)
str	check_dia_object_index (cls, str v)
Public Member Functions inherited from lsst.dax.apdb.config.ApdbConfig
ApdbConfig	from_uri (cls, ResourcePathExpression uri)
None	save (self, ResourcePathExpression uri)

Static Public Attributes
str	db_url = Field(description="SQLAlchemy database connection URI.")
str	namespace
ApdbSqlConnectionConfig	connection_config
ApdbSqlPixelizationConfig	pixelization
str	dia_object_index
tuple	ra_dec_columns
list	dia_object_columns
str	prefix
Static Public Attributes inherited from lsst.dax.apdb.config.ApdbConfig
str	schema_file
str	ss_schema_file
str	schema_name
int	read_sources_months
int	read_forced_sources_months
bool	enable_replica
int	replica_chunk_seconds

Additional Inherited Members
Static Protected Attributes inherited from lsst.dax.apdb.config.ApdbConfig
ClassVar	_implementation_type [str]

Detailed Description

APDB configuration class for SQL implementation (ApdbSql).

Member Data Documentation

connection_config

ApdbSqlConnectionConfig lsst.dax.apdb.sql.config.ApdbSqlConfig.connection_config

static

Initial value:

=  Field(
        default_factory=ApdbSqlConnectionConfig,
        description="Database connection configuration",
    )

dia_object_columns

list lsst.dax.apdb.sql.config.ApdbSqlConfig.dia_object_columns

static

Initial value:

=  Field(
        default=[],
        description="List of columns to read from DiaObject, by default read all columns",
    )

dia_object_index

str lsst.dax.apdb.sql.config.ApdbSqlConfig.dia_object_index

static

Initial value:

=  Field(
        default="baseline",
        description=(
            'Indexing mode for DiaObject table. Allowed value is one of "baseline", '
            '"pix_id_iov", or "last_object_table".'
        ),
    )

namespace

str lsst.dax.apdb.sql.config.ApdbSqlConfig.namespace

static

Initial value:

=  Field(
        default=None,
        description=(
            "Namespace or schema name for all tables in APDB database. "
            "Presently only works for PostgreSQL backend. If schema with this name does "
            "not exist it will be created when APDB tables are created."
        ),
    )

pixelization

ApdbSqlPixelizationConfig lsst.dax.apdb.sql.config.ApdbSqlConfig.pixelization

static

Initial value:

=  Field(
        default_factory=ApdbSqlPixelizationConfig,
        description="Configuration for pixelization.",
    )

prefix

str lsst.dax.apdb.sql.config.ApdbSqlConfig.prefix

static

Initial value:

=  Field(
        default="",
        description="Prefix to add to table names and index names.",
    )

ra_dec_columns

tuple lsst.dax.apdb.sql.config.ApdbSqlConfig.ra_dec_columns

static

Initial value:

=  Field(
        default=("ra", "dec"),
        description="Names of ra/dec columns in DiaObject table.",
    )

---

The documentation for this class was generated from the following file:

• python/lsst/dax/apdb/sql/config.py