Skip to content

Commit 211a6f2

Browse files
committed
Improve documentation of TableStatisticsManager
1 parent f29b148 commit 211a6f2

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

src/docs/asciidoc/chapters/services/services.adoc

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -885,10 +885,24 @@ Allowed values are:
885885

886886
[.since]_Jaybird 5_
887887

888-
A new class was added in Jaybird 5, `org.firebirdsql.management.FBTableStatisticsManager`, which can be used to retrieve the table statistics of a connection.
888+
The class `org.firebirdsql.management.FBTableStatisticsManager` can be used to retrieve the table statistics of a connection.
889889

890890
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()`.
891891

892+
The method `getTableStatistics()` returns a `Map<String, TableStatistics>`, where the keys are table names, and the values statistics of tables.
893+
894+
A `TableStatistics` object has the following properties:
895+
896+
* `tableName`
897+
* `readSeqCount`
898+
* `readIdxCount`
899+
* `insertCount`
900+
* `updateCount`
901+
* `deleteCount`
902+
* `backoutCount`
903+
* `purgeCount`
904+
* `expungeCount`
905+
892906
[NOTE]
893907
====
894908
This is an experimental feature.

0 commit comments

Comments
 (0)