lsst.dax.apdb.config.ApdbConfig Class Reference

Inheritance diagram for lsst.dax.apdb.config.ApdbConfig:

Public Member Functions
ApdbConfig	from_uri (cls, ResourcePathExpression uri)
None	save (self, ResourcePathExpression uri)

Static Public Attributes
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

Static Protected Attributes
ClassVar	_implementation_type [str]

Detailed Description

Base class for APDB configuration types.

This class contains a set of parameters that are common to all
implementations. Implementation-specific parameters are declared in
sub-classes.

Member Function Documentation

from_uri()

ApdbConfig lsst.dax.apdb.config.ApdbConfig.from_uri	(		cls,
		ResourcePathExpression	uri )

Load configuration object from external file.

Parameters
----------
uri : `~lsst.resources.ResourcePathExpression`
    Location of the file containing serialized configuration in YAML
    format.

Returns
-------
config : `ApdbConfig`
    Apdb configuration object.

save()

None lsst.dax.apdb.config.ApdbConfig.save	(		self,
		ResourcePathExpression	uri )

Save configuration to a specified location in YAML format.

Parameters
----------
uri : `ResourcePathExpression`
    Location to save configuration

Member Data Documentation

enable_replica

bool lsst.dax.apdb.config.ApdbConfig.enable_replica

static

Initial value:

=  Field(
        default=False,
        description="If True, make and fill additional tables used for replication.",
    )

read_forced_sources_months

int lsst.dax.apdb.config.ApdbConfig.read_forced_sources_months

static

Initial value:

=  Field(
        default=12,
        description="Number of months of history to read from DiaForcedSource",
    )

read_sources_months

int lsst.dax.apdb.config.ApdbConfig.read_sources_months

static

Initial value:

=  Field(
        default=12,
        description="Number of months of history to read from DiaSource.",
    )

replica_chunk_seconds

int lsst.dax.apdb.config.ApdbConfig.replica_chunk_seconds

static

Initial value:

=  Field(
        default=600,
        description=(
            "Time extent for replica chunks, new chunks are created every specified number of seconds."
        ),
    )

schema_file

str lsst.dax.apdb.config.ApdbConfig.schema_file

static

Initial value:

=  Field(
        default="resource://lsst.sdm.schemas/apdb.yaml",
        description="Location of (YAML) configuration file with standard APDB schema.",
    )

schema_name

str lsst.dax.apdb.config.ApdbConfig.schema_name

static

Initial value:

=  Field(
        default="ApdbSchema",
        description="Name of the schema in YAML configuration file (not used and deprecated).",
    )

ss_schema_file

str lsst.dax.apdb.config.ApdbConfig.ss_schema_file

static

Initial value:

=  Field(
        default="resource://lsst.sdm.schemas/sso.yaml",
        description=(
            "Location of (YAML) configuration file with SSO schema. "
            "This file is only loaded if SSObject/SSSource tables are not present in APDB schema file. "
            "Can be set to empty string to avoid loading even if tables are not in APDB schema."
        ),
    )

---

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

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