- All Superinterfaces:
AttachmentProperties,BaseProperties,ServiceConnectionProperties,ServiceManager
- All Known Implementing Classes:
FBMaintenanceManager
MaintenanceManager is responsible for replicating the
functionality provided by the gfix command-line tool.
Among the responsibilities of this class are:
- Database shutdown
- Extended database shutdown/online modes
- Changing database mode to read-only or read-write
- Enabling or disabling forced writes in the database
- Changing the dialect of the database
- Setting the cache size at database-level
- Mending databases and making minor repairs
- Sweeping databases
- Displaying, committing, or recovering limbo transactions
- Activating and killing shadow files
- Configuring page fill
- Author:
- Gabriel Reid, Thomas Steinmaurer
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intDatabase read-only modestatic final intDatabase read-write modestatic final byteOperation mode full shutdown.static final byteOperation mode multi shutdown/online.static final byteOperation mode normal online.static final byteOperation mode single shutdown/online.static final intFully fill pages when inserting records.static final intWhile inserting records, reserve 20% of each page for later record deltasstatic final intDon't allow new connections while waiting to shut down.static final intForced database shutdown.static final intDon't allow new transactions while waiting to shut down.static final intShutdown attachments.static final intForce shutdown.static final intShutdown transactions.static final intDo a full check on record and pages structures, releasing unassigned record fragments.static final intIgnore checksums during repair operations.static final intOnly report corrupt or misallocated structures, don't fix. -
Method Summary
Modifier and TypeMethodDescriptionvoidActivate a database shadow file to be used as the actual database.voidBring a shutdown database online.voidbringDatabaseOnline(byte operationMode) Bring a shutdown database online with enhanced operation modes (FB 2.5 or higher).voidcommitTransaction(long transactionId) Commit a limbo transaction based on its ID.voidfixIcu()Update or rebuild ICU-dependent collations and indexes when ICU version changed.long[]Retrieve the ID of each limbo transaction as an array of longs.voidRemove references to unavailable shadow files.Retrieve the ID of each limbo transaction as a List of Long objects.voidMark corrupt records in the database as unavailable.voidrollbackTransaction(long transactionId) Rollback a limbo transaction based on its ID.voidsetDatabaseAccessMode(int mode) Set the database to have read-write or read-only access.voidsetDatabaseDialect(int dialect) Set the database's dialect.voidsetDefaultCacheBuffer(int pageCount) Set the default page-buffer count to be cached in the database.voidsetForcedWrites(boolean forced) Enable or disable forced (synchronous) writes in the database.voidsetPageFill(int pageFill) Set the page fill strategy for when inserting records.voidsetSweepThreshold(int transactions) Set the database automatic sweep interval to a given number of transactions.voidshutdownDatabase(byte operationMode, int shutdownModeEx, int timeout) Shutdown the current database with enhanced modes (FB 2.5 or higher).voidshutdownDatabase(int shutdownMode, int timeout) Shutdown the current database.voidPerform an immediate sweep of the database.voidPerform minor ODS upgrade.voidLocate and release database pages that are allocated but unassigned to any data structures.voidvalidateDatabase(int options) Locate and release database pages that are allocated but unassigned to any data structures.Methods inherited from interface org.firebirdsql.jaybird.props.AttachmentProperties
getAuthPlugins, getCharSet, getConnectTimeout, getDbCryptConfig, getEnableProtocol, getEncoding, getParallelWorkers, getPassword, getPortNumber, getProcessId, getProcessName, getRoleName, getServerName, getSocketBufferSize, getSocketFactory, getSoTimeout, getType, getUser, getWireCrypt, isWireCompression, setAuthPlugins, setCharSet, setConnectTimeout, setDbCryptConfig, setEnableProtocol, setEncoding, setParallelWorkers, setPassword, setPortNumber, setProcessId, setProcessName, setRoleName, setServerName, setSocketBufferSize, setSocketFactory, setSoTimeout, setType, setUser, setWireCompression, setWireCryptMethods inherited from interface org.firebirdsql.jaybird.props.BaseProperties
connectionPropertyValues, getBooleanProperty, getBooleanProperty, getIntProperty, getIntProperty, getProperty, getProperty, setBooleanProperty, setIntProperty, setPropertyMethods inherited from interface org.firebirdsql.jaybird.props.ServiceConnectionProperties
getExpectedDb, getServiceName, setExpectedDb, setServiceNameMethods inherited from interface org.firebirdsql.management.ServiceManager
getDatabase, getHost, getLogger, getPort, getServerVersion, getWireCryptAsEnum, setDatabase, setHost, setLogger, setPort, setWireCryptAsEnum
-
Field Details
-
ACCESS_MODE_READ_WRITE
static final int ACCESS_MODE_READ_WRITEDatabase read-write mode- See Also:
-
ACCESS_MODE_READ_ONLY
static final int ACCESS_MODE_READ_ONLYDatabase read-only mode- See Also:
-
SHUTDOWN_ATTACH
static final int SHUTDOWN_ATTACHDon't allow new connections while waiting to shut down.- See Also:
-
SHUTDOWN_TRANSACTIONAL
static final int SHUTDOWN_TRANSACTIONALDon't allow new transactions while waiting to shut down.- See Also:
-
SHUTDOWN_FORCE
static final int SHUTDOWN_FORCEForced database shutdown.- See Also:
-
VALIDATE_READ_ONLY
static final int VALIDATE_READ_ONLYOnly report corrupt or misallocated structures, don't fix.- See Also:
-
VALIDATE_IGNORE_CHECKSUM
static final int VALIDATE_IGNORE_CHECKSUMIgnore checksums during repair operations.- See Also:
-
VALIDATE_FULL
static final int VALIDATE_FULLDo a full check on record and pages structures, releasing unassigned record fragments.- See Also:
-
PAGE_FILL_FULL
static final int PAGE_FILL_FULLFully fill pages when inserting records.- See Also:
-
PAGE_FILL_RESERVE
static final int PAGE_FILL_RESERVEWhile inserting records, reserve 20% of each page for later record deltas- See Also:
-
OPERATION_MODE_NORMAL
static final byte OPERATION_MODE_NORMALOperation mode normal online.To be used with the
shutdownDatabase(byte, int, int)method.- Since:
- Firebird 2.5
- See Also:
-
OPERATION_MODE_MULTI
static final byte OPERATION_MODE_MULTIOperation mode multi shutdown/online.To be used with the
shutdownDatabase(byte, int, int)method.- Since:
- Firebird 2.5
- See Also:
-
OPERATION_MODE_SINGLE
static final byte OPERATION_MODE_SINGLEOperation mode single shutdown/online.To be used with the
shutdownDatabase(byte, int, int)method.- Since:
- Firebird 2.5
- See Also:
-
OPERATION_MODE_FULL_SHUTDOWN
static final byte OPERATION_MODE_FULL_SHUTDOWNOperation mode full shutdown.To be used with the
shutdownDatabase(byte, int, int)method.- Since:
- Firebird 2.5
- See Also:
-
SHUTDOWNEX_FORCE
static final int SHUTDOWNEX_FORCEForce shutdown.To be used with the
shutdownDatabase(byte, int, int)method.- Since:
- Firebird 2.5
- See Also:
-
SHUTDOWNEX_ATTACHMENTS
static final int SHUTDOWNEX_ATTACHMENTSShutdown attachments.To be used with the
shutdownDatabase(byte, int, int)method.- Since:
- Firebird 2.5
- See Also:
-
SHUTDOWNEX_TRANSACTIONS
static final int SHUTDOWNEX_TRANSACTIONSShutdown transactions.To be used with the
shutdownDatabase(byte, int, int)method.- Since:
- Firebird 2.5
- See Also:
-
-
Method Details
-
setDatabaseAccessMode
Set the database to have read-write or read-only access.- Parameters:
mode- Must be eitherACCESS_MODE_READ_WRITEorACCESS_MODE_READ_ONLY- Throws:
SQLException- if a database access error occurs
-
setDatabaseDialect
Set the database's dialect.- Parameters:
dialect- The database dialect, must be either 1 or 3- Throws:
SQLException- if a database access error occurs
-
setDefaultCacheBuffer
Set the default page-buffer count to be cached in the database.- Parameters:
pageCount- The number of pages to be cached, must be a positive- Throws:
SQLException- If the given page count cannot be set, or a database access error occurs
-
setForcedWrites
Enable or disable forced (synchronous) writes in the database.Note, it is considered to be a very bad idea to disable forced writes on Windows platforms.
- Parameters:
forced- Iftrue, forced writes will be used in the database, otherwise buffered writes will be used.- Throws:
SQLException- if a database access error occurs
-
setPageFill
Set the page fill strategy for when inserting records.pageFillcan be one of:PAGE_FILL_FULLFully fill database pagesPAGE_FILL_RESERVEReserve 20% of page space for later record deltas
- Parameters:
pageFill- The page-filling strategy, eitherPAGE_FILL_FULLorPAGE_FILL_RESERVE- Throws:
SQLException- if a database access error occurs
-
shutdownDatabase
Shutdown the current database.Shutdown can be done in three modes:
SHUTDOWN_ATTACH- No new non-owner connections will be allowed to the database during the shutdown, and shutdown is cancelled if there are still processes connected at the end of the timeout.SHUTDOWN_TRANSACTIONAL- No new transactions can be started during the timeout period, and shutdown is cancelled if there are still active transactions at the end of the timeout.SHUTDOWN_FORCE- Forcefully shuts down the database at the end of the timeout.
- Parameters:
shutdownMode- One ofSHUTDOWN_ATTACH,SHUTDOWN_TRANSACTIONAL, orSHUTDOWN_FORCE.timeout- The maximum amount of time allocated for the operation, in seconds- Throws:
SQLException- if the requested operation cannot be completed within the given timeout, or a database access error occurs
-
shutdownDatabase
Shutdown the current database with enhanced modes (FB 2.5 or higher).There are three operation modes for shutdown available:
OPERATION_MODE_MULTI- Multi-user maintenance. Unlimited SYSDBA/database owner connections are allowed.OPERATION_MODE_SINGLE- Single-user maintenance. Only one SYSDBA/database owner connection is allowed.OPERATION_MODE_FULL_SHUTDOWN- Full shutdown. Full exclusive shutdown. No connections are allowed.
There are three extended shutdown modes for shutdown available:
SHUTDOWNEX_FORCE- Force shutdown.SHUTDOWNEX_ATTACHMENTS- Shutdown attachments.SHUTDOWNEX_TRANSACTIONS- Shutdown transactions.
- Parameters:
operationMode- one ofOPERATION_MODE_*operation modes listed aboveshutdownModeEx- one ofSHUTDOWNEX_*extended shutdown modes listed abovetimeout- The maximum amount of time allocated for the operation, in seconds. 0 = immediately.- Throws:
SQLException- if the requested operation cannot be completed within the given timeout, or a database access error occurs- Since:
- Firebird 2.5
-
bringDatabaseOnline
Bring a shutdown database online.- Throws:
SQLException- if a database access error occurs
-
bringDatabaseOnline
Bring a shutdown database online with enhanced operation modes (FB 2.5 or higher).There are three operation modes for bringing a database online available:
OPERATION_MODE_NORMAL- Normal operation modes.OPERATION_MODE_MULTI- Multi-user maintenance. Unlimited SYSDBA/database owner connections are allowed.OPERATION_MODE_SINGLE- Single-user maintenance. Only one SYSDBA/database owner connection is allowed.
- Throws:
SQLException- if a database access error occurs- Since:
- Firebird 2.5
-
markCorruptRecords
Mark corrupt records in the database as unavailable.This operation ensures that the corrupt records are skipped (for example, during a subsequent backup).
- Throws:
SQLException- if a database access error occurs
-
validateDatabase
Locate and release database pages that are allocated but unassigned to any data structures. This method also reports corrupt structures.- Throws:
SQLException- if a database access error occurs
-
validateDatabase
Locate and release database pages that are allocated but unassigned to any data structures. This method also reports corrupt structures.The value supplied for
optionsmust be one of the following:- 0 - Simple validation
VALIDATE_READ_ONLY- read-only validation, no repairVALIDATE_FULL- full validation and repair
The value for
optionscan additionally be combined in a bitmask withVALIDATE_IGNORE_CHECKSUMto ignore checksums while performing validation.- Parameters:
options- Either 0,VALIDATE_READ_ONLY, orVALIDATE_FULL- Throws:
SQLException- if a database access error occurs
-
setSweepThreshold
Set the database automatic sweep interval to a given number of transactions.The Firebird default value is 20,000. If
transactionsis 0, automatic sweeping is disabled.- Parameters:
transactions- The interval of transactions between automatic sweeps of the database. Can be set to 0, which disables automatic sweeping of the database.- Throws:
SQLException- if a database access error occurs
-
sweepDatabase
Perform an immediate sweep of the database.- Throws:
SQLException- if a database access error occurs
-
activateShadowFile
Activate a database shadow file to be used as the actual database.This method is the equivalent of
gfix -activate.- Throws:
SQLException- if a database access error occurs
-
limboTransactionsAsList
Retrieve the ID of each limbo transaction as a List of Long objects.- Throws:
SQLException- if a database access error occurs
-
getLimboTransactions
Retrieve the ID of each limbo transaction as an array of longs.In Firebird 3, transactions are (unsigned) 48 bit longs.
- Throws:
SQLException- if a database access error occurs
-
commitTransaction
Commit a limbo transaction based on its ID.The transaction id is expected to be a positive long. If you have a negative
int, convert the int to an unsigned long usingNumericHelper.toUnsignedLong(int)- Parameters:
transactionId- The ID of the limbo transaction to be committed (must be> 0)- Throws:
SQLException- if a database access error occurs or the given transaction ID is not valid
-
rollbackTransaction
Rollback a limbo transaction based on its ID.The transaction id is expected to be a positive long. If you have a negative
int, convert the int to an unsigned long usingNumericHelper.toUnsignedLong(int)- Parameters:
transactionId- The ID of the limbo transaction to be rolled back (must be> 0)- Throws:
SQLException- if a database access error occurs or the given transaction ID is not valid
-
upgradeOds
Perform minor ODS upgrade.Requires Firebird 5.0 or higher.
- Throws:
SQLException- if a database access error occurs- Since:
- 5.0.2
-
fixIcu
Update or rebuild ICU-dependent collations and indexes when ICU version changed.Requires Firebird 3.0 or higher.
- Throws:
SQLException- if a database access error occurs- Since:
- 5.0.2
-