lsst.dax.apdb.cassandra.config.ApdbCassandraTimePartitionRange Class Reference

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

Public Member Functions
Iterator[int]	range (self)
Self	from_meta (cls, ApdbMetadataCassandra metadata)
None	save_to_meta (self, ApdbMetadataCassandra metadata)

Static Public Attributes
ClassVar	metadataTimePartitionKey = "config:time-partition-range.json"
int	start
int	end

Detailed Description

Configuration of the time partitions, this is not user-configurable,
but it is reflected in metadata.

Definition at line 261 of file config.py.

Member Function Documentation

from_meta()

Self lsst.dax.apdb.cassandra.config.ApdbCassandraTimePartitionRange.from_meta	(		cls,
		ApdbMetadataCassandra	metadata )

Read this configuration object from metadata table.

Parameters
----------
metadata : `ApdbMetadataCassandra`
    Metadata table.

Returns
-------
range : `ApdbCassandraTimePartitionRange`
    Configuration retrieved from database.

Definition at line 282 of file config.py.

    def from_meta(cls, metadata: ApdbMetadataCassandra) -> Self:
        """Read this configuration object from metadata table.
 
        Parameters
        ----------
        metadata : `ApdbMetadataCassandra`
            Metadata table.
 
        Returns
        -------
        range : `ApdbCassandraTimePartitionRange`
            Configuration retrieved from database.
        """
        time_partitions_str = metadata.get(cls.metadataTimePartitionKey)
        if time_partitions_str is None:
            raise LookupError(f"Key '{cls.metadataTimePartitionKey}' is missing from metadata table.")
        time_partitions_json = json.loads(time_partitions_str)
        return cls.model_validate(time_partitions_json)
 

range()

Iterator[int] lsst.dax.apdb.cassandra.config.ApdbCassandraTimePartitionRange.range

(

self

)

Generate a sequence of partition numbers.

Definition at line 277 of file config.py.

    def range(self) -> Iterator[int]:
        """Generate a sequence of partition numbers."""
        yield from range(self.start, self.end + 1)
 

save_to_meta()

None lsst.dax.apdb.cassandra.config.ApdbCassandraTimePartitionRange.save_to_meta	(		self,
		ApdbMetadataCassandra	metadata )

Save this configuration to metadata table.

Parameters
----------
metadata : `ApdbMetadataCassandra`
    Metadata table.

Definition at line 301 of file config.py.

    def save_to_meta(self, metadata: ApdbMetadataCassandra) -> None:
        """Save this configuration to metadata table.
 
        Parameters
        ----------
        metadata : `ApdbMetadataCassandra`
            Metadata table.
        """
        metadata.set(self.metadataTimePartitionKey, json.dumps(self.model_dump()), force=True)

Member Data Documentation

end

int lsst.dax.apdb.cassandra.config.ApdbCassandraTimePartitionRange.end

static

Initial value:

=  Field(
        description="End partition number (inclusive) for per-time-partition tables that exist in the schema."
    )

Definition at line 273 of file config.py.

metadataTimePartitionKey

lsst.dax.apdb.cassandra.config.ApdbCassandraTimePartitionRange.metadataTimePartitionKey = "config:time-partition-range.json"

static

Definition at line 266 of file config.py.

start

lsst.dax.apdb.cassandra.config.ApdbCassandraTimePartitionRange.start

static

Initial value:

=  Field(
        description="Start partition number for per-time-partition tables that exist in the schema."
    )

Definition at line 269 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