♻️ REFACTOR: New archive format

.gitignore

@@ -34,3 +34,5 @@ pip-wheel-metadata
 # Docs
 docs/build
 docs/source/reference/apidoc
+
+pplot_out/

.pre-commit-config.yaml

@@ -105,9 +105,7 @@ repos:
                 aiida/repository/.*py|
                 aiida/tools/graph/graph_traversers.py|
                 aiida/tools/groups/paths.py|
-                aiida/tools/importexport/archive/.*py|
-                aiida/tools/importexport/dbexport/__init__.py|
-                aiida/tools/importexport/dbimport/backends/.*.py|
+                aiida/tools/archive/.*py|
             )$
 
     -   id: pylint

aiida/backends/sqlalchemy/models/__init__.py

@@ -9,6 +9,7 @@
 ###########################################################################
 """Module to define the database models for the SqlAlchemy backend."""
 import sqlalchemy as sa
+from sqlalchemy.orm import mapper
 
 # SqlAlchemy does not set default values for table columns upon construction of a new instance, but will only do so
 # when storing the instance. Any attributes that do not have a value but have a defined default, will be populated with
@@ -34,4 +35,4 @@ def instant_defaults_listener(target, _, __):
                 setattr(target, key, column.default.arg)
 
 
-sa.event.listen(sa.orm.mapper, 'init', instant_defaults_listener)
+sa.event.listen(mapper, 'init', instant_defaults_listener)

aiida/backends/sqlalchemy/models/authinfo.py

@@ -20,7 +20,12 @@
 
 
 class DbAuthInfo(Base):
-    """Class that keeps the authernification data."""
+    """Database model to keep computer authentication data, per user.
+
+    Specifications are user-specific of how to submit jobs in the computer.
+    The model also has an ``enabled`` logical switch that indicates whether the device is available for use or not.
+    This last one can be set and unset by the user.
+    """
     __tablename__ = 'db_dbauthinfo'
 
     id = Column(Integer, primary_key=True)  # pylint: disable=invalid-name

aiida/backends/sqlalchemy/models/comment.py

@@ -22,7 +22,8 @@
 
 
 class DbComment(Base):
-    """Class to store comments using SQLA backend."""
+    """Database model to store comments, relating to a node."""
+
     __tablename__ = 'db_dbcomment'
 
     id = Column(Integer, primary_key=True)  # pylint: disable=invalid-name

aiida/backends/sqlalchemy/models/computer.py

@@ -18,7 +18,16 @@
 
 
 class DbComputer(Base):
-    """Class to store computers using SQLA backend."""
+    """Database model to store computers.
+
+    Computers are identified within AiiDA by their ``label`` (and thus it must be unique for each one in the database),
+    whereas the ``hostname`` is the label that identifies the computer within the network from which one can access it.
+
+    The ``scheduler_type`` column contains the information of the scheduler (and plugin)
+    that the computer uses to manage jobs, whereas the ``transport_type`` the information of the transport
+    (and plugin) required to copy files and communicate to and from the computer.
+    The ``metadata`` contains some general settings for these communication and management protocols.
+    """
     __tablename__ = 'db_dbcomputer'
 
     id = Column(Integer, primary_key=True)  # pylint: disable=invalid-name

aiida/backends/sqlalchemy/models/group.py

@@ -32,12 +32,19 @@
 
 
 class DbGroupNode(Base):
-    """Class to store group to nodes relation using SQLA backend."""
+    """Database model to store group-to-nodes relations."""
+    __tablename__ = table_groups_nodes.name
     __table__ = table_groups_nodes
 
 
 class DbGroup(Base):
-    """Class to store groups using SQLA backend."""
+    """Database model to store groups of nodes.
+
+    Users will typically identify and handle groups by using their ``label``
+    (which, unlike the ``labels`` in other models, must be unique).
+    Groups also have a ``type``, which serves to identify what plugin is being instanced,
+    and the ``extras`` property for users to set any relevant information.
+    """
 
     __tablename__ = 'db_dbgroup'
 

aiida/backends/sqlalchemy/models/log.py

@@ -22,14 +22,14 @@
 
 
 class DbLog(Base):
-    """Class to store logs using SQLA backend."""
+    """Database model to store log levels and messages relating to a process node."""
     __tablename__ = 'db_dblog'
 
     id = Column(Integer, primary_key=True)  # pylint: disable=invalid-name
     uuid = Column(UUID(as_uuid=True), default=get_new_uuid, unique=True)
     time = Column(DateTime(timezone=True), default=timezone.now)
-    loggername = Column(String(255), index=True)
-    levelname = Column(String(255), index=True)
+    loggername = Column(String(255), index=True, doc='What process recorded the message')
+    levelname = Column(String(255), index=True, doc='How critical the message is')
     dbnode_id = Column(
         Integer, ForeignKey('db_dbnode.id', deferrable=True, initially='DEFERRED', ondelete='CASCADE'), nullable=False
     )

aiida/backends/sqlalchemy/models/node.py

@@ -25,7 +25,20 @@
 
 
 class DbNode(Base):
-    """Class to store nodes using SQLA backend."""
+    """Database model to store nodes.
+
+    Each node can be categorized according to its ``node_type``,
+    which indicates what kind of data or process node it is.
+    Additionally, process nodes also have a ``process_type`` that further indicates what is the specific plugin it uses.
+
+    Nodes can also store two kind of properties:
+
+    - ``attributes`` are determined by the ``node_type``,
+      and are set before storing the node and can't be modified afterwards.
+    - ``extras``, on the other hand,
+      can be added and removed after the node has been stored and are usually set by the user.
+
+    """
 
     __tablename__ = 'db_dbnode'
 
@@ -146,7 +159,14 @@ def __str__(self):
 
 
 class DbLink(Base):
-    """Class to store links between nodes using SQLA backend."""
+    """Database model to store links between nodes.
+
+    Each entry in this table contains not only the ``id`` information of the two nodes that are linked,
+    but also some extra properties of the link themselves.
+    This includes the ``type`` of the link (see the :ref:`topics:provenance:concepts` section for all possible types)
+    as well as a ``label`` which is more specific and typically determined by
+    the procedure generating the process node that links the data nodes.
+    """
 
     __tablename__ = 'db_dblink'
 

aiida/backends/sqlalchemy/models/settings.py

@@ -22,7 +22,7 @@
 
 
 class DbSetting(Base):
-    """Class to store node settings using the SQLA backend."""
+    """Database model to store global settings."""
     __tablename__ = 'db_dbsetting'
     __table_args__ = (UniqueConstraint('key'),)
     id = Column(Integer, primary_key=True)  # pylint: disable=invalid-name

aiida/backends/sqlalchemy/models/user.py

@@ -17,7 +17,10 @@
 
 
 class DbUser(Base):
-    """Store users using the SQLA backend."""
+    """Database model to store users.
+
+    The user information consists of the most basic personal contact details.
+    """
     __tablename__ = 'db_dbuser'
 
     id = Column(Integer, primary_key=True)  # pylint: disable=invalid-name