Package org.apache.derby.iapi.store.raw
Interface StreamContainerHandle
- All Known Implementing Classes:
StreamFileContainerHandle
public interface StreamContainerHandle
A Stream Container handle
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Close me.boolean
fetchNext
(DataValueDescriptor[] row) Fetch the next record.void
Request the system properties associated with a container.getId()
Return my identifier.void
remove the stream container
-
Field Details
-
TEMPORARY_SEGMENT
static final int TEMPORARY_SEGMENT- See Also:
-
-
Method Details
-
getId
ContainerKey getId()Return my identifier. -
getContainerProperties
Request the system properties associated with a container.Request the value of properties that are associated with a stream table. The following properties can be requested: derby.storage.streamFileBufferSize
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.streamFileBufferSize", ""); cc.getTableProperties(prop); System.out.println( "table's buffer size = " + prop.getProperty("derby.storage.streamFileBufferSize"); }
- Parameters:
prop
- Property list to fill in.- Throws:
StandardException
- Standard exception policy.
-
fetchNext
Fetch the next record. Fills in the Storable columns within the passed in row if row is not null, otherwise the record is not fetched. If the row.length is less than the number of fields in the row, then, will fill the row, and ignore the rest of the row.
When no more row is found, then false is returned.Locking Policy
No locks.- Parameters:
row
- Row to be filled in with information from the record.- Throws:
StandardException
- Standard Derby error policy
-
close
void close()Close me. After using this method the caller must throw away the reference to the Container object, e.g.ref.close(); ref = null;
The container will be closed automatically at the commit or abort of the transaction if this method is not called explictly. -
removeContainer
remove the stream container- Throws:
StandardException
- Standard Derby error policy
-