- All Implemented Interfaces:
AttachmentProperties,BaseProperties,ServiceConnectionProperties,MaintenanceManager,ServiceManager
FBMaintenanceManager class 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 new with Firebird 2.5
- 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
- Activating and killing shadow files
- Displaying, committing, or recovering limbo transactions
- Author:
- Gabriel Reid, Thomas Steinmaurer, Mark Rotteveel
-
Field Summary
Fields inherited from class org.firebirdsql.management.FBServiceManager
BUFFER_SIZEFields inherited from interface org.firebirdsql.management.MaintenanceManager
ACCESS_MODE_READ_ONLY, ACCESS_MODE_READ_WRITE, OPERATION_MODE_FULL_SHUTDOWN, OPERATION_MODE_MULTI, OPERATION_MODE_NORMAL, OPERATION_MODE_SINGLE, PAGE_FILL_FULL, PAGE_FILL_RESERVE, SHUTDOWN_ATTACH, SHUTDOWN_FORCE, SHUTDOWN_TRANSACTIONAL, SHUTDOWNEX_ATTACHMENTS, SHUTDOWNEX_FORCE, SHUTDOWNEX_TRANSACTIONS, VALIDATE_FULL, VALIDATE_IGNORE_CHECKSUM, VALIDATE_READ_ONLY -
Constructor Summary
ConstructorsConstructorDescriptionCreate a new instance ofFBMaintenanceManagerbased on the default GDSType.FBMaintenanceManager(String gdsType) Create a new instance ofFBMaintenanceManagerbased on a given GDSType.FBMaintenanceManager(GDSType gdsType) Create a new instance ofFBMaintenanceManagerbased on a given GDSType. -
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 class org.firebirdsql.management.FBServiceManager
attachDatabase, attachServiceManager, connectionPropertyValues, createRequestBuffer, executeServicesOperation, getAuthPlugins, getBooleanProperty, getCharSet, getDatabase, getDbCryptConfig, getExpectedDb, getHost, getIntProperty, getLogger, getPassword, getPort, getPortNumber, getProperty, getServerName, getServerVersion, getServiceName, getUser, getWireCrypt, getWireCryptAsEnum, isWireCompression, queueService, setAuthPlugins, setBooleanProperty, setCharSet, setDatabase, setDbCryptConfig, setExpectedDb, setHost, setIntProperty, setLogger, setPassword, setPort, setPortNumber, setProperty, setServerName, setServiceName, setType, setUser, setWireCompression, setWireCryptAsEnumMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods 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
-
Constructor Details
-
FBMaintenanceManager
public FBMaintenanceManager()Create a new instance ofFBMaintenanceManagerbased on the default GDSType. -
FBMaintenanceManager
Create a new instance ofFBMaintenanceManagerbased on a given GDSType.- Parameters:
gdsType- type must be PURE_JAVA, EMBEDDED, or NATIVE
-
FBMaintenanceManager
Create a new instance ofFBMaintenanceManagerbased on a given GDSType.- Parameters:
gdsType- The GDS implementation type to use
-
-
Method Details
-
setDatabaseAccessMode
Description copied from interface:MaintenanceManagerSet the database to have read-write or read-only access.- Specified by:
setDatabaseAccessModein interfaceMaintenanceManager- Parameters:
mode- Must be eitherACCESS_MODE_READ_WRITEorACCESS_MODE_READ_ONLY- Throws:
SQLException- if a database access error occurs
-
setDatabaseDialect
Description copied from interface:MaintenanceManagerSet the database's dialect.- Specified by:
setDatabaseDialectin interfaceMaintenanceManager- Parameters:
dialect- The database dialect, must be either 1 or 3- Throws:
SQLException- if a database access error occurs
-
setDefaultCacheBuffer
Description copied from interface:MaintenanceManagerSet the default page-buffer count to be cached in the database.- Specified by:
setDefaultCacheBufferin interfaceMaintenanceManager- 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
Description copied from interface:MaintenanceManagerEnable 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.
- Specified by:
setForcedWritesin interfaceMaintenanceManager- 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
Description copied from interface:MaintenanceManagerSet 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
- Specified by:
setPageFillin interfaceMaintenanceManager- Parameters:
pageFill- The page-filling strategy, eitherPAGE_FILL_FULLorPAGE_FILL_RESERVE- Throws:
SQLException- if a database access error occurs
-
shutdownDatabase
Description copied from interface:MaintenanceManagerShutdown 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.
- Specified by:
shutdownDatabasein interfaceMaintenanceManager- 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
public void shutdownDatabase(byte operationMode, int shutdownModeEx, int timeout) throws SQLException Description copied from interface:MaintenanceManagerShutdown 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.
- Specified by:
shutdownDatabasein interfaceMaintenanceManager- 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
-
bringDatabaseOnline
Description copied from interface:MaintenanceManagerBring a shutdown database online.- Specified by:
bringDatabaseOnlinein interfaceMaintenanceManager- Throws:
SQLException- if a database access error occurs
-
bringDatabaseOnline
Description copied from interface:MaintenanceManagerBring 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.
- Specified by:
bringDatabaseOnlinein interfaceMaintenanceManager- Throws:
SQLException- if a database access error occurs
-
markCorruptRecords
Description copied from interface:MaintenanceManagerMark corrupt records in the database as unavailable.This operation ensures that the corrupt records are skipped (for example, during a subsequent backup).
- Specified by:
markCorruptRecordsin interfaceMaintenanceManager- Throws:
SQLException- if a database access error occurs
-
validateDatabase
Description copied from interface:MaintenanceManagerLocate and release database pages that are allocated but unassigned to any data structures. This method also reports corrupt structures.- Specified by:
validateDatabasein interfaceMaintenanceManager- Throws:
SQLException- if a database access error occurs
-
validateDatabase
Description copied from interface:MaintenanceManagerLocate 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.- Specified by:
validateDatabasein interfaceMaintenanceManager- Parameters:
options- Either 0,VALIDATE_READ_ONLY, orVALIDATE_FULL- Throws:
SQLException- if a database access error occurs
-
setSweepThreshold
Description copied from interface:MaintenanceManagerSet 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.- Specified by:
setSweepThresholdin interfaceMaintenanceManager- 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
Description copied from interface:MaintenanceManagerPerform an immediate sweep of the database.- Specified by:
sweepDatabasein interfaceMaintenanceManager- Throws:
SQLException- if a database access error occurs
-
activateShadowFile
Description copied from interface:MaintenanceManagerActivate a database shadow file to be used as the actual database.This method is the equivalent of
gfix -activate.- Specified by:
activateShadowFilein interfaceMaintenanceManager- Throws:
SQLException- if a database access error occurs
-
limboTransactionsAsList
Description copied from interface:MaintenanceManagerRetrieve the ID of each limbo transaction as a List of Long objects.- Specified by:
limboTransactionsAsListin interfaceMaintenanceManager- Throws:
SQLException- if a database access error occurs
-
getLimboTransactions
Description copied from interface:MaintenanceManagerRetrieve the ID of each limbo transaction as an array of longs.In Firebird 3, transactions are (unsigned) 48 bit longs.
- Specified by:
getLimboTransactionsin interfaceMaintenanceManager- Throws:
SQLException- if a database access error occurs
-
commitTransaction
Description copied from interface:MaintenanceManagerCommit 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)- Specified by:
commitTransactionin interfaceMaintenanceManager- 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
Description copied from interface:MaintenanceManagerRollback 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)- Specified by:
rollbackTransactionin interfaceMaintenanceManager- 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
Description copied from interface:MaintenanceManagerPerform minor ODS upgrade.Requires Firebird 5.0 or higher.
- Specified by:
upgradeOdsin interfaceMaintenanceManager- Throws:
SQLException- if a database access error occurs
-
fixIcu
Description copied from interface:MaintenanceManagerUpdate or rebuild ICU-dependent collations and indexes when ICU version changed.Requires Firebird 3.0 or higher.
- Specified by:
fixIcuin interfaceMaintenanceManager- Throws:
SQLException- if a database access error occurs
-