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.

Script reference

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-cassandra command lists the names of APDB keyspaces and associated accounts for a specified Cassandra cluster.

  • delete-cassandra drops an existing APDB instance from a Cassandra cluster.

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

  • metadata provides support for operations on APDB metadata table.

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

Python API reference

lsst.dax.apdb Package

Classes

Apdb()

Abstract interface for APDB.

ApdbCassandra(config)

Implementation of APDB database with Apache Cassandra backend.

ApdbCassandraConfig(*, schema_file, ...)

Configuration class for Cassandra-based APDB implementation.

ApdbConfig(*[, schema_file, schema_name, ...])

Base class for APDB configuration types.

ApdbMetadata()

Interface for accessing APDB metadata.

ApdbReplica()

Abstract interface for APDB replication methods.

ApdbSql(config)

Implementation of APDB interface based on SQL database.

ApdbSqlConfig(*, schema_file, schema_name, ...)

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.

ReplicaChunk(id, last_update_time, unique_id)

Class used for identification of replication chunks.

VersionTuple(major, minor, patch)

Class representing a version number.

lsst.dax.apdb.schema_model Module

Classes

CheckConstraint(name, id, deferrable, ...)

Description of check constraint.

Column(name, id, datatype, length, nullable, ...)

Column representation in schema.

Constraint(name, id, deferrable, initially, ...)

Constraint description, this is a base class, actual constraints will be instances of one of the subclasses.

ExtraDataTypes(value[, names, module, ...])

Additional column data types that we need in dax_apdb.

ForeignKeyConstraint(name, id, deferrable, ...)

Description of foreign key constraint.

Index(name, id, columns, expressions, ...)

Index representation.

Schema(name, id, tables, version, ...)

Complete schema description, collection of tables.

Table(name, id, columns, primary_key, ...)

Description of a single table schema.

UniqueConstraint(name, id, deferrable, ...)

Description of unique constraint.