Table Reference#

This is an auto-generated reference of all database tables. Documentation comes from model docstrings in the source code. This is comprehensive but technical - concept pages provide better learning material.

How to Use This Reference#

Database Tables#

The following models are defined in the ops-db package. Each entry provides a brief description and links to the full API documentation.

ApiToken#

API tokens for programmatic access to the API

Table name:
api_token
Type:
Database Model
Full documentation:
ccat_ops_db.models.ApiToken

ChaiInparParameter#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
chai_inpar_parameter
Type:
Database Model
Full documentation:
ccat_ops_db.models.ChaiInparParameter

ChaiModuleConfiguration#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
chai_module_configuration
Type:
Database Model
Full documentation:
ccat_ops_db.models.ChaiModuleConfiguration

ChaiObservationConfiguration#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
chai_observation_configuration
Type:
Database Model
Full documentation:
ccat_ops_db.models.ChaiObservationConfiguration

ChaiTiling#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
chai_tiling
Type:
Database Model
Full documentation:
ccat_ops_db.models.ChaiTiling

ConstantElevationSource#

A source that is observed at a constant elevation This class is a subclass of the Source class and inherits all attributes from the Source class.

Table name:
constant_elevation_source
Type:
Database Model
Full documentation:
ccat_ops_db.models.ConstantElevationSource

DataArchive#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
data_archive
Type:
Database Model
Full documentation:
ccat_ops_db.models.DataArchive

DataLocation#

Base class for all data storage locations with polymorphic storage types.

Table name:
data_location
Type:
Database Model
Full documentation:
ccat_ops_db.models.DataLocation

DataTransfer#

Tracks data transfers between locations.

Table name:
data_transfer
Type:
Database Model
Full documentation:
ccat_ops_db.models.DataTransfer

DataTransferLog#

Log entries for data transfers with references to log files. This model implements a lightweight approach where: - Basic status info and log file path are stored in the database - Full command outputs are stored in files - Detailed metrics are stored in InfluxDB

Table name:
data_transfer_log
Type:
Database Model
Full documentation:
ccat_ops_db.models.DataTransferLog

DataTransferPackage#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
data_transfer_package
Type:
Database Model
Full documentation:
ccat_ops_db.models.DataTransferPackage

DataTransferPackagePhysicalCopy#

Tracks physical copies of data transfer packages.

Table name:
data_transfer_package_physical_copy
Type:
Database Model
Full documentation:
ccat_ops_db.models.DataTransferPackagePhysicalCopy

DataTransferRoute#

Defines routes for data transfer between sites and locations. The database implements a flexible routing system that supports: 1. Direct routes between specific locations 2. Relay routes through intermediate sites 3. Custom location-to-location overrides

Table name:
data_transfer_route
Type:
Database Model
Full documentation:
ccat_ops_db.models.DataTransferRoute

DiskDataLocation#

Disk-based storage location.

Table name:
disk_data_location
Type:
Database Model
Full documentation:
ccat_ops_db.models.DiskDataLocation

ExecutedObsUnit#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
executed_obs_unit
Type:
Database Model
Full documentation:
ccat_ops_db.models.ExecutedObsUnit

FixedSource#

A source that has a fixed coordinates This class is a subclass of the Source class and inherits all attributes from the Source class. The class implements the skycoord property that returns a SkyCoord object from the ra_deg and dec_deg columns.

Table name:
fixed_source
Type:
Database Model
Full documentation:
ccat_ops_db.models.FixedSource

Instrument#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
instrument
Type:
Database Model
Full documentation:
ccat_ops_db.models.Instrument

InstrumentModule#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
instrument_module
Type:
Database Model
Full documentation:
ccat_ops_db.models.InstrumentModule

InstrumentModuleConfiguration#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
instrument_module_configuration
Type:
Database Model
Full documentation:
ccat_ops_db.models.InstrumentModuleConfiguration

Line#

A spectral line that is observed by an instrument

Table name:
line
Type:
Database Model
Full documentation:
ccat_ops_db.models.Line

LongTermArchiveTransfer#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
long_term_archive_transfer
Type:
Database Model
Full documentation:
ccat_ops_db.models.LongTermArchiveTransfer

LongTermArchiveTransferLog#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
long_term_archive_transfer_log
Type:
Database Model
Full documentation:
ccat_ops_db.models.LongTermArchiveTransferLog

ObsMode#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
obs_mode
Type:
Database Model
Full documentation:
ccat_ops_db.models.ObsMode

ObsUnit#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
obs_unit
Type:
Database Model
Full documentation:
ccat_ops_db.models.ObsUnit

ObservationConfiguration#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
observation_configuration
Type:
Database Model
Full documentation:
ccat_ops_db.models.ObservationConfiguration

Observatory#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
observatory
Type:
Database Model
Full documentation:
ccat_ops_db.models.Observatory

ObservingProgram#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
observing_program
Type:
Database Model
Full documentation:
ccat_ops_db.models.ObservingProgram

PhysicalCopy#

Base class for tracking physical copies of files across different storage locations. This class implements a polymorphic pattern to track physical copies of different types of files (RawDataFile, RawDataPackage, DataTransferPackage) across different storage locations and types. Each physical copy represents an actual file on disk or other storage medium.

Table name:
physical_copy
Type:
Database Model
Full documentation:
ccat_ops_db.models.PhysicalCopy

PreScheduledSlot#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
pre_scheduled_slot
Type:
Database Model
Full documentation:
ccat_ops_db.models.PreScheduledSlot

PrimeCamModuleConfiguration#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
prime_cam_module_configuration
Type:
Database Model
Full documentation:
ccat_ops_db.models.PrimeCamModuleConfiguration

PrimeCamObservationConfiguration#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
prime_cam_observation_configuration
Type:
Database Model
Full documentation:
ccat_ops_db.models.PrimeCamObservationConfiguration

RawDataFile#

Represents a raw data file from an instrument.

Table name:
raw_data_file
Type:
Database Model
Full documentation:
ccat_ops_db.models.RawDataFile

RawDataFilePhysicalCopy#

Tracks physical copies of individual raw data files.

Table name:
raw_data_file_physical_copy
Type:
Database Model
Full documentation:
ccat_ops_db.models.RawDataFilePhysicalCopy

RawDataPackage#

A raw data package is a bundle of raw data files that were observed in an observation unit. But they should never be larger than 50GB in size.

Table name:
raw_data_package
Type:
Database Model
Full documentation:
ccat_ops_db.models.RawDataPackage

RawDataPackageMetadata#

Model for storing additional metadata for raw data packages. This table stores metadata that is not part of the core database models but is needed for IVOA-compatible metadata generation. It includes: - Instrument-specific parameters - Additional quality metrics - Extended provenance information - Custom metadata fields

Table name:
raw_data_package_metadata
Type:
Database Model
Full documentation:
ccat_ops_db.models.RawDataPackageMetadata

RawDataPackagePhysicalCopy#

Tracks physical copies of raw data packages.

Table name:
raw_data_package_physical_copy
Type:
Database Model
Full documentation:
ccat_ops_db.models.RawDataPackagePhysicalCopy

Role#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
role
Type:
Database Model
Full documentation:
ccat_ops_db.models.Role

S3DataLocation#

S3-compatible object storage location.

Table name:
s3_data_location
Type:
Database Model
Full documentation:
ccat_ops_db.models.S3DataLocation

Site#

Represents a physical or logical site where data can be stored or processed.

Table name:
site
Type:
Database Model
Full documentation:
ccat_ops_db.models.Site

SolarSystemObject#

A source that is a solar system object This class is a subclass of the Source class and inherits all attributes from the Source class.

Table name:
solar_system_object
Type:
Database Model
Full documentation:
ccat_ops_db.models.SolarSystemObject

Source#

A source is a celestial object This class serves as a base class for various types of sources. It is a polymorphic class in SQLAlchemy, not instantiated directly, but used to provide common attributes. Subclasses, implemented as separate database tables, inherit from the source class and can have additional specific attributes. See classes that are based on this class for more information on the implemented types of sources.

Table name:
source
Type:
Database Model
Full documentation:
ccat_ops_db.models.Source

StagingJob#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
staging_job
Type:
Database Model
Full documentation:
ccat_ops_db.models.StagingJob

StagingJobLog#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
staging_job_log
Type:
Database Model
Full documentation:
ccat_ops_db.models.StagingJobLog

SubObservingProgram#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
sub_observing_program
Type:
Database Model
Full documentation:
ccat_ops_db.models.SubObservingProgram

SystemLog#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
system_log
Type:
Database Model
Full documentation:
ccat_ops_db.models.SystemLog

TapeDataLocation#

Tape-based storage location.

Table name:
tape_data_location
Type:
Database Model
Full documentation:
ccat_ops_db.models.TapeDataLocation

Telescope#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
telescope
Type:
Database Model
Full documentation:
ccat_ops_db.models.Telescope

User#

The base class of the class hierarchy. When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Table name:
user
Type:
Database Model
Full documentation:
ccat_ops_db.models.User

For complete technical details including all attributes, relationships, and methods, see the Models API Reference documentation.