Permalink
Browse files

Document database schema

To prepare for adding PROV export.
  • Loading branch information...
jvdzwaan committed Aug 1, 2018
1 parent f2d8cd4 commit a7d1fd1bc537f78fc43689525837978fbf00f9df
Showing with 23 additions and 0 deletions.
  1. +23 −0 docs/databaseSchema.md
View
@@ -0,0 +1,23 @@
# Database Schema
| Field | Description | Example |
| ----- | ----------- | ------- |
| `unique_id` | | ff129fee-c0d9-47cc-b0a9-997a530230a8 |
| `author` | Username of the one running the script | |
| `description` | Currently not used? | |
| `inputs` | List of input files (can be empty) | |
| `outputs` | List of output files (can be empty) | |
| `script` | Path to the script that was run | |
| `command` | Path to the python executable that was used to run the script | `/usr/bin/python2.7` |
| `environment` | Information about the environment in which the script was run (including Python version) | Linux-4.15.0-29-generic-x86_64-with-debian-stretch-sid python 2.7.15 -Anaconda, Inc.- (default, May 1 2018, 23:32:55) |
| `date` | Date and time the script was run (in UTC) | |
| `command_args` | Command line arguments of the script (can be empty) | |
| `warnings` | Warnings issued during execution of the script (if any) | |
| `exception` | Exception raised during execution of the script (if any) | |
| `libraries` | Names and versions of patched libraries used in this script | |
| `notes` | Notes added by the user by running `recipy annotate` or in the gui | |
| `custom_values` | Values logged explicitly in the script by calling `recipy.log_values({'name': 'value'})` | |
| `gitrepo`/`svnrepo` | | |
| `gitcommit`/`svncommit` | Current git/svn commit | |
| `gitorigin` | | |
| `diff` | | |

0 comments on commit a7d1fd1

Please sign in to comment.