Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.impl.store.raw.log.ReadOnly

Modifier and Type	Field and Description
private String	logArchiveDirectory

Access	Constructor and Description
public	ReadOnly()

Method Summary

Modifier and Type	Method and Description
public void	abortLogBackup() Implements org.apache.derby.iapi.store.raw.log.LogFactory.abortLogBackup.
public boolean	canSupport(Properties startParams) Implements org.apache.derby.iapi.services.monitor.ModuleSupportable.canSupport. See if this implementation can support any attributes that are listed in properties.
public boolean	checkpoint(RawStoreFactory - the raw store rawStoreFactory, DataFactory - the data factory dataFactory, TransactionFactory - the transaction factory transactionFactory, boolean - if true waits for any existing checkpoint to complete and then executes and waits for another checkpoint. if false if another thead is executing a checkpoint routine will return immediately. wait) Implements org.apache.derby.iapi.store.raw.log.LogFactory.checkpoint. MT - not needed, no work is done
public void	checkpointInRFR(LogInstant The LogInstant of the checkpoint cinstant, long Redo Low Water Mark in the check point record redoLWM, long Undo Low Water Mark in the checkpoint undoLWM, DataFactory - the data factory df) Implements org.apache.derby.iapi.store.raw.log.LogFactory.checkpointInRFR. Perform a checkpoint during rollforward recovery.
public boolean	checkVersion(int required database Engine major version requiredMajorVersion, int required database Engine minor version requiredMinorVersion, String Non-null to throw an exception, null to return the state of the version match. feature) Implements org.apache.derby.iapi.store.raw.log.LogFactory.checkVersion. Check to see if a database has been upgraded to the required level in order to use a store feature.
public void	createDataWarningFile() Implements org.apache.derby.iapi.store.raw.log.LogFactory.createDataWarningFile. Not applicable in readonly databases
public void	deleteLogFileAfterCheckpointLogFile() Implements org.apache.derby.iapi.store.raw.log.LogFactory.deleteLogFileAfterCheckpointLogFile.
public void	deleteOnlineArchivedLogFiles() Implements org.apache.derby.iapi.store.raw.log.LogFactory.deleteOnlineArchivedLogFiles.
public void	disableLogArchiveMode() Implements org.apache.derby.iapi.store.raw.log.LogFactory.disableLogArchiveMode.
public void	enableLogArchiveMode() Implements org.apache.derby.iapi.store.raw.log.LogFactory.enableLogArchiveMode.
public void	endLogBackup(File toDir) Implements org.apache.derby.iapi.store.raw.log.LogFactory.endLogBackup.
public void	flush(LogInstant flush log up to here where) Implements org.apache.derby.iapi.store.raw.log.LogFactory.flush. Flush all unwritten log record up to the log instance indicated to disk.
public void	freezePersistentStore() Implements org.apache.derby.iapi.store.raw.log.LogFactory.freezePersistentStore. Backup restore - stop sending log record to the log stream
public String	getCanonicalLogPath() Implements org.apache.derby.iapi.store.raw.log.LogFactory.getCanonicalLogPath. Return the canonical directory of the PARENT of the log directory.
public LogInstant	getFirstUnflushedInstant() Implements org.apache.derby.iapi.store.raw.log.LogFactory.getFirstUnflushedInstant. Get the instant for the last record in the log.
public long	getFirstUnflushedInstantAsLong() Implements org.apache.derby.iapi.store.raw.log.LogFactory.getFirstUnflushedInstantAsLong. Get the log instant long value of the first log record that has not been flushed.
public StorageFile	getLogDirectory() Implements org.apache.derby.iapi.store.raw.log.LogFactory.getLogDirectory. Return the location of the log directory.
public void	getLogFactoryProperties(PersistentSet set) Implements org.apache.derby.iapi.store.raw.log.LogFactory.getLogFactoryProperties. Get JBMS properties relevant to the log factory
public Logger	getLogger() Implements org.apache.derby.iapi.store.raw.log.LogFactory.getLogger.
public LogInstant	getTruncationLWM(UUID name)
public boolean	Returns: false always since replication is not applicable here. inReplicationMasterMode() Implements org.apache.derby.iapi.store.raw.log.LogFactory.inReplicationMasterMode. Replication not applicable on readonly databases.
public boolean	inRFR() Implements org.apache.derby.iapi.store.raw.log.LogFactory.inRFR.
public boolean	isCheckpointInLastLogFile() Implements org.apache.derby.iapi.store.raw.log.LogFactory.isCheckpointInLastLogFile.
public boolean	logArchived() Implements org.apache.derby.iapi.store.raw.log.LogFactory.logArchived. Backup restore - is the log being archived to some directory?
public StandardException	markCorrupt(StandardException originalError) Implements org.apache.derby.iapi.store.raw.Corruptable.markCorrupt. Mark the module as corrupt.
public ScanHandle	openFlushedScan(DatabaseInstant - the LogInstant where we start our scan. null means start at the beginning of the log. This function raises an error if startAt is a LogInstant which is not in the log. i, int - log record groups the scanner wants. groupsIWant) Implements org.apache.derby.iapi.store.raw.log.LogFactory.openFlushedScan. Get a ScanHandle to scan flushed records from the log.
public LogScan	openForwardsFlushedScan(LogInstant - the LogInstant where we start our scan. null means start at the beginning of the log. This function raises an error if startAt is a LogInstant which is not in the log. startAt) Implements org.apache.derby.iapi.store.raw.log.LogFactory.openForwardsFlushedScan. Get a LogScan to scan flushed records from the log.
public LogScan	openForwardsScan(LogInstant - the LogInstant where we start our scan. null means start at the beginning of the log. This function raises an error if startAt is a LogInstant which is not in the log. startAt, LogInstant - the LogInstant where we stop our scan. null means stop at the end of the log. This function raises an error if stopAt is a LogInstant which is not in the log. stopAt) Implements org.apache.derby.iapi.store.raw.log.LogFactory.openForwardsScan. Get a LogScan to scan the log in a forward direction.
public void	recover(DataFactory - the data factory dataFactory, TransactionFactory - the transaction factory transactionFactory) Implements org.apache.derby.iapi.store.raw.log.LogFactory.recover. MT - not needed, no work is done
public void	removeTruncationLWM(UUID name, RawStoreFactory rawStoreFactory, TransactionFactory transFactory)
public void	removeTruncationLWM(UUID name)
public void	setDatabaseEncrypted(boolean `true` if the database is encrypted, `false` if not isEncrypted, boolean `true` if log needs to be flushed, `false` otherwise flushLog) Implements org.apache.derby.iapi.store.raw.log.LogFactory.setDatabaseEncrypted. Sets whether the database is encrypted.
public void	setRawStoreFactory(RawStoreFactory rsf) Implements org.apache.derby.iapi.store.raw.log.LogFactory.setRawStoreFactory. Not applicable in readonly databases
public LogInstant	setTruncationLWM(UUID name, LogInstant instant, RawStoreFactory rawStoreFactory, TransactionFactory transFactory)
public void	setTruncationLWM(UUID name, LogInstant instant)
public void	startLogBackup(File toDir) Implements org.apache.derby.iapi.store.raw.log.LogFactory.startLogBackup.
public void	startNewLogFile() Implements org.apache.derby.iapi.store.raw.log.LogFactory.startNewLogFile.
public void	startReplicationMasterRole(MasterFactory The MasterFactory service responsible for controlling the master side replication behaviour. masterFactory) Implements org.apache.derby.iapi.store.raw.log.LogFactory.startReplicationMasterRole. Replication not applicable on readonly databases
public void	stopReplicationMasterRole() Implements org.apache.derby.iapi.store.raw.log.LogFactory.stopReplicationMasterRole. Replication not applicable on readonly databases
public void	unfreezePersistentStore() Implements org.apache.derby.iapi.store.raw.log.LogFactory.unfreezePersistentStore. Backup restore - start sending log record to the log stream

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

logArchiveDirectory	back to summary
private String logArchiveDirectory

ReadOnly	back to summary
public ReadOnly()

Method Detail

abortLogBackup	back to summary
public void abortLogBackup() Implements org.apache.derby.iapi.store.raw.log.LogFactory.abortLogBackup.

canSupport	back to summary
public boolean canSupport(Properties startParams) Implements org.apache.derby.iapi.services.monitor.ModuleSupportable.canSupport. Doc from org.apache.derby.iapi.services.monitor.ModuleSupportable.canSupport. See if this implementation can support any attributes that are listed in properties. This call may be made on a newly created instance before the boot() method has been called, or after the boot method has been called for a running module. The module can check for attributes in the properties to see if it can fulfill the required behaviour. E.g. the raw store may define an attribute called RawStore.Recoverable. If a temporary raw store is required the property RawStore.recoverable=false would be added to the properties before calling bootServiceModule. If a raw store cannot support this attribute its canSupport method would return null. Also see the Monitor class's prologue to see how the identifier is used in looking up properties. Actually a better way maybe to have properties of the form RawStore.Attributes.mandatory=recoverable,smallfootprint and RawStore.Attributes.requested=oltp,fast Returns:boolean true if this instance can be used, false otherwise.

canSupport

back to summary

public boolean canSupport(Properties startParams)

Implements org.apache.derby.iapi.services.monitor.ModuleSupportable.canSupport.

Doc from org.apache.derby.iapi.services.monitor.ModuleSupportable.canSupport.

See if this implementation can support any attributes that are listed in properties. This call may be made on a newly created instance before the boot() method has been called, or after the boot method has been called for a running module.

The module can check for attributes in the properties to see if it can fulfill the required behaviour. E.g. the raw store may define an attribute called RawStore.Recoverable. If a temporary raw store is required the property RawStore.recoverable=false would be added to the properties before calling bootServiceModule. If a raw store cannot support this attribute its canSupport method would return null. Also see the Monitor class's prologue to see how the identifier is used in looking up properties.
Actually a better way maybe to have properties of the form RawStore.Attributes.mandatory=recoverable,smallfootprint and RawStore.Attributes.requested=oltp,fast

Returns:boolean: true if this instance can be used, false otherwise.

checkpoint	back to summary
public boolean checkpoint(RawStoreFactory rawStoreFactory, DataFactory dataFactory, TransactionFactory transactionFactory, boolean wait) Implements org.apache.derby.iapi.store.raw.log.LogFactory.checkpoint. MT - not needed, no work is done Parameters rawStoreFactory:RawStoreFactory Doc from org.apache.derby.iapi.store.raw.log.LogFactory.checkpoint. - the raw store dataFactory:DataFactory Doc from org.apache.derby.iapi.store.raw.log.LogFactory.checkpoint. - the data factory transactionFactory:TransactionFactory Doc from org.apache.derby.iapi.store.raw.log.LogFactory.checkpoint. - the transaction factory wait:boolean Doc from org.apache.derby.iapi.store.raw.log.LogFactory.checkpoint. - if true waits for any existing checkpoint to complete and then executes and waits for another checkpoint. if false if another thead is executing a checkpoint routine will return immediately. Returns:boolean Doc from org.apache.derby.iapi.store.raw.log.LogFactory.checkpoint. true if checkpoint is successful, Will return false if wait is false and the routine finds another thread executing a checkpoint.

checkpointInRFR	back to summary
public void checkpointInRFR(LogInstant cinstant, long redoLWM, long undoLWM, DataFactory df) throws StandardException Implements org.apache.derby.iapi.store.raw.log.LogFactory.checkpointInRFR. Perform a checkpoint during rollforward recovery. Parameters cinstant:LogInstant Doc from org.apache.derby.iapi.store.raw.log.LogFactory.checkpointInRFR. The LogInstant of the checkpoint redoLWM:long Doc from org.apache.derby.iapi.store.raw.log.LogFactory.checkpointInRFR. Redo Low Water Mark in the check point record undoLWM:long Doc from org.apache.derby.iapi.store.raw.log.LogFactory.checkpointInRFR. Undo Low Water Mark in the checkpoint df:DataFactory Doc from org.apache.derby.iapi.store.raw.log.LogFactory.checkpointInRFR. - the data factory Exceptions StandardException: Doc from org.apache.derby.iapi.store.raw.log.LogFactory.checkpointInRFR. - encounter exception during checkpoint

checkVersion back to summary

checkVersion	back to summary
public boolean checkVersion(int requiredMajorVersion, int requiredMinorVersion, String feature) throws StandardException Implements org.apache.derby.iapi.store.raw.log.LogFactory.checkVersion. Check to see if a database has been upgraded to the required level in order to use a store feature. This method is generally used to prevent writes to data/log file by a particular store feature until the database is upgraded to the required version. In read-only database writes are not allowed, so nothing to do for this method in this implementation of the log factory. Parameters requiredMajorVersion:int required database Engine major version requiredMinorVersion:int required database Engine minor version feature:String Non-null to throw an exception, null to return the state of the version match. Returns:boolean Doc from org.apache.derby.iapi.store.raw.log.LogFactory.checkVersion. `true` if the database has been upgraded to the required level, `false` otherwise. Exceptions StandardException: not implemented exception is thrown

public boolean checkVersion(int requiredMajorVersion, int requiredMinorVersion, String feature) throws StandardException

Implements org.apache.derby.iapi.store.raw.log.LogFactory.checkVersion.

Check to see if a database has been upgraded to the required level in order to use a store feature. This method is generally used to prevent writes to data/log file by a particular store feature until the database is upgraded to the required version. In read-only database writes are not allowed, so nothing to do for this method in this implementation of the log factory.

Parameters

requiredMajorVersion:int: required database Engine major version
requiredMinorVersion:int: required database Engine minor version
feature:String: Non-null to throw an exception, null to return the state of the version match.

Returns:boolean

Doc from org.apache.derby.iapi.store.raw.log.LogFactory.checkVersion.

true if the database has been upgraded to the required level, false otherwise.

Exceptions

StandardException:: not implemented exception is thrown

createDataWarningFile	back to summary
public void createDataWarningFile() throws StandardException Implements org.apache.derby.iapi.store.raw.log.LogFactory.createDataWarningFile. Not applicable in readonly databases

createDataWarningFile

back to summary

public void createDataWarningFile() throws StandardException

Implements org.apache.derby.iapi.store.raw.log.LogFactory.createDataWarningFile.

Not applicable in readonly databases

deleteLogFileAfterCheckpointLogFile	back to summary
public void deleteLogFileAfterCheckpointLogFile() throws StandardException Implements org.apache.derby.iapi.store.raw.log.LogFactory.deleteLogFileAfterCheckpointLogFile.

deleteOnlineArchivedLogFiles	back to summary
public void deleteOnlineArchivedLogFiles() Implements org.apache.derby.iapi.store.raw.log.LogFactory.deleteOnlineArchivedLogFiles.

disableLogArchiveMode	back to summary
public void disableLogArchiveMode() Implements org.apache.derby.iapi.store.raw.log.LogFactory.disableLogArchiveMode.

enableLogArchiveMode	back to summary
public void enableLogArchiveMode() Implements org.apache.derby.iapi.store.raw.log.LogFactory.enableLogArchiveMode.

endLogBackup	back to summary
public void endLogBackup(File toDir) throws StandardException Implements org.apache.derby.iapi.store.raw.log.LogFactory.endLogBackup.

flush	back to summary
public void flush(LogInstant where) throws StandardException Implements org.apache.derby.iapi.store.raw.log.LogFactory.flush. Doc from org.apache.derby.iapi.store.raw.log.LogFactory.flush. Flush all unwritten log record up to the log instance indicated to disk. Parameters where:LogInstant flush log up to here Exceptions StandardException: cannot flush log file due to sync error

flush

back to summary

public void flush(LogInstant where) throws StandardException

Implements org.apache.derby.iapi.store.raw.log.LogFactory.flush.

Doc from org.apache.derby.iapi.store.raw.log.LogFactory.flush.

Flush all unwritten log record up to the log instance indicated to disk.

Parameters

where:LogInstant: flush log up to here

Exceptions

StandardException:: cannot flush log file due to sync error

freezePersistentStore	back to summary
public void freezePersistentStore() throws StandardException Implements org.apache.derby.iapi.store.raw.log.LogFactory.freezePersistentStore. Backup restore - stop sending log record to the log stream Exceptions StandardException: Standard Derby error policy

freezePersistentStore

back to summary

public void freezePersistentStore() throws StandardException

Implements org.apache.derby.iapi.store.raw.log.LogFactory.freezePersistentStore.

Backup restore - stop sending log record to the log stream

Exceptions

StandardException:: Standard Derby error policy

getCanonicalLogPath	back to summary
public String getCanonicalLogPath() Implements org.apache.derby.iapi.store.raw.log.LogFactory.getCanonicalLogPath. Doc from org.apache.derby.iapi.store.raw.log.LogFactory.getCanonicalLogPath. Return the canonical directory of the PARENT of the log directory. The log directory live in the "log" subdirectory of this path. If the log is at the default location (underneath the database directory), this returns null. Should only be called after the log factory is booted.

getCanonicalLogPath

back to summary

public String getCanonicalLogPath()

Implements org.apache.derby.iapi.store.raw.log.LogFactory.getCanonicalLogPath.

Doc from org.apache.derby.iapi.store.raw.log.LogFactory.getCanonicalLogPath.

Return the canonical directory of the PARENT of the log directory. The log directory live in the "log" subdirectory of this path. If the log is at the default location (underneath the database directory), this returns null. Should only be called after the log factory is booted.

getFirstUnflushedInstant	back to summary
public LogInstant getFirstUnflushedInstant() Implements org.apache.derby.iapi.store.raw.log.LogFactory.getFirstUnflushedInstant. Doc from org.apache.derby.iapi.store.raw.log.LogFactory.getFirstUnflushedInstant. Get the instant for the last record in the log.

getFirstUnflushedInstant

back to summary

public LogInstant getFirstUnflushedInstant()

Implements org.apache.derby.iapi.store.raw.log.LogFactory.getFirstUnflushedInstant.

Doc from org.apache.derby.iapi.store.raw.log.LogFactory.getFirstUnflushedInstant.

Get the instant for the last record in the log.

getFirstUnflushedInstantAsLong	back to summary
public long getFirstUnflushedInstantAsLong() Implements org.apache.derby.iapi.store.raw.log.LogFactory.getFirstUnflushedInstantAsLong. Doc from org.apache.derby.iapi.store.raw.log.LogFactory.getFirstUnflushedInstantAsLong. Get the log instant long value of the first log record that has not been flushed. Only works after recover() has finished, or (if in slave replication mode) after calling initializeReplicationSlaveRole. Returns:long the log instant long value of the first log record that has not been flushed

getFirstUnflushedInstantAsLong

back to summary

public long getFirstUnflushedInstantAsLong()

Implements org.apache.derby.iapi.store.raw.log.LogFactory.getFirstUnflushedInstantAsLong.

Doc from org.apache.derby.iapi.store.raw.log.LogFactory.getFirstUnflushedInstantAsLong.

Get the log instant long value of the first log record that has not been flushed. Only works after recover() has finished, or (if in slave replication mode) after calling initializeReplicationSlaveRole.

Returns:long: the log instant long value of the first log record that has not been flushed

getLogDirectory	back to summary
public StorageFile getLogDirectory() Implements org.apache.derby.iapi.store.raw.log.LogFactory.getLogDirectory. Doc from org.apache.derby.iapi.store.raw.log.LogFactory.getLogDirectory. Return the location of the log directory.

getLogDirectory

back to summary

public StorageFile getLogDirectory()

Implements org.apache.derby.iapi.store.raw.log.LogFactory.getLogDirectory.

Doc from org.apache.derby.iapi.store.raw.log.LogFactory.getLogDirectory.

Return the location of the log directory.

getLogFactoryProperties	back to summary
public void getLogFactoryProperties(PersistentSet set) Implements org.apache.derby.iapi.store.raw.log.LogFactory.getLogFactoryProperties. Get JBMS properties relevant to the log factory

getLogFactoryProperties

back to summary

public void getLogFactoryProperties(PersistentSet set)

Implements org.apache.derby.iapi.store.raw.log.LogFactory.getLogFactoryProperties.

Get JBMS properties relevant to the log factory

getLogger	back to summary
public Logger getLogger() Implements org.apache.derby.iapi.store.raw.log.LogFactory.getLogger.

getTruncationLWM	back to summary
public LogInstant getTruncationLWM(UUID name) throws StandardException Exceptions StandardException: functionality not implemented

inReplicationMasterMode	back to summary
public boolean inReplicationMasterMode() Implements org.apache.derby.iapi.store.raw.log.LogFactory.inReplicationMasterMode. Replication not applicable on readonly databases. Returns:boolean false always since replication is not applicable here.

inReplicationMasterMode

back to summary

public boolean inReplicationMasterMode()

Implements org.apache.derby.iapi.store.raw.log.LogFactory.inReplicationMasterMode.

Replication not applicable on readonly databases.

Returns:boolean: false always since replication is not applicable here.

inRFR	back to summary
public boolean inRFR() Implements org.apache.derby.iapi.store.raw.log.LogFactory.inRFR.

isCheckpointInLastLogFile	back to summary
public boolean isCheckpointInLastLogFile() throws StandardException Implements org.apache.derby.iapi.store.raw.log.LogFactory.isCheckpointInLastLogFile.

logArchived	back to summary
public boolean logArchived() Implements org.apache.derby.iapi.store.raw.log.LogFactory.logArchived. Backup restore - is the log being archived to some directory? if RawStore.LOG_ARCHIVAL_DIRECTORY is set to some value, that means the log is meant to be archived. Else, log not archived. Returns:boolean Doc from org.apache.derby.iapi.store.raw.log.LogFactory.logArchived. true if the log is being archived.

logArchived

back to summary

public boolean logArchived()

Implements org.apache.derby.iapi.store.raw.log.LogFactory.logArchived.

Backup restore - is the log being archived to some directory? if RawStore.LOG_ARCHIVAL_DIRECTORY is set to some value, that means the log is meant to be archived. Else, log not archived.

Returns:boolean

Doc from org.apache.derby.iapi.store.raw.log.LogFactory.logArchived.

true if the log is being archived.

markCorrupt	back to summary
public StandardException markCorrupt(StandardException originalError) Implements org.apache.derby.iapi.store.raw.Corruptable.markCorrupt. Doc from org.apache.derby.iapi.store.raw.Corruptable.markCorrupt. Mark the module as corrupt. It is safe to call this multiple times. Returns:StandardException Must always return its parameter.

markCorrupt

back to summary

public StandardException markCorrupt(StandardException originalError)

Implements org.apache.derby.iapi.store.raw.Corruptable.markCorrupt.

Doc from org.apache.derby.iapi.store.raw.Corruptable.markCorrupt.

Mark the module as corrupt. It is safe to call this multiple times.

Returns:StandardException: Must always return its parameter.

openFlushedScan	back to summary
public ScanHandle openFlushedScan(DatabaseInstant i, int groupsIWant) throws StandardException Implements org.apache.derby.iapi.store.raw.log.LogFactory.openFlushedScan. Doc from org.apache.derby.iapi.store.raw.log.LogFactory.openFlushedScan. Get a ScanHandle to scan flushed records from the log. MT- read only Parameters i:DatabaseInstant - the LogInstant where we start our scan. null means start at the beginning of the log. This function raises an error if startAt is a LogInstant which is not in the log. groupsIWant:int - log record groups the scanner wants. Returns:ScanHandle the LogScan. Exceptions StandardException: functionality not implemented

openFlushedScan

back to summary

public ScanHandle openFlushedScan(DatabaseInstant i, int groupsIWant) throws StandardException

Implements org.apache.derby.iapi.store.raw.log.LogFactory.openFlushedScan.

Doc from org.apache.derby.iapi.store.raw.log.LogFactory.openFlushedScan.

Get a ScanHandle to scan flushed records from the log.

MT- read only

Parameters

i:DatabaseInstant: - the LogInstant where we start our scan. null means start at the beginning of the log. This function raises an error if startAt is a LogInstant which is not in the log.
groupsIWant:int: - log record groups the scanner wants.

Returns:ScanHandle

the LogScan.

Exceptions

StandardException:: functionality not implemented

openForwardsFlushedScan	back to summary
public LogScan openForwardsFlushedScan(LogInstant startAt) throws StandardException Implements org.apache.derby.iapi.store.raw.log.LogFactory.openForwardsFlushedScan. Doc from org.apache.derby.iapi.store.raw.log.LogFactory.openForwardsFlushedScan. Get a LogScan to scan flushed records from the log. MT- read only Parameters startAt:LogInstant - the LogInstant where we start our scan. null means start at the beginning of the log. This function raises an error if startAt is a LogInstant which is not in the log. Returns:LogScan the LogScan. Exceptions StandardException: functionality not implemented

openForwardsFlushedScan

back to summary

public LogScan openForwardsFlushedScan(LogInstant startAt) throws StandardException

Implements org.apache.derby.iapi.store.raw.log.LogFactory.openForwardsFlushedScan.

Doc from org.apache.derby.iapi.store.raw.log.LogFactory.openForwardsFlushedScan.

Get a LogScan to scan flushed records from the log.

MT- read only

Parameters

startAt:LogInstant: - the LogInstant where we start our scan. null means start at the beginning of the log. This function raises an error if startAt is a LogInstant which is not in the log.

Returns:LogScan

the LogScan.

Exceptions

StandardException:: functionality not implemented

openForwardsScan	back to summary
public LogScan openForwardsScan(LogInstant startAt, LogInstant stopAt) throws StandardException Implements org.apache.derby.iapi.store.raw.log.LogFactory.openForwardsScan. Doc from org.apache.derby.iapi.store.raw.log.LogFactory.openForwardsScan. Get a LogScan to scan the log in a forward direction. MT- read only Parameters startAt:LogInstant - the LogInstant where we start our scan. null means start at the beginning of the log. This function raises an error if startAt is a LogInstant which is not in the log. stopAt:LogInstant - the LogInstant where we stop our scan. null means stop at the end of the log. This function raises an error if stopAt is a LogInstant which is not in the log. Returns:LogScan the LogScan. Exceptions StandardException: functionality not implemented

openForwardsScan

back to summary

public LogScan openForwardsScan(LogInstant startAt, LogInstant stopAt) throws StandardException

Implements org.apache.derby.iapi.store.raw.log.LogFactory.openForwardsScan.

Doc from org.apache.derby.iapi.store.raw.log.LogFactory.openForwardsScan.

Get a LogScan to scan the log in a forward direction.

MT- read only

Parameters

startAt:LogInstant: - the LogInstant where we start our scan. null means start at the beginning of the log. This function raises an error if startAt is a LogInstant which is not in the log.
stopAt:LogInstant: - the LogInstant where we stop our scan. null means stop at the end of the log. This function raises an error if stopAt is a LogInstant which is not in the log.

Returns:LogScan

the LogScan.

Exceptions

StandardException:: functionality not implemented

recover	back to summary
public void recover(DataFactory dataFactory, TransactionFactory transactionFactory) throws StandardException Implements org.apache.derby.iapi.store.raw.log.LogFactory.recover. MT - not needed, no work is done Parameters dataFactory:DataFactory Doc from org.apache.derby.iapi.store.raw.log.LogFactory.recover. - the data factory transactionFactory:TransactionFactory Doc from org.apache.derby.iapi.store.raw.log.LogFactory.recover. - the transaction factory Exceptions StandardException: Standard Derby Error Policy

removeTruncationLWM	back to summary
public void removeTruncationLWM(UUID name, RawStoreFactory rawStoreFactory, TransactionFactory transFactory) throws StandardException Exceptions StandardException: functionality not implemented

removeTruncationLWM	back to summary
public void removeTruncationLWM(UUID name) throws StandardException Exceptions StandardException: functionality not implemented

setDatabaseEncrypted back to summary

setDatabaseEncrypted	back to summary
public void setDatabaseEncrypted(boolean isEncrypted, boolean flushLog) Implements org.apache.derby.iapi.store.raw.log.LogFactory.setDatabaseEncrypted. Sets whether the database is encrypted. Read-only database can not be re-encrypted, nothing to do in this case. Parameters isEncrypted:boolean Doc from org.apache.derby.iapi.store.raw.log.LogFactory.setDatabaseEncrypted. `true` if the database is encrypted, `false` if not flushLog:boolean Doc from org.apache.derby.iapi.store.raw.log.LogFactory.setDatabaseEncrypted. `true` if log needs to be flushed, `false` otherwise

public void setDatabaseEncrypted(boolean isEncrypted, boolean flushLog)

Implements org.apache.derby.iapi.store.raw.log.LogFactory.setDatabaseEncrypted.

Sets whether the database is encrypted.

Read-only database can not be re-encrypted, nothing to do in this case.

Parameters

isEncrypted:boolean

Doc from org.apache.derby.iapi.store.raw.log.LogFactory.setDatabaseEncrypted.

true if the database is encrypted, false if not

flushLog:boolean

Doc from org.apache.derby.iapi.store.raw.log.LogFactory.setDatabaseEncrypted.

true if log needs to be flushed, false otherwise

setRawStoreFactory	back to summary
public void setRawStoreFactory(RawStoreFactory rsf) Implements org.apache.derby.iapi.store.raw.log.LogFactory.setRawStoreFactory. Not applicable in readonly databases

setRawStoreFactory

back to summary

public void setRawStoreFactory(RawStoreFactory rsf)

Implements org.apache.derby.iapi.store.raw.log.LogFactory.setRawStoreFactory.

Not applicable in readonly databases

setTruncationLWM	back to summary
public LogInstant setTruncationLWM(UUID name, LogInstant instant, RawStoreFactory rawStoreFactory, TransactionFactory transFactory) throws StandardException

setTruncationLWM	back to summary
public void setTruncationLWM(UUID name, LogInstant instant) throws StandardException Exceptions StandardException: functionality not implemented

startLogBackup	back to summary
public void startLogBackup(File toDir) throws StandardException Implements org.apache.derby.iapi.store.raw.log.LogFactory.startLogBackup.

startNewLogFile	back to summary
public void startNewLogFile() throws StandardException Implements org.apache.derby.iapi.store.raw.log.LogFactory.startNewLogFile.

startReplicationMasterRole	back to summary
public void startReplicationMasterRole(MasterFactory masterFactory) throws StandardException Implements org.apache.derby.iapi.store.raw.log.LogFactory.startReplicationMasterRole. Replication not applicable on readonly databases Parameters masterFactory:MasterFactory Doc from org.apache.derby.iapi.store.raw.log.LogFactory.startReplicationMasterRole. The MasterFactory service responsible for controlling the master side replication behaviour. Exceptions StandardException: always thrown, indicating that ReadOnly databases can not be replicated

startReplicationMasterRole

back to summary

public void startReplicationMasterRole(MasterFactory masterFactory) throws StandardException

Implements org.apache.derby.iapi.store.raw.log.LogFactory.startReplicationMasterRole.

Replication not applicable on readonly databases

Parameters

masterFactory:MasterFactory

Doc from org.apache.derby.iapi.store.raw.log.LogFactory.startReplicationMasterRole.

The MasterFactory service responsible for controlling the master side replication behaviour.

Exceptions

StandardException:: always thrown, indicating that ReadOnly databases can not be replicated

stopReplicationMasterRole	back to summary
public void stopReplicationMasterRole() Implements org.apache.derby.iapi.store.raw.log.LogFactory.stopReplicationMasterRole. Replication not applicable on readonly databases

stopReplicationMasterRole

back to summary

public void stopReplicationMasterRole()

Implements org.apache.derby.iapi.store.raw.log.LogFactory.stopReplicationMasterRole.

Replication not applicable on readonly databases

unfreezePersistentStore	back to summary
public void unfreezePersistentStore() throws StandardException Implements org.apache.derby.iapi.store.raw.log.LogFactory.unfreezePersistentStore. Backup restore - start sending log record to the log stream Exceptions StandardException: Standard Derby error policy

unfreezePersistentStore

back to summary

public void unfreezePersistentStore() throws StandardException

Implements org.apache.derby.iapi.store.raw.log.LogFactory.unfreezePersistentStore.

Backup restore - start sending log record to the log stream

Exceptions

StandardException:: Standard Derby error policy

public Class ReadOnly

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail