svn commit: r1811441 - /jena/site/trunk/content/documentation/tdb2/tdb2_admin.md

[an...@apache.org]

Author: andy
Date: Sat Oct  7 16:24:40 2017
New Revision: 1811441

URL: http://svn.apache.org/viewvc?rev=1811441&view=rev
Log:
Further content for TDB2

Modified:
    jena/site/trunk/content/documentation/tdb2/tdb2_admin.md

Modified: jena/site/trunk/content/documentation/tdb2/tdb2_admin.md
URL: http://svn.apache.org/viewvc/jena/site/trunk/content/documentation/tdb2/tdb2_admin.md?rev=1811441&r1=1811440&r2=1811441&view=diff
==============================================================================
--- jena/site/trunk/content/documentation/tdb2/tdb2_admin.md (original)
+++ jena/site/trunk/content/documentation/tdb2/tdb2_admin.md Sat Oct  7 16:24:40 2017
@@ -2,7 +2,7 @@ Title: TDB2 - Database Administration
 
 ## TDB2 directory layout
 
-A TDB2 database is contrained in a directory location `DIR` as:
+A TDB2 database is contained in a directory location `DIR` as:
 
     DIR/
       Backups/
@@ -12,13 +12,15 @@ A TDB2 database is contrained in a direc
 
 where `Data-NNNN` are the compacted generations of the database. The
 highest number is the currently live database.  The others are not used
-and not touched by the TDB2 storage system. They can be deleted or compressed
-as required.
-
-`Backups` is teh directoryused to place backup files.
-
-`tdb.lock` is the lock file to stop multipel use of the same database at
-the same time by different JVM processes.
+and not touched by the TDB2 subsystem. They can be deleted, moved
+elsewhere, or compressed as required. Each is a valid database in it own
+right.
+
+`Backups` is the directory used to write backup files.
+
+`tdb.lock` is the lock file to stop multiple use of the same database at
+the same time by different JVM processes. (If yuo wish to share a datbase
+bewteen processes, or machines, consider using [Fuseki2 with TDB2](tdb2_fuseki.html).
 
 ## Compaction
 
@@ -26,7 +28,7 @@ TDB2 databases grow over time as updates
 
     DatabaseMgr.compact(dataset.asDatasetGraph());
 
-This can be done on a live database. Read requests will continue to be
+Compaction can be done on a live database. Read requests will continue to be
 serviced; write request are held up until compaction has finished. This
 can be a long time for large databases.
 
@@ -34,6 +36,8 @@ Compaction creates a new `Data-NNNN` sub
 latest view of the RDF dataset into that directory, then switch to using
 that generation of the database. 
 
+There is also a command line tool `tdb2.tdbcompact` to run the
+compaction process on a database not in use.
 
 ## Backup
 
@@ -44,12 +48,16 @@ A TDB2 database can be backed up by call
 which will create a dump file with timestamp:
 
 <pre>    
-*location*/Backups/backup-*yyyy-MM-dd_HH:mm:ss*.nq.gz
+<i>location</i>/Backups/backup-<i>yyyy-MM-dd_HH:mm:ss</i>.nq.gz
 </pre>
 
 The file is a compressed N-Quads file.
 
 Backup can be done on a live database. It takes a consistent view of the
-data and does not include any updates committed after it starts.
+data and does not include any updates committed after the backup starts.
+
+Backup can be called on a live database and read and write transactions
+continue to be serviced.
 
-Read and write transactions will continue to be serviced.
+There is also a command line tool `tdb2.tdbbackup` to run the
+backup process on a database not in use.