|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A MaintenanceManager
is responsible for replicating
the functionality provided by the gfix
command-line tool.
Among the responsibilities of this class are:
Field Summary | |
static int |
ACCESS_MODE_READ_ONLY
Database read-only mode |
static int |
ACCESS_MODE_READ_WRITE
Database read-write mode |
static int |
PAGE_FILL_FULL
Fully fill pages when inserting records. |
static int |
PAGE_FILL_RESERVE
While inserting recrods, reserve 20% of each page for later record deltas |
static int |
SHUTDOWN_ATTACH
Don't allow new connections while waiting to shut down. |
static int |
SHUTDOWN_FORCE
Forced database shutdown. |
static int |
SHUTDOWN_TRANSACTIONAL
Don't allow new transactions while waiting to shut down. |
static int |
VALIDATE_FULL
Do a full check on record and pages structures, releasing unassigned record fragments. |
static int |
VALIDATE_IGNORE_CHECKSUM
Ignore checksums during repair operations. |
static int |
VALIDATE_READ_ONLY
Only report corrupt or misallocated structures, don't fix. |
Method Summary | |
void |
activateShadowFile()
Activate a database shadow file to be used as the actual database. |
void |
bringDatabaseOnline()
Bring a shutdown database online. |
void |
commitTransaction(int transactionId)
Commit a limbo transaction based on its ID. |
void |
killUnavailableShadows()
Remove references to unavailable shadow files. |
void |
listLimboTransactions()
Retrieve the ID of each limbo transaction. |
void |
markCorruptRecords()
Mark corrupt records in the database as unavailable. |
void |
rollbackTransaction(int transactionId)
Rollback a limbo transaction based on its ID. |
void |
setDatabaseAccessMode(int mode)
Set the database to have read-write or read-only access. |
void |
setDatabaseDialect(int dialect)
Set the database's dialect. |
void |
setDefaultCacheBuffer(int pageCount)
Set the default page-buffer count to be cached in the database. |
void |
setForcedWrites(boolean forced)
Enable or disable forced (synchronous) writes in the database. |
void |
setPageFill(int pageFill)
Set the page fill strategy for when inserting records. |
void |
setSweepThreshold(int transactions)
Set the database automatic sweep interval to a given number of transactions. |
void |
shutdownDatabase(int shutdownMode,
int timeout)
Shutdown the current database. |
void |
sweepDatabase()
Perform an immediate sweep of the database. |
void |
validateDatabase()
Locate and release database pages that are allocated but unassigned to any data structures. |
void |
validateDatabase(int options)
Locate and release database pages that are allocated but unassigned to any data structures. |
Methods inherited from interface org.firebirdsql.management.ServiceManager |
getDatabase, getHost, getLogger, getPassword, getPort, getUser, setDatabase, setHost, setLogger, setPassword, setPort, setUser |
Field Detail |
public static final int ACCESS_MODE_READ_WRITE
public static final int ACCESS_MODE_READ_ONLY
public static final int SHUTDOWN_ATTACH
public static final int SHUTDOWN_TRANSACTIONAL
public static final int SHUTDOWN_FORCE
public static final int VALIDATE_READ_ONLY
public static final int VALIDATE_IGNORE_CHECKSUM
public static final int VALIDATE_FULL
public static final int PAGE_FILL_FULL
public static final int PAGE_FILL_RESERVE
Method Detail |
public void setDatabaseAccessMode(int mode) throws java.sql.SQLException
mode
- Must be either ACCESS_MODE_READ_WRITE
or ACCESS_MODE_READ_ONLY
java.sql.SQLException
- if a database access error occurspublic void setDatabaseDialect(int dialect) throws java.sql.SQLException
dialect
- The database dialect, must be either 1 or 3
java.sql.SQLException
- if a database access error occurspublic void setDefaultCacheBuffer(int pageCount) throws java.sql.SQLException
pageCount
- The number of pages to be cached, must be a positive
java.sql.SQLException
- If the given page count cannot be set, or a
database access error occurspublic void setForcedWrites(boolean forced) throws java.sql.SQLException
forced
- If true
, forced writes will be used in the
database, otherwise buffered writes will be used.
java.sql.SQLException
- if a database access error occurspublic void setPageFill(int pageFill) throws java.lang.Exception
pageFill
can be one of:
PAGE_FILL_FULL
Fully fill database pages
PAGE_FILL_RESERVE
Reserve 20% of page space for
later record deltas
pageFill
- The page-filling strategy, either
PAGE_FILL_FULL
or PAGE_FILL_RESERVE
java.sql.SQLException
- if a database access error occurs
java.lang.Exception
public void shutdownDatabase(int shutdownMode, int timeout) throws java.sql.SQLException
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.
shutdownMode
- One of SHUTDOWN_ATTACH
,
SHUTDOWN_TRANSACTIONAL
,
or SHUTDOWN_FORCE
.timeout
- The maximum amount of time allocated for the operation,
in seconds
java.sql.SQLException
- if the requested operation cannot be completed
within the given timeout, or a database access error occurspublic void bringDatabaseOnline() throws java.sql.SQLException
java.sql.SQLException
- if a database access error occurspublic void markCorruptRecords() throws java.sql.SQLException
java.sql.SQLException
- if a database access error occurspublic void validateDatabase() throws java.sql.SQLException
java.sql.SQLException
- if a database access error occurspublic void validateDatabase(int options) throws java.sql.SQLException
options
must be one of the
following:
VALIDATE_READ_ONLY
- read-only validation,
no repair
VALIDATE_FULL
- full validation and repair
options
can additionally be combined in
a bitmask with VALIDATE_IGNORE_CHECKSUM
to ignore
checksums while performing validation.
options
- Either 0, VALIDATE_READ_ONLY
, or
VALIDATE_FULL
java.sql.SQLException
- if a database access error occurspublic void setSweepThreshold(int transactions) throws java.sql.SQLException
transactions
is 0, automatic sweeping is disabled.
transactions
- The interval of transactions between automatic
sweeps of the database. Can be set to 0, which disables
automatic sweeping of the database.
java.sql.SQLException
- if a database access error occurspublic void sweepDatabase() throws java.sql.SQLException
java.sql.SQLException
- if a database access error occurspublic void activateShadowFile() throws java.sql.SQLException
gfix -activate
.
java.sql.SQLException
- if a database access error occurspublic void killUnavailableShadows() throws java.sql.SQLException
gfix -kill
.
java.sql.SQLException
- if a database access error occurspublic void listLimboTransactions() throws java.sql.SQLException
java.sql.SQLException
- if a database access error occurspublic void commitTransaction(int transactionId) throws java.sql.SQLException
transactionId
- The ID of the limbo transaction to be committed
java.sql.SQLException
- if a database access error occurs or the
given transaction ID is not validpublic void rollbackTransaction(int transactionId) throws java.sql.SQLException
transactionId
- The ID of the limbo transaction to be rolled back
java.sql.SQLException
- if a database access error occurs or the
given transaction ID is not valid
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |