LSSTApplications  19.0.0,19.0.0+1,19.0.0+10,19.0.0+13,19.0.0+3,19.0.0+5,19.0.0+9,tickets.DM-22703-ga158cbef15,w.2019.51
LSSTDataManagementBasePackage
Public Member Functions | Static Public Attributes | List of all members
lsst.dax.ppdb.ppdb.PpdbConfig Class Reference
Inheritance diagram for lsst.dax.ppdb.ppdb.PpdbConfig:

Public Member Functions

def validate (self)
 

Static Public Attributes

 db_url = Field(dtype=str, doc="SQLAlchemy database connection URI")
 
 isolation_level
 
 connection_pool
 
 connection_timeout
 
 sql_echo
 
 dia_object_index
 
 dia_object_nightly
 
 read_sources_months
 
 read_forced_sources_months
 
 dia_object_columns
 
 object_last_replace
 
 schema_file
 
 extra_schema_file
 
 column_map
 
 prefix
 
 explain
 
 timer
 
 diaobject_index_hint
 
 dynamic_sampling_hint
 
 cardinality_hint
 

Detailed Description

Definition at line 130 of file ppdb.py.

Member Function Documentation

◆ validate()

def lsst.dax.ppdb.ppdb.PpdbConfig.validate (   self)

Definition at line 203 of file ppdb.py.

203  def validate(self):
204  super().validate()
205  if self.isolation_level == "READ_COMMITTED" and self.db_url.startswith("sqlite"):
206  raise ValueError("Attempting to run Ppdb with SQLITE and isolation level 'READ_COMMITTED.' "
207  "Use 'READ_UNCOMMITTED' instead.")
208 
209 

Member Data Documentation

◆ cardinality_hint

lsst.dax.ppdb.ppdb.PpdbConfig.cardinality_hint
static
Initial value:
= Field(dtype=int,
doc="If non-zero then use cardinality hint",
default=0)

Definition at line 199 of file ppdb.py.

◆ column_map

lsst.dax.ppdb.ppdb.PpdbConfig.column_map
static
Initial value:
= Field(dtype=str,
doc="Location of (YAML) configuration file with column mapping",
default=_data_file_name("ppdb-afw-map.yaml"))

Definition at line 180 of file ppdb.py.

◆ connection_pool

lsst.dax.ppdb.ppdb.PpdbConfig.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)

Definition at line 141 of file ppdb.py.

◆ connection_timeout

lsst.dax.ppdb.ppdb.PpdbConfig.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)

Definition at line 145 of file ppdb.py.

◆ db_url

lsst.dax.ppdb.ppdb.PpdbConfig.db_url = Field(dtype=str, doc="SQLAlchemy database connection URI")
static

Definition at line 132 of file ppdb.py.

◆ dia_object_columns

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

Definition at line 168 of file ppdb.py.

◆ dia_object_index

lsst.dax.ppdb.ppdb.PpdbConfig.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')

Definition at line 153 of file ppdb.py.

◆ dia_object_nightly

lsst.dax.ppdb.ppdb.PpdbConfig.dia_object_nightly
static
Initial value:
= Field(dtype=bool,
doc="Use separate nightly table for DiaObject",
default=False)

Definition at line 159 of file ppdb.py.

◆ diaobject_index_hint

lsst.dax.ppdb.ppdb.PpdbConfig.diaobject_index_hint
static
Initial value:
= Field(dtype=str,
doc="Name of the index to use with Oracle index hint",
default=None,
optional=True)

Definition at line 192 of file ppdb.py.

◆ dynamic_sampling_hint

lsst.dax.ppdb.ppdb.PpdbConfig.dynamic_sampling_hint
static
Initial value:
= Field(dtype=int,
doc="If non-zero then use dynamic_sampling hint",
default=0)

Definition at line 196 of file ppdb.py.

◆ explain

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

Definition at line 186 of file ppdb.py.

◆ extra_schema_file

lsst.dax.ppdb.ppdb.PpdbConfig.extra_schema_file
static
Initial value:
= Field(dtype=str,
doc="Location of (YAML) configuration file with extra schema",
default=_data_file_name("ppdb-schema-extra.yaml"))

Definition at line 177 of file ppdb.py.

◆ isolation_level

lsst.dax.ppdb.ppdb.PpdbConfig.isolation_level
static
Initial value:
= ChoiceField(dtype=str,
doc="Transaction isolation level",
allowed={"READ_COMMITTED": "Read committed",
"READ_UNCOMMITTED": "Read uncommitted",
"REPEATABLE_READ": "Repeatable read",
"SERIALIZABLE": "Serializable"},
default="READ_COMMITTED",
optional=True)

Definition at line 133 of file ppdb.py.

◆ object_last_replace

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

Definition at line 171 of file ppdb.py.

◆ prefix

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

Definition at line 183 of file ppdb.py.

◆ read_forced_sources_months

lsst.dax.ppdb.ppdb.PpdbConfig.read_forced_sources_months
static
Initial value:
= Field(dtype=int,
doc="Number of months of history to read from DiaForcedSource",
default=12)

Definition at line 165 of file ppdb.py.

◆ read_sources_months

lsst.dax.ppdb.ppdb.PpdbConfig.read_sources_months
static
Initial value:
= Field(dtype=int,
doc="Number of months of history to read from DiaSource",
default=12)

Definition at line 162 of file ppdb.py.

◆ schema_file

lsst.dax.ppdb.ppdb.PpdbConfig.schema_file
static
Initial value:
= Field(dtype=str,
doc="Location of (YAML) configuration file with standard schema",
default=_data_file_name("ppdb-schema.yaml"))

Definition at line 174 of file ppdb.py.

◆ sql_echo

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

Definition at line 150 of file ppdb.py.

◆ timer

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

Definition at line 189 of file ppdb.py.


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