aiida.tools.importexport.dbimport.backends.sqla package

SQLAlchemy-specific import of AiiDA entities

aiida.tools.importexport.dbimport.backends.sqla.import_data_sqla(in_path, group=None, ignore_unknown_nodes=False, extras_mode_existing='kcl', extras_mode_new='import', comment_mode='newest', silent=False)[source]

Import exported AiiDA archive to the AiiDA database and repository.

Specific for the SQLAlchemy backend. If in_path is a folder, calls extract_tree; otherwise, tries to detect the compression format (zip, tar.gz, tar.bz2, …) and calls the correct function.

Parameters:
  • in_path (str) – the path to a file or folder that can be imported in AiiDA.
  • group (Group) – Group wherein all imported Nodes will be placed.
  • extras_mode_existing (str) – 3 letter code that will identify what to do with the extras import. The first letter acts on extras that are present in the original node and not present in the imported node. Can be either: ‘k’ (keep it) or ‘n’ (do not keep it). The second letter acts on the imported extras that are not present in the original node. Can be either: ‘c’ (create it) or ‘n’ (do not create it). The third letter defines what to do in case of a name collision. Can be either: ‘l’ (leave the old value), ‘u’ (update with a new value), ‘d’ (delete the extra), or ‘a’ (ask what to do if the content is different).
  • extras_mode_new (str) – ‘import’ to import extras of new nodes or ‘none’ to ignore them.
  • comment_mode (str) – Comment import modes (when same UUIDs are found). Can be either: ‘newest’ (will keep the Comment with the most recent modification time (mtime)) or ‘overwrite’ (will overwrite existing Comments with the ones from the import file).
  • silent (bool) – suppress prints.
Returns:

New and existing Nodes and Links.

Return type:

dict

Raises:

Submodules

Utility functions for import of AiiDA entities using SQLAlchemy backend

aiida.tools.importexport.dbimport.backends.sqla.utils.validate_uuid(given_uuid)[source]

A simple check for the UUID validity.