public interface ContainerHandle
Container c; Page p1 = c.getPage(Container.FIRST_PAGE_NUMBER); Page p2 = c.getPage(Container.FIRST_PAGE_NUMBER); p1.unlatch(); -- Page is still latched. p2.unlatch(); -- Page is now unlatched.
There is no restriction on the order in which latching and unlatching is done. In the example, p1 could have been unlatched after p2 with no ill effects.
Open container modes
ContainerHandle.MODE are used to open or create the container.
Unlike TableProperties, MODEs are not permanantely associated with the
container, it is effective only for the lifetime of the containerHandle
itself.
A container may use any of these mode flags when it is opened.
Temporary Containers
If when creating a container the segment used is
ContainerHandle.TEMPORARY_SEGMENT then the container is a temporary
container. Temporary containers are not logged or locked and do not live
across re-boots of the system. In addition any abort or rollback including
rollbacks to savepoints truncate the container if it has been opened for
update since the last commit or abort. Temporary containers are private
to a transaction and must only be used a single thread within the
transaction at any time, these restrictions are not currently enforced.
When opening a temporary container for update access these additional mode
flags may be used
Modifier and Type | Field and Description |
---|---|
static int |
ADD_PAGE_BULK |
static int |
ADD_PAGE_DEFAULT |
static int |
DEFAULT_ASSIGN_ID |
static int |
DEFAULT_PAGESIZE
Used in add container.
|
static int |
DEFAULT_SPARESPACE |
static long |
FIRST_PAGE_NUMBER
The first valid page number
|
static int |
GET_PAGE_UNFILLED |
static long |
INVALID_PAGE_NUMBER
A page number that is guaranteed to be invalid.
|
static int |
MODE_BASEROW_INSERT_LOCKED |
static int |
MODE_CREATE_UNLOGGED |
static int |
MODE_DEFAULT
See comments above for these modes.
|
static int |
MODE_DROP_ON_COMMIT |
static int |
MODE_FLUSH_ON_COMMIT |
static int |
MODE_FORUPDATE |
static int |
MODE_LOCK_NOWAIT |
static int |
MODE_LOCK_ROW_NOWAIT |
static int |
MODE_NO_ACTIONS_ON_COMMIT |
static int |
MODE_OPEN_FOR_LOCK_ONLY |
static int |
MODE_READONLY |
static int |
MODE_SECONDARY_LOCKED |
static int |
MODE_TEMP_IS_KEPT |
static int |
MODE_TRUNCATE_ON_COMMIT |
static int |
MODE_TRUNCATE_ON_ROLLBACK |
static int |
MODE_UNLOGGED |
static int |
MODE_USE_UPDATE_LOCKS |
static int |
TEMPORARY_SEGMENT |
Modifier and Type | Method and Description |
---|---|
Page |
addPage()
Add an empty page to the container and obtain exclusive access to it.
|
Page |
addPage(int flag)
Add an empty page to the container and obtain exclusive access to it.
|
void |
backupContainer(java.lang.String backupContainerPath)
Backup the container to the specified path.
|
void |
close()
Close me.
|
void |
compactRecord(RecordHandle record)
This record probably has shrunk considerably.
|
void |
compressContainer()
Release free space to the OS.
|
void |
flushContainer()
Flush all dirty pages of the container to disk.
|
void |
getContainerProperties(java.util.Properties prop)
Request the system properties associated with a container.
|
long |
getEstimatedPageCount(int flag)
Get the total estimated number of allocated (not freed, not
deallocated) user pages in the container, including overflow pages.
|
long |
getEstimatedRowCount(int flag)
Get the total estimated number of rows in the container, not including
overflow rows.
|
Page |
getFirstPage()
Obtain exclusive access to the current first page of the container.
|
ContainerKey |
getId()
Return my identifier.
|
LockingPolicy |
getLockingPolicy()
Return the locking policy for this open container.
|
Page |
getNextPage(long prevNum)
Obtain exclusive access to the next valid page of the given page number
in the container.
|
Page |
getPage(long pageNumber)
Obtain exclusive access to the page with the given page number.
|
Page |
getPageForCompress(int flag,
long pageno) |
Page |
getPageForInsert(int flag)
Get a page for insert.
|
Page |
getPageNoWait(long pageNumber)
Identical to getPage but returns null immediately if the desired page
is already latched by another Container.
|
long |
getReusableRecordIdSequenceNumber()
Get the reusable recordId sequence number.
|
SpaceInfo |
getSpaceInfo()
Get information about space used by the container.
|
java.lang.Object |
getUniqueId()
Return my unique identifier, this identifier will be unique to each
instance of an open container handle.
|
Page |
getUserPageNoWait(long pageNumber)
Obtain exclusive access to the page with the given page number.
|
Page |
getUserPageWait(long pageNumber)
Obtain exclusive access to the page with the given page number.
|
boolean |
isReadOnly()
Is the container opened for read only or update?
|
boolean |
isTemporaryContainer()
Return true if this containerHandle refers to a temporary container.
|
RecordHandle |
makeRecordHandle(long pageNumber,
int recordId)
Return a record handle that is initialized to the given segment id,
container id, page number and record id.
|
void |
preAllocate(int numPage)
Try to preallocate numPage new pages if possible.
|
void |
removePage(Page page)
Remove this page from the container and unlatch the page.
|
void |
setEstimatedRowCount(long count,
int flag)
Set the total estimated number of rows in the container.
|
void |
setLockingPolicy(LockingPolicy newLockingPolicy)
Set the locking policy for this open container
|
static final int DEFAULT_PAGESIZE
static final int DEFAULT_SPARESPACE
static final int DEFAULT_ASSIGN_ID
static final int MODE_DEFAULT
static final int MODE_UNLOGGED
static final int MODE_CREATE_UNLOGGED
static final int MODE_FORUPDATE
static final int MODE_READONLY
static final int MODE_TRUNCATE_ON_COMMIT
static final int MODE_DROP_ON_COMMIT
static final int MODE_OPEN_FOR_LOCK_ONLY
static final int MODE_LOCK_NOWAIT
static final int MODE_TRUNCATE_ON_ROLLBACK
static final int MODE_FLUSH_ON_COMMIT
static final int MODE_NO_ACTIONS_ON_COMMIT
static final int MODE_TEMP_IS_KEPT
static final int MODE_USE_UPDATE_LOCKS
static final int MODE_SECONDARY_LOCKED
static final int MODE_BASEROW_INSERT_LOCKED
static final int MODE_LOCK_ROW_NOWAIT
static final int TEMPORARY_SEGMENT
static final long FIRST_PAGE_NUMBER
static final long INVALID_PAGE_NUMBER
static final int ADD_PAGE_DEFAULT
static final int ADD_PAGE_BULK
static final int GET_PAGE_UNFILLED
ContainerKey getId()
java.lang.Object getUniqueId()
boolean isReadOnly()
Page addPage() throws StandardException
Note that the added page may not be the last page in the Container. Once the Page is no longer required the Page's unlatch() method must be called.
StandardException
- If a page could not be allocated.Page.unlatch()
void compressContainer() throws StandardException
As is possible release any free space to the operating system. This will usually mean releasing any free pages located at the end of the file using the java truncate() interface.
StandardException
- Standard Derby error policylong getReusableRecordIdSequenceNumber() throws StandardException
StandardException
- Standard Derby error policyPage addPage(int flag) throws StandardException
If flag == ADD_PAGE_DEFAULT, this call is identical to addPage().
If flag == ADD_PAGE_BULK, then this call signifies to the container that
this addPage is part of a large number of additional pages and it is
desirable to do whatever possible to facilitate adding many subsequent pages.
The actual container implementation will decide whether or not to heed
this hint and what to do about it.
StandardException
- Standard Derby error policyStandardException
- If a page could not be allocated.Page.unlatch()
void preAllocate(int numPage)
void removePage(Page page) throws StandardException
Locking Policy
The page will not be freed until the transaction that removed the page
commits. A special RecordHandle.DEALLOC_PROTECTION_HANDLE lock will be
gotten for the transaction and which is used to prevent the page from
being freed. This lock will be held regardless of the default locking
policy of the transaction that called removedPage.
StandardException
- Standard Derby error policyLockingPolicy
,
RecordHandle
Page getPage(long pageNumber) throws StandardException
The Page object is guaranteed to remain in-memory and exclusive to the caller until its unlatch() method is called.
StandardException
- Standard Derby error policyPage getPageNoWait(long pageNumber) throws StandardException
StandardException
- Standard Derby error policyPage getUserPageNoWait(long pageNumber) throws StandardException
The Page object is guaranteed to remain in-memory and exclusive to the caller until its unlatch() method is called.
StandardException
- Standard Derby error policyPage getUserPageWait(long pageNumber) throws StandardException
The Page object is guaranteed to remain in-memory and exclusive to the caller until its unlatch() method is called.
StandardException
- Standard Derby error policyPage getFirstPage() throws StandardException
Note that once this method returns this page may no longer be the
first page of the container. I.e, other threads may allocate pages
prior to this page number while this page is latched. It is up to
the caller of this routine to synchronize this call with addPage to
assure that this is the first page.
As long as the client provide the necessary lock to ensure
that no addPage is called, then this page is guaranteed to be the
first page of the container in some internally defined ordering of
the pages.
StandardException
- Standard Derby error policygetPage(long)
Page getNextPage(long prevNum) throws StandardException
Note that once this method returns this page may no longer be the
next page of the container. I.e, other threads may allocate pages
prior to this page number while this page is latched. It is up to
the caller of this routine to synchronize this call with addPage to
assure that this is the first page.
As long as the client provide the necessary lock to ensure
that no addPage is called, then this page is guaranteed to be the
next page of the container in some internally defined ordering of
the pages.
If no pages are added or removed, then an iteration such as:
for (Page p = containerHandle.getFirstPage(); p != null; p = containerHandle.getNextPage(p.getPageNumber()))will guarentee to iterate thru and latched all the valid pages in the container
prevNum
- the pagenumber of the page previous to the page
that is to be gotten. The page which correspond to prevNum
may or may not be latched by the caller, but it must be gotten
via a page which was (or currently still is) latched, and the page
number must be gotten while the container must not have been closed
or dropped or removed in the interim.
In other words, if the user manufactures a page number, or remembers
the page number from a previous session or a previous openContainer,
then the behavior of this routine is undefined.StandardException
- Standard Derby error policygetPage(long)
Page getPageForInsert(int flag) throws StandardException
flag
- a GET_PAGE_* flag.StandardException
- Standard Derby error policyPage getPageForCompress(int flag, long pageno) throws StandardException
StandardException
void getContainerProperties(java.util.Properties prop) throws StandardException
Request the value of properties that are associated with a table. The following properties can be requested: derby.storage.pageSize derby.storage.pageReservedSpace derby.storage.minimumRecordSize
To get the value of a particular property add it to the property list, and on return the value of the property will be set to it's current value. For example: get_prop(ConglomerateController cc) { Properties prop = new Properties(); prop.put("derby.storage.pageSize", ""); cc.getTableProperties(prop); System.out.println( "table's page size = " + prop.getProperty("derby.storage.pageSize"); }
prop
- Property list to fill in.StandardException
- Standard exception policy.void close()
ref.close(); ref = null;
Page.unlatch()
long getEstimatedRowCount(int flag) throws StandardException
flag
- different flavors of row count (reserved for future use)StandardException
- Standard Derby error policyvoid setEstimatedRowCount(long count, int flag) throws StandardException
count
- the estimated number of rows in the container.flag
- different flavors of row count (reserved for future use)StandardException
- Standard Derby error policylong getEstimatedPageCount(int flag) throws StandardException
flag
- different flavors of page count (reserved for future use)StandardException
- Standard Derby error policyvoid flushContainer() throws StandardException
StandardException
- Standard Derby error policyLockingPolicy getLockingPolicy()
void setLockingPolicy(LockingPolicy newLockingPolicy)
RecordHandle makeRecordHandle(long pageNumber, int recordId) throws StandardException
pageNumber
- the page number of the RecordHandle.recordId
- the record id of the RecordHandle.StandardException
- Standard Derby exception policy.RecordHandle
void compactRecord(RecordHandle record) throws StandardException
record
- The record handle, the record must have been locked execlusively already.StandardException
- Standard Derby exception policy.boolean isTemporaryContainer() throws StandardException
StandardException
- Standard Derby exception policy.SpaceInfo getSpaceInfo() throws StandardException
StandardException
void backupContainer(java.lang.String backupContainerPath) throws StandardException
StandardException
- Standard Derby error policyApache Derby V10.13 Internals - Copyright © 2004,2016 The Apache Software Foundation. All Rights Reserved.