From edb98eb5aeaea7aebd087ac0d7d06e1ac62e2d88 Mon Sep 17 00:00:00 2001 From: Arun Isaac Date: Fri, 24 Dec 2021 16:36:41 +0530 Subject: README: Add Using section. * README.org (Using): New section. --- README.org | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.org b/README.org index 263e620..a86c72a 100644 --- a/README.org +++ b/README.org @@ -2,6 +2,36 @@ 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 + +#+BEGIN_SRC shell + $ guix shell -m guix.scm +#+END_SRC + +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. + +#+BEGIN_SRC scheme + ((username . "") + (password . "") + (database . "") + (host . "") + (port . )) +#+END_SRC + +Then, to dump the database, run + +#+BEGIN_SRC shell + $ ./pre-inst-env guile dump.scm +#+END_SRC + +The database will be dumped to ~/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. -- cgit v1.2.3