org.apache.derby.iapi.store.access
Interface ConglomPropertyQueryable

All Known Subinterfaces:
ConglomerateController
All Known Implementing Classes:
B2IController, BTreeController, GenericConglomerateController, HeapController

public interface ConglomPropertyQueryable

ConglomPropertyable provides the interfaces to read properties from a conglomerate.

RESOLVE - If language ever wants these interfaces on a ScanController it should not be too difficult to add them.

See Also:
ConglomerateController

Method Summary
 java.util.Properties getInternalTablePropertySet(java.util.Properties prop)
          Request set of properties associated with a table.
 void getTableProperties(java.util.Properties prop)
          Request the system properties associated with a table.
 

Method Detail

getTableProperties

void getTableProperties(java.util.Properties prop)
                        throws StandardException
Request the system properties associated with a table.

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 derby.storage.initialPages

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"); }

Parameters:
prop - Property list to fill in.
Throws:
StandardException - Standard exception policy.

getInternalTablePropertySet

java.util.Properties getInternalTablePropertySet(java.util.Properties prop)
                                                 throws StandardException
Request set of properties associated with a table.

Returns a property object containing all properties that the store knows about, which are stored persistently by the store. This set of properties may vary from implementation to implementation of the store.

This call is meant to be used only for internal query of the properties by jbms, for instance by language during bulk insert so that it can create a new conglomerate which exactly matches the properties that the original container was created with. This call should not be used by the user interface to present properties to users as it may contain properties that are meant to be internal to jbms. Some properties are meant only to be specified by jbms code and not by users on the command line.

Note that not all properties passed into createConglomerate() are stored persistently, and that set may vary by store implementation.

Parameters:
prop - Property list to add properties to. If null, routine will create a new Properties object, fill it in and return it.
Throws:
StandardException - Standard exception policy.

Built on Thu 2012-03-29 21:53:33+0000, from revision ???

Apache Derby V10.6 Internals - Copyright © 2004,2007 The Apache Software Foundation. All Rights Reserved.