aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorArun Isaac2021-12-24 16:36:41 +0530
committerArun Isaac2021-12-24 16:36:41 +0530
commitedb98eb5aeaea7aebd087ac0d7d06e1ac62e2d88 (patch)
tree373e5a1e32db06b3614d79ea6fd47cf2a33e9448 /README.org
parent261f21c37d3fb70e17d4360d4b0f220cf63d56eb (diff)
downloadgn-transform-databases-edb98eb5aeaea7aebd087ac0d7d06e1ac62e2d88.tar.gz
README: Add Using section.
* README.org (Using): New section.
Diffstat (limited to 'README.org')
-rw-r--r--README.org30
1 files changed, 30 insertions, 0 deletions
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 . "<username-here>")
+ (password . "<password-here>")
+ (database . "<database-name-here>")
+ (host . "<hostname-here>")
+ (port . <port-here>))
+#+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.