lsst.dax.apdb  22.0.1-5-g75bb458+69f4987056
Public Member Functions | Static Public Attributes | List of all members
lsst.dax.apdb.apdbSql.ApdbSqlConfig Class Reference
Inheritance diagram for lsst.dax.apdb.apdbSql.ApdbSqlConfig:
lsst.dax.apdb.apdb.ApdbConfig

Public Member Functions

None validate (self)
 

Static Public Attributes

 db_url
 
 isolation_level
 
 connection_pool
 
 connection_timeout
 
 sql_echo
 
 dia_object_index
 
 htm_level
 
 htm_max_ranges
 
 htm_index_column
 
 ra_dec_columns
 
 dia_object_columns
 
 object_last_replace
 
 prefix
 
 explain
 
 timer
 
- Static Public Attributes inherited from lsst.dax.apdb.apdb.ApdbConfig
 read_sources_months
 
 read_forced_sources_months
 
 schema_file
 
 extra_schema_file
 

Detailed Description

APDB configuration class for SQL implementation (ApdbSql).

Member Data Documentation

◆ connection_pool

lsst.dax.apdb.apdbSql.ApdbSqlConfig.connection_pool
static
Initial value:
= Field(
dtype=bool,
doc="If False then disable SQLAlchemy connection pool. "
"Do not use connection pool when forking.",
default=True
)

◆ connection_timeout

lsst.dax.apdb.apdbSql.ApdbSqlConfig.connection_timeout
static
Initial value:
= Field(
dtype=float,
doc="Maximum time to wait time for database lock to be released before "
"exiting. Defaults to sqlachemy defaults if not set.",
default=None,
optional=True
)

◆ db_url

lsst.dax.apdb.apdbSql.ApdbSqlConfig.db_url
static
Initial value:
= Field(
dtype=str,
doc="SQLAlchemy database connection URI"
)

◆ dia_object_columns

lsst.dax.apdb.apdbSql.ApdbSqlConfig.dia_object_columns
static
Initial value:
= ListField(
dtype=str,
doc="List of columns to read from DiaObject, by default read all columns",
default=[]
)

◆ dia_object_index

lsst.dax.apdb.apdbSql.ApdbSqlConfig.dia_object_index
static
Initial value:
= ChoiceField(
dtype=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'
)

◆ explain

lsst.dax.apdb.apdbSql.ApdbSqlConfig.explain
static
Initial value:
= Field(
dtype=bool,
doc="If True then run EXPLAIN SQL command on each executed query",
default=False
)

◆ htm_index_column

lsst.dax.apdb.apdbSql.ApdbSqlConfig.htm_index_column
static
Initial value:
= Field(
dtype=str,
default="pixelId",
doc="Name of a HTM index column for DiaObject and DiaSource tables"
)

◆ htm_level

lsst.dax.apdb.apdbSql.ApdbSqlConfig.htm_level
static
Initial value:
= Field(
dtype=int,
doc="HTM indexing level",
default=20
)

◆ htm_max_ranges

lsst.dax.apdb.apdbSql.ApdbSqlConfig.htm_max_ranges
static
Initial value:
= Field(
dtype=int,
doc="Max number of ranges in HTM envelope",
default=64
)

◆ isolation_level

lsst.dax.apdb.apdbSql.ApdbSqlConfig.isolation_level
static
Initial value:
= ChoiceField(
dtype=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
)

◆ object_last_replace

lsst.dax.apdb.apdbSql.ApdbSqlConfig.object_last_replace
static
Initial value:
= Field(
dtype=bool,
doc="If True (default) then use \"upsert\" for DiaObjectsLast table",
default=True
)

◆ prefix

lsst.dax.apdb.apdbSql.ApdbSqlConfig.prefix
static
Initial value:
= Field(
dtype=str,
doc="Prefix to add to table names and index names",
default=""
)

◆ ra_dec_columns

lsst.dax.apdb.apdbSql.ApdbSqlConfig.ra_dec_columns
static
Initial value:
= ListField(
dtype=str,
default=["ra", "decl"],
doc="Names ra/dec columns in DiaObject table"
)

◆ sql_echo

lsst.dax.apdb.apdbSql.ApdbSqlConfig.sql_echo
static
Initial value:
= Field(
dtype=bool,
doc="If True then pass SQLAlchemy echo option.",
default=False
)

◆ timer

lsst.dax.apdb.apdbSql.ApdbSqlConfig.timer
static
Initial value:
= Field(
dtype=bool,
doc="If True then print/log timing information",
default=False
)

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