primaryImplementationType
- Specified by:
primaryImplementationType
in interfaceMethodFactory
- See Also:
ModuleControl
, ModuleSupportable
, ConglomerateFactory
, MethodFactory
private UUID
private static final String
private static final String
BTREE_FACTORY_ID, HEAP_FACTORY_ID
MODULE
void
boot(boolean create,
Properties startParams)
boolean
canSupport(Properties startParams)
createConglomerate(TransactionManager xact_mgr,
int segment,
long input_containerid,
DataValueDescriptor[] template,
ColumnOrdering[] columnOrder,
int[] collationIds,
Properties properties,
int temporaryFlag)
int
private static ModuleFactory
void
insertUndoNotify(AccessFactory access_factory,
Transaction xact,
PageKey page_key)
readConglomerate(TransactionManager xact_mgr,
ContainerKey container_key)
void
stop()
boolean
supportsFormat(UUID formatid)
boolean
supportsImplementation(String implementationId)
defaultProperties
in interface MethodFactory
supportsImplementation
in interface MethodFactory
primaryImplementationType
in interface MethodFactory
supportsFormat
in interface MethodFactory
primaryFormat
in interface MethodFactory
Return a number in the range of 0-15 which identifies this factory. Code which names conglomerates depends on this range currently, but could be easily changed to handle larger ranges. One hex digit seemed reasonable for the number of conglomerate types being currently considered (heap, btree, gist, gist btree, gist rtree, hash, others? ).
getConglomerateFactoryId
in interface ConglomerateFactory
createConglomerate
in interface ConglomerateFactory
xact_mgr
- transaction to perform the create in.segment
- segment to create the conglomerate in.input_containerid
- containerid to assign the container, or
ContainerHandle.DEFAULT_ASSIGN_ID if you want
raw store to assign an id.template
- Template of row in the conglomerate.columnOrder
- columns sort order for Index creationcollationIds
- collation ids of columns in the conglomerate.properties
- Properties associated with the conglomerate.StandardException
- Standard exception policy.Return the Conglomerate Object. This is implementation specific. Examples of what will be done is using the key to find the file where the conglomerate is located, and then executing implementation specific code to instantiate an object from reading a "special" row from a known location in the file. In the btree case the btree conglomerate is stored as a column in the control row on the root page.
This operation is costly so it is likely an implementation using this will cache the conglomerate row in memory so that subsequent accesses need not perform this operation.
readConglomerate
in interface ConglomerateFactory
xact_mgr
- transaction to perform the create in.container_key
- The unique id of the existing conglomerate.StandardException
- Standard exception policy.Implementer of this class provides interface to be called by the raw store when an undo of an insert is processed. Initial implementation will be by Access layer to queue space reclaiming events if necessary when a rows is logically "deleted" as part of undo of the original insert. This undo can happen a lot for many applications if they generate expected and handled duplicate key errors.
Caller may decide to call or not based on deleted row count of the page, or if overflow rows/columns are present.
insertUndoNotify
in interface ConglomerateFactory
access_factory
- current access_factory of the aborted insert.xact
- transaction that is being backed out.page_key
- page key of the aborted insert.StandardException
- Standard exception policy.ModuleSupportable
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
canSupport
in interface ModuleSupportable
ModuleControl
An implementation's boot method can throw StandardException. If it is thrown the module is not registered by the monitor and therefore cannot be found through a findModule(). In this case the module's stop() method is not called, thus throwing this exception must free up any resources.
When create is true the contents of the properties object
will be written to the service.properties of the persistent
service. Thus any code that requires an entry in service.properties
must explicitly place the value in this properties set
using the put method.
Typically the properties object contains one or more default
properties sets, which are not written out to service.properties.
These default sets are how callers modify the create process. In a
JDBC connection database create the first set of defaults is a properties
object that contains the attributes that were set on the jdbc:derby: URL.
This attributes properties set has the second default properties set as
its default. This set (which could be null) contains the properties
that the user set on their DriverManager.getConnection() call, and are thus
not owned by Derby code, and thus must not be modified by Derby
code.
When create is false the properties object contains all the properties set in the service.properties file plus a limited number of attributes from the JDBC URL attributes or connection properties set. This avoids properties set by the user compromising the boot process. An example of a property passed in from the JDBC world is the bootPassword for encrypted databases.
Code should not hold onto the passed in properties reference after boot time as its contents may change underneath it. At least after the complete boot is completed, the links to all the default sets will be removed.
boot
in interface ModuleControl
StandardException
- Module cannot be started.ModuleControl
stop
in interface ModuleControl