Documentation of 'org.apache.derby.impl.store.access.heap.HeapController' Java class
HeapController
Skip navigation links
org.apache.derby.impl.store.access.heap

Class HeapController

    • Constructor Detail

      • HeapController

        public HeapController()

    • Method Detail

      • insert

        public int insert(DataValueDescriptor[] row)
           throws StandardException
        Public Methods of This class:
        Specified by:
        insert in interface ConglomerateController
        Parameters:
        row - The row to insert into the conglomerate. The stored representations of the row's columns are copied into a new row somewhere in the conglomerate.
        Returns:
        Returns 0 if insert succeeded. Returns ConglomerateController.ROWISDUPLICATE if conglomerate supports uniqueness checks and has been created to disallow duplicates, and the row inserted had key columns which were duplicate of a row already in the table. Other insert failures will raise StandardException's.
        Throws:
        StandardException - Standard exception policy.
        See Also:
        RowUtil

      • insertAndFetchLocation

        public void insertAndFetchLocation(DataValueDescriptor[] row,
                                   RowLocation templateRowLocation)
                            throws StandardException
        Description copied from interface: ConglomerateController
        insert row and fetch it's row location in one operation.

        Insert a row into the conglomerate, and store its location in the provided destination row location. The row location must be of the correct type for this conglomerate (a new row location of the correct type can be obtained from newRowLocationTemplate()).

        Specified by:
        insertAndFetchLocation in interface ConglomerateController
        Parameters:
        row - The row to insert into the conglomerate. The stored representations of the row's columns are copied into a new row somewhere in the conglomerate.
        templateRowLocation - The rowlocation to read the inserted row location into.
        Throws:
        StandardException - Standard exception policy.
        See Also:
        RowUtil

      • lockRow

        public boolean lockRow(RowLocation loc,
                       int lock_operation,
                       boolean wait,
                       int lock_duration)
                throws StandardException
        Lock the given row location.

        Should only be called by access.

        This call can be made on a ConglomerateController that was opened for locking only.

        RESOLVE (mikem) - move this call to ConglomerateManager so it is obvious that non-access clients should not call this.

        Specified by:
        lockRow in interface ConglomerateController
        Parameters:
        loc - The "RowLocation" which describes the exact row to lock.
        wait - Should the lock call wait to be granted?
        lock_operation - For what operation are we requesting the lock, this should be one of the following 4 options: LOCK_READ [read lock], (LOCK_INS | LOCK_UPD) [ lock for insert], (LOCK_INSERT_PREVKEY | LOCK_UPD) [lock for previous key to insert], (LOCK_UPD) [lock for delete or replace] (LOCK_UPD | LOCK_UPDATE_LOCKS) [lock scan for update, will upgrade lock later if actual update is take place]
        lock_duration - If set to TransactionManager.LOCK_INSTANT_DURATION, then lock will be released immediately after being granted.
        Returns:
        true if lock was granted, only can be false if wait was false.
        Throws:
        StandardException - Standard exception policy.

      • unlockRowAfterRead

        public void unlockRowAfterRead(RowLocation loc,
                               boolean forUpdate,
                               boolean row_qualified)
                        throws StandardException
        UnLock the given row location.

        Should only be called by access.

        This call can be made on a ConglomerateController that was opened for locking only.

        RESOLVE (mikem) - move this call to ConglomerateManager so it is obvious that non-access clients should not call this.

        Specified by:
        unlockRowAfterRead in interface ConglomerateController
        Parameters:
        loc - The "RowLocation" which describes the row to unlock.
        forUpdate - Row was previously Locked the record for read or update.
        row_qualified - Row was qualified and returned to the user.
        Throws:
        StandardException - Standard exception policy.

      • lockRow

        public boolean lockRow(long page_num,
                       int record_id,
                       int lock_operation,
                       boolean wait,
                       int lock_duration)
                throws StandardException
        Lock the given record id/page num pair.

        Should only be called by access, to lock "special" locks formed from the Recordhandle.* reserved constants for page specific locks.

        This call can be made on a ConglomerateController that was opened for locking only.

        RESOLVE (mikem) - move this call to ConglomerateManager so it is obvious that non-access clients should not call this.

        Specified by:
        lockRow in interface ConglomerateController
        Parameters:
        page_num - Page number of row to lock.
        record_id - Record id of row on page_num to lock.
        lock_operation - Desc of what to lock for, ie. update, insert ...
        wait - Should the lock call wait to be granted?
        lock_duration - If set to TransactionManager.LOCK_INSTANT_DURATION, then lock will be released immediately after being granted.
        Returns:
        true if lock was granted, only can be false if wait was false.
        Throws:
        StandardException - Standard exception policy.

      • getOpenConglomerate

        public OpenConglomerate getOpenConglomerate()
        Public Methods of XXXX class:

      • checkConsistency

        public void checkConsistency()
                      throws StandardException
        Public Methods implementing ConglomerateController which just delegate to OpenConglomerate:
        Throws:
        StandardException

      • isKeyed

        public boolean isKeyed()

      • isTableLocked

        public boolean isTableLocked()
        is the open btree table locked?

      • getEstimatedRowCount

        public long getEstimatedRowCount()
                          throws StandardException
        Get the total estimated number of rows in the container.

        The number is a rough estimate and may be grossly off. In general the server will cache the row count and then occasionally write the count unlogged to a backing store. If the system happens to shutdown before the store gets a chance to update the row count it may wander from reality.

        This call is currently only supported on Heap conglomerates, it will throw an exception if called on btree conglomerates.

        Returns:
        The total estimated number of rows in the conglomerate.
        Throws:
        StandardException - Standard exception policy.

      • setEstimatedRowCount

        public void setEstimatedRowCount(long count)
                          throws StandardException
        Set the total estimated number of rows in the container.

        Often, after a scan, the client of RawStore has a much better estimate of the number of rows in the container than what store has. For instance if we implement some sort of update statistics command, or just after a create index a complete scan will have been done of the table. In this case this interface allows the client to set the estimated row count for the container, and store will use that number for all future references.

        This call is currently only supported on Heap conglomerates, it will throw an exception if called on btree conglomerates.

        Parameters:
        count - the estimated number of rows in the container.
        Throws:
        StandardException - Standard exception policy.
Skip navigation links

DataMelt 3.0 © DataMelt by jWork.ORG

You see the box below because you did not login.