[jena-site] branch main updated: Update some documentation for tdb2 compacting and cli command (#110)

[an...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

andy pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/jena-site.git


The following commit(s) were added to refs/heads/main by this push:
     new 51cd82ab1 Update some documentation for tdb2 compacting and cli command (#110)
51cd82ab1 is described below

commit 51cd82ab11b760f01671d69ac4de8b0ff1e489d7
Author: ØyvindG <oy...@uib.no>
AuthorDate: Wed Jul 27 16:28:14 2022 +0200

    Update some documentation for tdb2 compacting and cli command (#110)
    
    * add info on using deleteOld for server protocol and from cli
    * add info on tdb2.tdbstat
    
    add tdb2.tdbstats to list of clt and dir location for stats file
    
    add missing backtick
---
 source/documentation/fuseki2/fuseki-server-protocol.md | 4 +++-
 source/documentation/tdb2/tdb2_admin.md                | 6 +++++-
 source/documentation/tdb2/tdb2_cmds.md                 | 8 ++++++++
 source/documentation/tools/__index.md                  | 2 +-
 4 files changed, 17 insertions(+), 3 deletions(-)

diff --git a/source/documentation/fuseki2/fuseki-server-protocol.md b/source/documentation/fuseki2/fuseki-server-protocol.md
index 0ecc63f82..532bb725d 100644
--- a/source/documentation/fuseki2/fuseki-server-protocol.md
+++ b/source/documentation/fuseki2/fuseki-server-protocol.md
@@ -43,7 +43,7 @@ Replace `{name}` with a dataset name: e.g. `/$/backup/myDataset`.
 ||
 | <tt>POST</tt>   | `/$/backup/{name}`     |               |
 | <tt>GET</tt>    | `/$/backups-list`      |               |
-| <tt>POST</tt>   | `/$/compact/{name}`    |               |
+| <tt>POST</tt>   | `/$/compact/{name}?deleteOld=true` |               |
 | <tt>POST</tt>   | `/$/sleep`             |               |
 ||
 | <tt>GET</tt>    | `/$/tasks`             |               | 
@@ -172,6 +172,8 @@ Pattern: `/$/compact/{name}`
 
 This operations initiates a database compaction task and returns a JSON object with the task Id in it.
 
+The optional parameter and value `deleteOld=true` deletes the database which currently is compacted after compacting completion.
+
 Compaction **ONLY** applies to TDB2 datasets, see [TDB2 Database Administration](../tdb2/tdb2_admin.html#compaction)
 for more details of this operation.
 
diff --git a/source/documentation/tdb2/tdb2_admin.md b/source/documentation/tdb2/tdb2_admin.md
index 002b859b6..2893b9dfe 100644
--- a/source/documentation/tdb2/tdb2_admin.md
+++ b/source/documentation/tdb2/tdb2_admin.md
@@ -39,7 +39,11 @@ 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.
+compaction process on a database not in use. The command line
+option  `--deleteOld` removes the last database after compaction.
+
+Compaction can also be called from [the Fuseki HTTP Administration Protocol](/documentation/fuseki2/fuseki-server-protocol.html#compact)
+for live [Fuseki webapps](/documentation/fuseki2/fuseki-webapp.html).
 
 ## Backup
 
diff --git a/source/documentation/tdb2/tdb2_cmds.md b/source/documentation/tdb2/tdb2_cmds.md
index 6f38b76cf..2cc61ff84 100644
--- a/source/documentation/tdb2/tdb2_cmds.md
+++ b/source/documentation/tdb2/tdb2_cmds.md
@@ -14,6 +14,7 @@ These scripts are available jena binary distribution.
 * `tdb2.tdbloader`
 * `tdb2.tdbquery`
 * `tdb2.tdbupdate`
+* `tdb2.tdbstats`
 
 On MS Windows, these commands are called `tdb2_tdbquery` etc.
 
@@ -105,3 +106,10 @@ The parallel loader runs all operations at once. It can deliver the best
 performance providing enough RAM is available and the persistent storage
 is SSD. It can consume all hardware resources, greatly impacting
 any other applications running.
+
+## `tdb2.tdbstats`
+
+Produce statistics for the dataset, which can be used for optimization rules. See the
+[TDB Optimizer description.](../tdb/optimizer.html#statistics-rule-file).
+
+For TDB2 the statistic files is read and placed in the `Data-NNNN` directory (`Data-0001/stats.opt`).
diff --git a/source/documentation/tools/__index.md b/source/documentation/tools/__index.md
index 67e876e60..d7dda4edd 100644
--- a/source/documentation/tools/__index.md
+++ b/source/documentation/tools/__index.md
@@ -119,7 +119,7 @@ pages describe these further.
 
 - **`tdbbackup`**, **`tdb2.tdbbackup`**: create a gzipped copy of the Fuseki dataset's triples.
 
-- **`tdbcompact`**, **`tdb2.tdbcompact`**: reduce the size of the Fuseki dataset.
+- **not implemented for TDB1**, **`tdb2.tdbcompact`**: reduce the size of the Fuseki dataset.