diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..fdad92a --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +[](https://ci.genenetwork.org/jobs/dump-genenetwork-database-tests) +[](https://ci.genenetwork.org/jobs/dump-genenetwork-database) + +The GeneNetwork database is being migrated from a relational database to +a plain text and RDF database. This repository contains code to dump the +relational database to plain text. + +# Using + +Drop into a development environment with + +``` shell +$ guix shell +``` + +Describe the database connection parameters in a file *conn.scm* file as +shown below. Take care to replace the placeholders within angle brackets +with the appropriate values. + +``` scheme +((username . "<username-here>") + (password . "<password-here>") + (database . "<database-name-here>") + (host . "<hostname-here>") + (port . <port-here>)) +``` + +Then, to dump the database to \~/data/dump, run + +``` shell +$ ./pre-inst-env ./dump.scm conn.scm ~/data/dump +``` + +Make sure there is enough free space! It\'s best to dump the database on +penguin2 where disk space and bandwidth are not significant constraints. + +# Contributing + +See bugs and tasks in BUGS.org. |