org.firebirdsql.management.StatisticsManager Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaybird Show documentation
Show all versions of jaybird Show documentation
JDBC Driver for the Firebird RDBMS
/*
* Public Firebird Java API.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.firebirdsql.management;
import org.firebirdsql.gds.ISCConstants;
import java.sql.SQLException;
/**
* A {@code StatisticsManager} is responsible for replicating the functionality of the {@code gstat} command-line tool.
*
* This functionality includes:
*
* - Retrieving data table statistics
* - Retrieving the database header page
* - Retrieving index statistics
* - Retrieving database logging information
* - Retrieving statistics for the data dictionary
*
*
*
* @author Gabriel Reid
*/
public interface StatisticsManager extends ServiceManager {
/**
* Request statistics on data tables.
*/
int DATA_TABLE_STATISTICS = ISCConstants.isc_spb_sts_data_pages;
/**
* Request statistics on indexes.
*/
int INDEX_STATISTICS = ISCConstants.isc_spb_sts_idx_pages;
/**
* Request statistics on system tables.
*/
int SYSTEM_TABLE_STATISTICS = ISCConstants.isc_spb_sts_sys_relations;
/**
* Request statistics on record versions.
*/
int RECORD_VERSION_STATISTICS = ISCConstants.isc_spb_sts_record_versions;
/**
* Fetch the database statistics header page.
*
* The header information is written to this {@code StatisticsManager}'s logger.
*
*
* @throws SQLException
* if a database access error occurs
*/
void getHeaderPage() throws SQLException;
/**
* Get the full database statistics information, excluding system table information.
*
* The statistics information is written to this {@code StatisticsManager}'s logger.
*
*
* The listed data includes:
*
* - statistics header page
* - log statistics
* - index statistics
* - data table statistics
*
*
*
* Invoking this method is equivalent to the default behaviour of {@code gstat} on the command-line.
*
*
* @throws SQLException
* if a database access error occurs
*/
void getDatabaseStatistics() throws SQLException;
/**
* Get specific database statistics.
*
* The statistics information is written to this {@code StatisticsManager}'s logger. All invocations of
* this method will result in the header page and log data being output.
*
*
* The following options can be supplied as a bitmask:
*
* - {@code DATA_TABLE_STATISTICS}
* - {@code SYSTEM_TABLE_STATISTICS}
* - {@code INDEX_STATISTICS}
* - {@code RECORD_VERSION_STATISTICS}
*
*
*
* If this method is invoked with {@code 0} as the {@code options} value, only the header and log statistics will
* be output.
*
*
* @param options
* A bitmask combination of
* {@code DATA_TABLE_STATISTICS},
* {@code SYSTEM_TABLE_STATISTICS},
* {@code INDEX_STATISTICS}, or
* {@code RECORD_VERSION_STATISTICS}.
* Can also be {@code 0}, which is equivalent to calling method {@link #getDatabaseStatistics()}
*/
void getDatabaseStatistics(int options) throws SQLException;
/**
* Get the table statistics.
*
* The statistics information is written to this {@code StatisticsManager}'s logger.
*
*
* The listed data includes:
*
* - the primary pointer and index root page numbers
* - number of data pages and their average fill
* - fill distribution
*
*
*
* Invoking this method is equivalent to the behaviour of {@code gstat -t
} on the command-line.
*
*
* @param tableNames
* array of table names to analyze.
* @throws SQLException
* if something went wrong.
*/
void getTableStatistics(String[] tableNames) throws SQLException;
/**
* Get transaction information of the database specified in {@code database}.
*
* @return Database transaction information
* @throws SQLException
* If {@code database} is not specified, or for failures to connect or retrieve information
*/
DatabaseTransactionInfo getDatabaseTransactionInfo() throws SQLException;
final class DatabaseTransactionInfo {
private long oldestTransaction;
private long oldestActiveTransaction;
private long oldestSnapshotTransaction;
private long nextTransaction;
private long activeTransactionCount = -1;
public long getOldestTransaction() {
return oldestTransaction;
}
void setOldestTransaction(long oldestTransaction) {
this.oldestTransaction = oldestTransaction;
}
public long getOldestActiveTransaction() {
return oldestActiveTransaction;
}
void setOldestActiveTransaction(long oldestActiveTransaction) {
this.oldestActiveTransaction = oldestActiveTransaction;
}
public long getOldestSnapshotTransaction() {
return oldestSnapshotTransaction;
}
void setOldestSnapshotTransaction(long oldestSnapshotTransaction) {
this.oldestSnapshotTransaction = oldestSnapshotTransaction;
}
public long getNextTransaction() {
return nextTransaction;
}
void setNextTransaction(long nextTransaction) {
this.nextTransaction = nextTransaction;
}
/**
* @return active transaction count; {@code -1} means that this information wasn't retrieved (Firebird 1.5 and
* lower)
*/
public long getActiveTransactionCount() {
return activeTransactionCount;
}
void setActiveTransactionCount(long activeTransactionCount) {
this.activeTransactionCount = activeTransactionCount;
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy