lsst.dax.apdb

Contributing

lsst.dax.apdb is developed at https://github.com/lsst/dax_apdb. You can find Jira issues for this module under the dax_apdb component.

Python API reference

lsst.dax.apdb Package

Classes

Apdb()

Abstract interface for APDB.

ApdbCassandra(config)

Implementation of APDB database on to of Apache Cassandra.

ApdbCassandraConfig(*args, **kw)

Configuration class for Cassandra-based APDB implementation.

ApdbConfig(*args, **kw)

Part of Apdb configuration common to all implementations.

ApdbInsertId(id, insert_time)

Class used to identify single insert operation.

ApdbMetadata()

Interface for accessing APDB metadata.

ApdbSql(config)

Implementation of APDB interface based on SQL database.

ApdbSqlConfig(*args, **kw)

APDB configuration class for SQL implementation (ApdbSql).

ApdbTableData()

Abstract class for representing table data.

ApdbTables(value[, names, module, qualname, ...])

Names of the tables in APDB schema.

IncompatibleVersionError

Exception raised when version numbers are not compatible.

VersionTuple(major, minor, patch)

Class representing a version number.

Command line tools

This package provides a command line utility that can be used for some management operations. The name of the CLI script is apdb-cli and it has a number of subcommands:

  • create-sql is used to create new APDB instances based on SQL relational database technology.

  • create-cassandra is used to create new APDB instances based on Cassandra storage technology.

  • list-index dumps the contents of the APDB index file.

Each sub-command provides command line help describing its arguments.