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

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

Public Member Functions
None	validate (self)
config.ApdbSqlConfig	to_model (self)
Public Member Functions inherited from lsst.dax.apdb.config.ApdbConfig
ApdbConfig	from_uri (cls, ResourcePathExpression uri)
None	save (self, ResourcePathExpression uri)

Static Public Attributes
	db_url = Field[str](doc="SQLAlchemy database connection URI")
	isolation_level
	connection_pool
	connection_timeout
	sql_echo = Field[bool](doc="If True then pass SQLAlchemy echo option.", default=False)
	dia_object_index
	htm_level = Field[int](doc="HTM indexing level", default=20)
	htm_max_ranges = Field[int](doc="Max number of ranges in HTM envelope", default=64)
	htm_index_column
	ra_dec_columns = ListField[str](default=["ra", "dec"], doc="Names of ra/dec columns in DiaObject table")
	dia_object_columns
	prefix = Field[str](doc="Prefix to add to table names and index names", default="")
	namespace
	timer = Field[bool](doc="If True then print/log timing information", default=False)
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

Legacy APDB configuration class for SQL implementation (ApdbSql).

Member Data Documentation

connection_pool

lsst.dax.apdb.sql.legacy_config.ApdbSqlConfig.connection_pool

static

Initial value:

=  Field[bool](
        doc="If False then disable SQLAlchemy connection pool. Do not use connection pool when forking.",
        default=True,
    )

connection_timeout

lsst.dax.apdb.sql.legacy_config.ApdbSqlConfig.connection_timeout

static

Initial value:

=  Field[float](
        doc=(
            "Maximum time to wait time for database lock to be released before exiting. "
            "Defaults to sqlalchemy defaults if not set."
        ),
        default=None,
        optional=True,
    )

dia_object_columns

lsst.dax.apdb.sql.legacy_config.ApdbSqlConfig.dia_object_columns

static

Initial value:

=  ListField[str](
        doc="List of columns to read from DiaObject, by default read all columns", default=[]
    )

dia_object_index

lsst.dax.apdb.sql.legacy_config.ApdbSqlConfig.dia_object_index

static

Initial value:

=  ChoiceField[str](
        doc="Indexing mode for DiaObject table",
        allowed={
            "baseline": "Index defined in baseline schema",
            "pix_id_iov": "(pixelId, objectId, iovStart) PK",
            "last_object_table": "Separate DiaObjectLast table",
        },
        default="baseline",
    )

htm_index_column

lsst.dax.apdb.sql.legacy_config.ApdbSqlConfig.htm_index_column

static

Initial value:

=  Field[str](
        default="pixelId", doc="Name of a HTM index column for DiaObject and DiaSource tables"
    )

isolation_level

lsst.dax.apdb.sql.legacy_config.ApdbSqlConfig.isolation_level

static

Initial value:

=  ChoiceField[str](
        doc=(
            "Transaction isolation level, if unset then backend-default value "
            "is used, except for SQLite backend where we use READ_UNCOMMITTED. "
            "Some backends may not support every allowed value."
        ),
        allowed={
            "READ_COMMITTED": "Read committed",
            "READ_UNCOMMITTED": "Read uncommitted",
            "REPEATABLE_READ": "Repeatable read",
            "SERIALIZABLE": "Serializable",
        },
        default=None,
        optional=True,
    )

namespace

lsst.dax.apdb.sql.legacy_config.ApdbSqlConfig.namespace

static

Initial value:

=  Field[str](
        doc=(
            "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."
        ),
        default=None,
        optional=True,
    )

---

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

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