[Swift-commit] r2663 - provenancedb

[noreply at svn.ci.uchicago.edu]

Author: benc
Date: 2009-03-09 09:46:28 -0500 (Mon, 09 Mar 2009)
New Revision: 2663

Modified:
   provenancedb/prov-init.sql
   provenancedb/provenance.xml
Log:
Documentation on how to run own provenance database

Modified: provenancedb/prov-init.sql
===================================================================
--- provenancedb/prov-init.sql	2009-03-09 14:45:53 UTC (rev 2662)
+++ provenancedb/prov-init.sql	2009-03-09 14:46:28 UTC (rev 2663)
@@ -68,5 +68,7 @@
       duration numeric
     );
 
+-- this does not work for sqlite; you'll get a syntax error but
+-- ignore it
 grant all on dataset_containment, dataset_filenames, dataset_usage, executes_in_workflows, invocation_procedure_names, known_workflows, workflow_events to public;
 

Modified: provenancedb/provenance.xml
===================================================================
--- provenancedb/provenance.xml	2009-03-09 14:45:53 UTC (rev 2662)
+++ provenancedb/provenance.xml	2009-03-09 14:46:28 UTC (rev 2663)
@@ -140,6 +140,42 @@
 </section>
 </section>
 
+<section id="owndb"><title>Running your own provenance database</title>
+<para>This section details running your own SQL-based provenance database on
+servers of your own control.</para>
+
+<section><title>Configuring your SQL database</title>
+<para>
+This section describes configuring the SQL scripts to use 
+<ulink url="http://www.sqlite.org/">sqlite</ulink>, which is
+appropriate for a single-user installation.
+</para>
+<para>Install sqlite3. On OS X with MacPorts, this command works:
+<screen>
+$ <userinput>sudo port install sqlite3</userinput>
+</screen>
+Similar commands using <literal>apt</literal> or <literal>yum</literal> will
+probably work under Linux.
+</para>
+<para>
+Now create a <filename>paths.source</filename> file to define local
+configuration. An example that I use on my laptop is present in
+<filename>paths.source.soju</filename>.
+The <literal>SQLCMD</literal> indicates which command to run for SQL
+access. This is used by other scripts to access the database. The
+<literal>LOGREPO</literal> and <literal>IDIR</literal> variables should
+point to the directory under which you collect your Swift logs.
+</para>
+<para>
+Now import your logs for the first time like this:
+<screen>
+$ <userinput>./import-all rebuild</userinput>
+</screen>
+</para>
+</section>
+
+</section>
+
 <section><title>What this work does not address</title>
 
 <para>This work explicitly excludes a number of uses which traditionally