adds access to archive database to sdssdb

CHANGELOG.rst

@@ -5,6 +5,7 @@ Changelog
 
 This document records the main changes to the ``sdssdb`` code.
 
+* Added ``archive`` database with ``sas`` schema.
 * Added ``TIC v8``.
 * :release:`0.2.2 <2019-07-24>`
 * Fixed import of database connections when Peewee or SQLAlchemy are not available.

docs/sphinx/intro.rst

@@ -38,6 +38,8 @@ Currently, we support the following databases and schemas:
 * **sdss5db**: the SDSS-V development database.
     * *catalogdb*: schema for source catalogues used for target selection.
     * *targetdb*: schema with the results of the target selection and positioner information.
+* **archive**: the SDSS science archive database.
+    * *sas*: schema for SAS.
 
 Note that the level of readiness is not necessarily identical in both Peewee and SQLAlchemy. This table summarises what schemas are available for each library. Green indicates fully supported, yellow partial support, and red means that there are currently not model classes available for that schema. You can download the graph visualisation of the schema, showing the tables, columns, and relations between tables.
 
@@ -111,6 +113,13 @@ Note that the level of readiness is not necessarily identical in both Peewee and
             <td class="warning"></td>
             <td align="center"><a class="glyphicon glyphicon-download-alt" href="_static/schema_graphs/auto/sdss5db.targetdb.pdf"></a></td>
         </tr>
+        <tr>
+            <td class="active">archive</td>
+            <td class="active">sas</td>
+            <td class="danger"></td>
+            <td class="success"></td>
+            <td align="center"><a class="glyphicon glyphicon-download-alt" href="schema/archive/archive_sas.pdf"></a></td>
+        </tr>
         </tbody>
     </table>
 

python/sdssdb/sqlalchemy/archive/__init__.py

@@ -0,0 +1,24 @@
+# !usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+# Licensed under a 3-clause BSD license.
+#
+# @Author: Brian Cherinka
+# @Date:   2018-09-23 16:06:18
+# @Last modified by: José Sánchez-Gallego ([email protected])
+# @Last Modified time: 2018-10-10 11:25:13
+
+from __future__ import print_function, division, absolute_import
+
+from sdssdb.connection import SQLADatabaseConnection
+from sqlalchemy.ext.declarative import declarative_base, DeferredReflection
+from sdssdb.sqlalchemy import BaseModel
+
+# we need a shared common Base when joining across multiple schema
+ArchiveBase = declarative_base(cls=(DeferredReflection, BaseModel,))
+
+class ArchiveDatabaseConnection(SQLADatabaseConnection):
+    dbname = 'archive_20190507'
+    base = ArchiveBase
+
+database = ArchiveDatabaseConnection(autoconnect=True)

python/sdssdb/sqlalchemy/archive/sas.py

@@ -0,0 +1,142 @@
+# !usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+# Licensed under a 3-clause BSD license.
+#
+# @Author: Joel Brownstein
+# @Date:   2019-08-01 06:54:15
+# @Last modified by: N Benjamin Murphy ([email protected])
+# @Date:   2019-09-04 16:31:00
+
+from __future__ import absolute_import, division, print_function
+
+from sdssdb.sqlalchemy.archive import database, ArchiveBase, sas
+from sqlalchemy import Column, Float, and_, case, cast, select
+from sqlalchemy.engine import reflection
+from sqlalchemy.ext.declarative import AbstractConcreteBase, declared_attr
+from sqlalchemy.ext.hybrid import hybrid_property
+from sqlalchemy.orm import relationship
+from sqlalchemy.types import Integer
+
+SCHEMA = 'sas'
+
+
+class Base(AbstractConcreteBase, ArchiveBase):
+    __abstract__ = True
+    _schema = SCHEMA
+    _relations = 'define_relations'
+
+    @declared_attr
+    def __table_args__(cls):
+        return {'schema': cls._schema}
+
+
+class Root(Base):
+    __tablename__ = 'root'
+    print_fields = ['identifier']
+
+
+class Tree(Base):
+    __tablename__ = 'tree'
+    print_fields = ['version']
+
+
+class Env(Base):
+    __tablename__ = 'env'
+
+
+class Directory(Base):
+    __tablename__ = 'directory'
+    print_fields = ['location']
+
+
+class File(Base):
+    __tablename__ = 'file'
+    print_fields = ['name']
+
+    @property
+    def name(self):
+        return self.location.rsplit('/', 1)[-1]
+
+
+class SymlinkFile(Base):
+    __tablename__ = 'symlink_file'
+    print_fields = ['location']
+
+
+class SymlinkDirectory(Base):
+    __tablename__ = 'symlink_directory'
+    print_fields = ['location']
+
+
+class ChecksumFile(Base):
+    __tablename__ = 'checksumfile'
+    print_fields = ['filename']
+
+
+class Checksum(Base):
+    __tablename__ = 'checksum'
+
+
+def define_relations():
+    """Setup relationships after preparation."""
+
+    # model relationships
+    Root.directories = relationship(Directory, backref='root')
+    Tree.envs = relationship(Env, backref='tree')
+
+    # class Checksum
+    Checksum.tree = relationship(Tree, backref='checksums')
+    Checksum.checksumfile = relationship(ChecksumFile, backref='checksums')
+    Checksum.file = relationship(File, backref='checksums')
+    Checksum.directory = relationship(Directory, backref='checksums')
+
+    # class Checksumfile
+    ChecksumFile.tree = relationship(Tree, backref='checksumfiles')
+    ChecksumFile.env = relationship(Env, backref='checksumfile')
+    ChecksumFile.directory = relationship(Directory, backref='checksumfile')
+    ChecksumFile.file = relationship(File, backref='checksumfile')
+
+    # class Directory
+    Directory.tree = relationship(Tree, backref='directories')
+    Directory.env = relationship(Env, backref='directories')
+
+    # class Env
+    # need to specify remote_side when foreign key points to itself
+    Env.real_env = relationship(Env, remote_side='Env.id', backref='env')
+
+    # class File
+    File.root = relationship(Root, backref='files')
+    File.tree = relationship(Tree, backref='files')
+    File.env = relationship(Env, backref='files')
+    File.directory = relationship(Directory, backref='files')
+
+    # class Symlink_directory
+    SymlinkDirectory.env = relationship(Env, backref='symlink_directories')
+    SymlinkDirectory.root = relationship(Root, backref='symlink_directories')
+    # need to specify foreign_keys when multiple columns points to same key
+    # need to specify primaryjoin when there are multiple ways to join the tables
+    SymlinkDirectory.directory = relationship(
+        Directory, backref='symlink_directories', foreign_keys='SymlinkDirectory.directory_id')
+    SymlinkDirectory.real_directory = relationship(Directory, backref='linked_symlink_directories',
+                                                   primaryjoin='and_(SymlinkDirectory.real_directory_id==Directory.id)')
+
+    SymlinkDirectory.tree = relationship(Tree, backref='symlink_directories', foreign_keys='SymlinkDirectory.tree_id',
+                                         primaryjoin='and_(SymlinkDirectory.tree_id==Tree.id)')
+    SymlinkDirectory.real_tree = relationship(
+        Tree, backref='linked_symlink_directories', primaryjoin='and_(SymlinkDirectory.real_tree_id==Tree.id)')
+
+    # class Symlink_file
+    SymlinkFile.directory = relationship(Directory, backref='symlink_files')
+    SymlinkFile.env = relationship(Env, backref='symlink_files')
+    SymlinkFile.real_file = relationship(File, backref='symlink_files')
+    SymlinkFile.root = relationship(Root, backref='symlink_files', foreign_keys='SymlinkFile.root_id')
+
+    SymlinkFile.tree = relationship(Tree, backref='symlink_files', foreign_keys='SymlinkFile.tree_id',
+                                    primaryjoin='and_(SymlinkFile.tree_id==Tree.id)')
+    SymlinkFile.real_tree = relationship(
+        Tree, backref='linked_symlink_files', primaryjoin='and_(SymlinkFile.real_tree_id==Tree.id)')
+
+
+# prepare the base
+database.add_base(Base)

python/sdssdb/tests/test_main.py

@@ -10,14 +10,14 @@
 
 from pytest import mark
 
-from sdssdb.main import math
+# from sdssdb.main import math
 
 
-class TestMath(object):
-    """Tests for the ``math`` function in main.py."""
+# class TestMath(object):
+#     """Tests for the ``math`` function in main.py."""
 
-    @mark.parametrize(('arg1', 'arg2', 'operator', 'result'),
-                      [(1, 2, '+', 3), (2, 2, '-', 0), (3, 5, '*', 15), (10, 2, '/', 5)])
-    def test_math(self, arg1, arg2, operator, result):
+#     @mark.parametrize(('arg1', 'arg2', 'operator', 'result'),
+#                       [(1, 2, '+', 3), (2, 2, '-', 0), (3, 5, '*', 15), (10, 2, '/', 5)])
+#     def test_math(self, arg1, arg2, operator, result):
 
-        assert math(arg1, arg2, arith_operator=operator) == result
+#         assert math(arg1, arg2, arith_operator=operator) == result