diff --git a/src/docs/asciidoc/chapters/services/services.adoc b/src/docs/asciidoc/chapters/services/services.adoc index 3ad1014..b3754cb 100644 --- a/src/docs/asciidoc/chapters/services/services.adoc +++ b/src/docs/asciidoc/chapters/services/services.adoc @@ -885,10 +885,24 @@ Allowed values are: [.since]_Jaybird 5_ -A new class was added in Jaybird 5, `org.firebirdsql.management.FBTableStatisticsManager`, which can be used to retrieve the table statistics of a connection. +The class `org.firebirdsql.management.FBTableStatisticsManager` can be used to retrieve the table statistics of a connection. Create an instance with `FBTableStatisticsManager#of(java.sql.Connection)` -- the connection must unwrap to a `FirebirdConnection` -- and retrieve a snapshot of the statistics with `FBTableStatisticsManager#getTableStatistics()`. +The method `getTableStatistics()` returns a `Map`, where the keys are table names, and the values statistics of tables. + +A `TableStatistics` object has the following properties: + +* `tableName` +* `readSeqCount` +* `readIdxCount` +* `insertCount` +* `updateCount` +* `deleteCount` +* `backoutCount` +* `purgeCount` +* `expungeCount` + [NOTE] ==== This is an experimental feature.