Inheritance diagram for lsst.dax.apdb.cassandra.config.ApdbCassandraConfig:

Public Member Functions
tuple[str, str]	check_ra_dec (cls, Iterable[str] v)

ApdbConfig	from_uri (cls, ResourcePathExpression uri)

None	save (self, ResourcePathExpression uri)

Static Public Attributes
tuple	contact_points

str	keyspace

ApdbCassandraConnectionConfig	connection_config

ApdbCassandraPartitioningConfig	partitioning

list	dia_object_columns

str	prefix

tuple	ra_dec_columns

bool	replica_skips_diaobjects

int	replica_sub_chunk_count

int	batch_statement_limit

int	batch_size_limit

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

Configuration class for Cassandra-based APDB implementation.

Definition at line 181 of file config.py.

Member Function Documentation

◆ check_ra_dec()

tuple[str, str] lsst.dax.apdb.cassandra.config.ApdbCassandraConfig.check_ra_dec	(		cls,
		Iterable[str]	v )

Definition at line 252 of file config.py.

    def check_ra_dec(cls, v: Iterable[str]) -> tuple[str, str]:
        # This validation method is needed in case we initialize model from
        # JSON in strict mode, in that mode JSON list is rejected by default.
        vtup = tuple(v)
        if len(vtup) != 2:
            raise ValueError("ra_dec_columns must have exactly two column names")
        return vtup
 
 

◆ from_uri()

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

inherited

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.

Definition at line 91 of file config.py.

    def from_uri(cls, uri: ResourcePathExpression) -> ApdbConfig:
        """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.
        """
        if isinstance(uri, str) and uri.startswith("label:"):
            tag, _, label = uri.partition(":")
            index = ApdbIndex()
            # Try to find YAML format first, and pex_config if YAML is not
            # found. During transitional period we support conversion of
            # pex_config format to a new pydantic format.
            try:
                uri = index.get_apdb_uri(label, "yaml")
            except ValueError as yaml_exc:
                try:
                    uri = index.get_apdb_uri(label, "pex_config")
                except ValueError:
                    # If none is found then re-raise exception from yaml
                    # attempt, but add a note that pex_config is missing too.
                    yaml_exc.add_note(f"Legacy label {label}/pex_config is also missing.")
                    raise yaml_exc from None
 
        path = ResourcePath(uri)
        config_bytes = path.read()
 
        # During transitional period we support loading of configurations from
        # both pex_config and pydantic/YAML formats. We have to look at the
        # contents for figure out which is which.
        if config_bytes.startswith(b"import lsst.dax.apdb"):
            from . import legacy_config
 
            pex_config = legacy_config.ApdbConfig.legacy_load(config_bytes)
            new_config = pex_config.to_model()
            warnings.warn(
                (
                    f"APDB is instantiated using legacy pex_config format from file {path}. "
                    "Support for pex_config format will be removed after v29. Please update "
                    "configuration to new YAML format with `apdb-cli convert-legacy-config` command."
                ),
                category=FutureWarning,
                stacklevel=2,
            )
            return new_config
 
        config_object = yaml.full_load(config_bytes)
        if not isinstance(config_object, Mapping):
            raise TypeError("YAML configuration file does not represent valid object")
        config_dict: dict[str, Any] = dict(config_object)
        type_name = config_dict.pop("implementation_type", None)
        if not type_name:
            raise LookupError("YAML configuration file does not have `implementation_type` key")
        klass = config_type_for_name(cast(str, type_name))
        return klass.model_validate(config_dict)
 

◆ save()

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

inherited

Save configuration to a specified location in YAML format.

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

Definition at line 154 of file config.py.

    def save(self, uri: ResourcePathExpression) -> None:
        """Save configuration to a specified location in YAML format.
 
        Parameters
        ----------
        uri : `ResourcePathExpression`
            Location to save configuration
        """
        config_dict = self.model_dump(exclude_unset=True, exclude_defaults=True)
        config_dict["implementation_type"] = self._implementation_type
        config_yaml = yaml.dump(config_dict)
 
        path = ResourcePath(uri)
        path.write(config_yaml.encode())

Member Data Documentation

◆ _implementation_type

ClassVar lsst.dax.apdb.config.ApdbConfig._implementation_type [str]

staticprotectedinherited

Definition at line 47 of file config.py.

◆ batch_size_limit

int lsst.dax.apdb.cassandra.config.ApdbCassandraConfig.batch_size_limit

static

Initial value:

=  Field(
        default=1_000_000,
        description=(
            "Limit on a size of BatchStatement in bytes. Batch size is estimated approximately. "
            "Set to 0 or negative to disable this limit. "
            "Server-side batch size warning threshold needs to be set to at least this value."
        ),
    )

Definition at line 241 of file config.py.

◆ batch_statement_limit

int lsst.dax.apdb.cassandra.config.ApdbCassandraConfig.batch_statement_limit

static

Initial value:

=  Field(
        default=65_535,
        description=(
            "Limit on a number of rows in a BatchStatement. Default is the same as Cassandra limit of 65535."
        ),
    )

Definition at line 234 of file config.py.

◆ connection_config

ApdbCassandraConnectionConfig lsst.dax.apdb.cassandra.config.ApdbCassandraConfig.connection_config

static

Initial value:

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

Definition at line 196 of file config.py.

◆ contact_points

tuple lsst.dax.apdb.cassandra.config.ApdbCassandraConfig.contact_points

static

Initial value:

=  Field(
        default=("127.0.0.1",),
        description="The list of contact points to try connecting for cluster discovery.",
    )

Definition at line 186 of file config.py.

◆ dia_object_columns

list lsst.dax.apdb.cassandra.config.ApdbCassandraConfig.dia_object_columns

static

Initial value:

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

Definition at line 206 of file config.py.

◆ enable_replica

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

staticinherited

Initial value:

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

Definition at line 78 of file config.py.

◆ keyspace

str lsst.dax.apdb.cassandra.config.ApdbCassandraConfig.keyspace

static

Initial value:

=  Field(
        default="apdb",
        description="Keyspace name for APDB tables.",
    )

Definition at line 191 of file config.py.

◆ partitioning

ApdbCassandraPartitioningConfig lsst.dax.apdb.cassandra.config.ApdbCassandraConfig.partitioning

static

Initial value:

=  Field(
        default_factory=ApdbCassandraPartitioningConfig,
        description="Configuration for partitioning.",
    )

Definition at line 201 of file config.py.

◆ prefix

str lsst.dax.apdb.cassandra.config.ApdbCassandraConfig.prefix

static

Initial value:

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

Definition at line 211 of file config.py.

◆ ra_dec_columns

tuple lsst.dax.apdb.cassandra.config.ApdbCassandraConfig.ra_dec_columns

static

Initial value:

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

Definition at line 216 of file config.py.

◆ read_forced_sources_months

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

staticinherited

Initial value:

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

Definition at line 73 of file config.py.

◆ read_sources_months

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

staticinherited

Initial value:

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

Definition at line 68 of file config.py.

◆ replica_chunk_seconds

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

staticinherited

Initial value:

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

Definition at line 83 of file config.py.

◆ replica_skips_diaobjects

bool lsst.dax.apdb.cassandra.config.ApdbCassandraConfig.replica_skips_diaobjects

static

Initial value:

=  Field(
        default=False,
        description=(
            "If True then do not store DiaObjects when enable_replica is True "
            "(DiaObjectsChunks has the same data)."
        ),
    )

Definition at line 221 of file config.py.

◆ replica_sub_chunk_count

int lsst.dax.apdb.cassandra.config.ApdbCassandraConfig.replica_sub_chunk_count

static

Initial value:

=  Field(
        default=64,
        description="Number of sub-partitions in replica chunk tables.",
    )

Definition at line 229 of file config.py.

◆ schema_file

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

staticinherited

Initial value:

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

Definition at line 49 of file config.py.

◆ schema_name

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

staticinherited

Initial value:

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

Definition at line 63 of file config.py.

◆ ss_schema_file

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

staticinherited

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."
        ),
    )

Definition at line 54 of file config.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/dax_apdb/gb88ae4c679+7dec8f19df/python/lsst/dax/apdb/cassandra/config.py

Public Member Functions

Static Public Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ check_ra_dec()

◆ from_uri()

◆ save()

Member Data Documentation

◆ _implementation_type

◆ batch_size_limit

◆ batch_statement_limit

◆ connection_config

◆ contact_points

◆ dia_object_columns

◆ enable_replica

◆ keyspace

◆ partitioning

◆ prefix

◆ ra_dec_columns

◆ read_forced_sources_months

◆ read_sources_months

◆ replica_chunk_seconds

◆ replica_skips_diaobjects

◆ replica_sub_chunk_count

◆ schema_file

◆ schema_name

◆ ss_schema_file