aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/markup-samples/manual/en/sisu_sql.ssi
diff options
context:
space:
mode:
Diffstat (limited to 'data/doc/sisu/markup-samples/manual/en/sisu_sql.ssi')
-rw-r--r--data/doc/sisu/markup-samples/manual/en/sisu_sql.ssi43
1 files changed, 40 insertions, 3 deletions
diff --git a/data/doc/sisu/markup-samples/manual/en/sisu_sql.ssi b/data/doc/sisu/markup-samples/manual/en/sisu_sql.ssi
index 771d3001..4b4866ec 100644
--- a/data/doc/sisu/markup-samples/manual/en/sisu_sql.ssi
+++ b/data/doc/sisu/markup-samples/manual/en/sisu_sql.ssi
@@ -27,11 +27,48 @@
:C~? Search
1~search_sql SQL
-
-2~ populating SQL type databases
={ SiSU sql; SiSU search }
-SiSU feeds sisu markupd documents into sql type databases PostgreSQL~{ http://www.postgresql.org/ \\ http://advocacy.postgresql.org/ \\ http://en.wikipedia.org/wiki/Postgresql }~ and/or SQLite~{ http://www.hwaci.com/sw/sqlite/ \\ http://en.wikipedia.org/wiki/Sqlite }~ database together with information related to document structure.
+2~ Populate the database
+={ SiSU search:populate database }
+
+TO populate the sql database, run sisu against a sisu markup file with one of the following sets of flags
+
+``` code
+sisu --sqlite filename.sst
+```
+
+creates an sqlite3 database containing searchable content of just the sisu markup document selected
+
+``` code
+sisu --sqlite --update filename.sst
+```
+
+creates an sqlite3 database containing searchable content of marked up document(s) selected by the user from a common directory
+
+``` code
+sisu --pg --update filename.sst
+```
+
+fills a postgresql database with searchable content of marked up document(s) selected by the user from a common directory
+
+For postgresql the first time the command is run in a given directory the user will be prompted to create the requisite database, at the time of writing the prompt sisu provides is as follows:
+
+``` code
+no connection with pg database established, you may need to run:
+ createdb "SiSU.7a.current"
+ after that don't forget to run:
+ sisu --pg --createall
+ before attempting to populate the database
+```
+
+The named database that sisu expects to find must exist and if necessary be created using postgresql tools. If the database exist but the database tables do not, sisu will attempt to create the tables it needs, the equivalent of the requested #{sisu --pg --createall}# command.
+
+Once this is done, the sql database is populated and ready to be queried.
+
+2~ SQL type databases
+
+SiSU feeds sisu markup documents into sql type databases PostgreSQL~{ http://www.postgresql.org/ \\ http://advocacy.postgresql.org/ \\ http://en.wikipedia.org/wiki/Postgresql }~ and/or SQLite~{ http://www.hwaci.com/sw/sqlite/ \\ http://en.wikipedia.org/wiki/Sqlite }~ database together with information related to document structure.
This is one of the more interesting output forms, as all the structural data of the documents are retained (though can be ignored by the user of the database should they so choose). All site texts/documents are (currently) streamed to four tables: