lsst.dax.apdb  22.0.1-5-g75bb458+273fa57a64
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.dax.apdb.apdbCassandra.ApdbCassandra Class Reference
Inheritance diagram for lsst.dax.apdb.apdbCassandra.ApdbCassandra:
lsst.dax.apdb.apdb.Apdb

Public Member Functions

def __init__ (self, ApdbCassandraConfig config)
 
Optional[TableDeftableDef (self, ApdbTables table)
 
None makeSchema (self, bool drop=False)
 
pandas.DataFrame getDiaObjects (self, sphgeom.Region region)
 
Optional[pandas.DataFrame] getDiaSources (self, sphgeom.Region region, Optional[Iterable[int]] object_ids, dafBase.DateTime visit_time)
 
Optional[pandas.DataFrame] getDiaForcedSources (self, sphgeom.Region region, Optional[Iterable[int]] object_ids, dafBase.DateTime visit_time)
 
None store (self, dafBase.DateTime visit_time, pandas.DataFrame objects, Optional[pandas.DataFrame] sources=None, Optional[pandas.DataFrame] forced_sources=None)
 
None dailyJob (self)
 
int countUnassociatedObjects (self)
 
- Public Member Functions inherited from lsst.dax.apdb.apdb.Apdb
pandas.DataFrame getDiaObjects (self, Region region)
 
Optional[pandas.DataFrame] getDiaSources (self, Region region, Optional[Iterable[int]] object_ids, dafBase.DateTime visit_time)
 
Optional[pandas.DataFrame] getDiaForcedSources (self, Region region, Optional[Iterable[int]] object_ids, dafBase.DateTime visit_time)
 
ConfigurableField makeField (cls, str doc)
 

Public Attributes

 config
 

Static Public Attributes

 partition_zero_epoch = dafBase.DateTime(1970, 1, 1, 0, 0, 0, dafBase.DateTime.TAI)
 
- Static Public Attributes inherited from lsst.dax.apdb.apdb.Apdb
 ConfigClass = ApdbConfig
 

Detailed Description

Implementation of APDB database on to of Apache Cassandra.

The implementation is configured via standard ``pex_config`` mechanism
using `ApdbCassandraConfig` configuration class. For an example of
different configurations check config/ folder.

Parameters
----------
config : `ApdbCassandraConfig`
    Configuration object.

Member Function Documentation

◆ countUnassociatedObjects()

int lsst.dax.apdb.apdbCassandra.ApdbCassandra.countUnassociatedObjects (   self)
Return the number of DiaObjects that have only one DiaSource
associated with them.

Used as part of ap_verify metrics.

Returns
-------
count : `int`
    Number of DiaObjects with exactly one associated DiaSource.

Notes
-----
This method can be very inefficient or slow in some implementations.

Reimplemented from lsst.dax.apdb.apdb.Apdb.

◆ dailyJob()

None lsst.dax.apdb.apdbCassandra.ApdbCassandra.dailyJob (   self)
Implement daily activities like cleanup/vacuum.

What should be done during daily activities is determined by
specific implementation.

Reimplemented from lsst.dax.apdb.apdb.Apdb.

◆ makeSchema()

None lsst.dax.apdb.apdbCassandra.ApdbCassandra.makeSchema (   self,
bool   drop = False 
)
Create or re-create whole database schema.

Parameters
----------
drop : `bool`
    If True then drop all tables before creating new ones.

Reimplemented from lsst.dax.apdb.apdb.Apdb.

◆ store()

None lsst.dax.apdb.apdbCassandra.ApdbCassandra.store (   self,
dafBase.DateTime  visit_time,
pandas.DataFrame  objects,
Optional[pandas.DataFrame]   sources = None,
Optional[pandas.DataFrame]   forced_sources = None 
)
Store all three types of catalogs in the database.

Parameters
----------
visit_time : `lsst.daf.base.DateTime`
    Time of the visit.
objects : `pandas.DataFrame`
    Catalog with DiaObject records.
sources : `pandas.DataFrame`, optional
    Catalog with DiaSource records.
forced_sources : `pandas.DataFrame`, optional
    Catalog with DiaForcedSource records.

Notes
-----
This methods takes DataFrame catalogs, their schema must be
compatible with the schema of APDB table:

  - column names must correspond to database table columns
  - types and units of the columns must match database definitions,
    no unit conversion is performed presently
  - columns that have default values in database schema can be
    omitted from catalog
  - this method knows how to fill interval-related columns of DiaObject
    (validityStart, validityEnd) they do not need to appear in a
    catalog
  - source catalogs have ``diaObjectId`` column associating sources
    with objects

Reimplemented from lsst.dax.apdb.apdb.Apdb.

◆ tableDef()

Optional[TableDef] lsst.dax.apdb.apdbCassandra.ApdbCassandra.tableDef (   self,
ApdbTables  table 
)
Return table schema definition for a given table.

Parameters
----------
table : `ApdbTables`
    One of the known APDB tables.

Returns
-------
tableSchema : `TableDef` or `None`
    Table schema description, `None` is returned if table is not
    defined by this implementation.

Reimplemented from lsst.dax.apdb.apdb.Apdb.


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