adutra commented on code in PR #3395:
URL: https://github.com/apache/polaris/pull/3395#discussion_r2834425861
##########
site/content/in-dev/unreleased/admin-tool.md:
##########
@@ -208,3 +209,85 @@ docker run --rm -it \
```
Again, the Polaris Admin Tool must be executed with appropriate configuration
to connect to the same database used by the Polaris server. The configuration
can be done via environment variables (as above) or system properties.
+
+## NoSQL Specific Operations
+
+The `nosql` admin tool command is used to perform NoSQL metastore specific
operations.
+```
+Usage: polaris-admin-tool.jar nosql [-hV] [COMMAND]
+Polaris NoSQL persistence.
+ -h, --help Show this help message and exit.
+ -V, --version Print version information and exit.
+Commands:
+ maintenance-info Polaris NoSQL persistence maintenance information.
+ maintenance-log Show Polaris persistence maintenance log.
+ maintenance-run Run Polaris persistence maintenance.
+```
+
+### Running NoSQL maintenance
+
+NoSQL maintenance is run using the `nosql maintenance-run` command.
+Maintenance covers the deletion of stale database entries.
+
+{{< alert note >}}
+It is recommended to run the `nosql maintenance-run` command regulary, for
example, once per day.
+{{< /alert >}}
+
+The output shows a bunch of configuration options, most of which are
automatically determined by the tool.
+
+```
+Maintenance configuration:
+ created-at grace time: PT3H
+ delete batch size: 10
+ retained runs: 50
+ expected object count: 100000
+ expected reference count: 100
+ last-run multiplier: 1.100000
+ initialized FPP: 0.000010
+ expected FPP: 0.000050
+ reference scan rate limit / sec: (unlimited)
+ object scan rate limit / sec: (unlimited)
+```
+
+The remaining output is a detailed report of the maintenance run.
+
+The implementation of NoSQL maintenance is self-tuning and does usually not
require additional configuration.
+
+If you encounter that the maintenance run operation puts too much load on the
database,
+you can adjust scan rates to reduce the load.
+The option for the reference and object scan rates are
+`polaris.persistence.nosql.maintenance.object-scan-rate-limit-per-second` and
+`polaris.persistence.nosql.maintenance.reference-scan-rate-limit-per-second`,
both default to 'unlimited.'
+It is safe to let the maintenance run for a long time, there is no runtime
limit.
+Alternatively, you can run maintenance at high or the default unlimited scan
rate during off-peak hours.
+
+{{< alert note >}}
+The `nosql maintenance-run` command may emit a warning that not all purgable
database entried have been deleted.
Review Comment:
typo: entried -> entries
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
