com.ibm.db.models.db2.luw
Interface LUWBufferPool

All Superinterfaces:
commonj.sdo.DataObject, org.eclipse.emf.ecore.sdo.EDataObject, org.eclipse.emf.ecore.EModelElement, org.eclipse.emf.ecore.ENamedElement, org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier, java.io.Serializable, org.eclipse.wst.rdb.internal.models.sql.schema.SQLObject
All Known Implementing Classes:
LUWBufferPoolImpl

public interface LUWBufferPool
extends org.eclipse.wst.rdb.internal.models.sql.schema.SQLObject

A representation of the model object 'Buffer Pool'. DB2 Universal Database SQL Reference Version 8.1 (Vol.1 and 2) http://www7b.software.ibm.com/dmdd/library/techarticle/0206sqlref/0206sqlref.html Table spaces and other storage structures Storage structures contain database objects. The basic storage structure is the table space; it contains tables, indexes, large objects, and data defined with a LONG data type. There are two types of table spaces: - Database managed space (DMS): a table space that is managed by the database manager. - System managed space (SMS): a table space that is managed by the operating system. All table spaces consist of containers. A container describes where objects are stored. A subdirectory in a file system is an example of a container. When data is read from table space containers, it is placed in an area of memory called a buffer pool. A buffer pool is associated with a specific table space, thereby allowing control over which data will share the same memory areas for data buffering. NUMBLOCKPAGES number-of-pages: Specifies the number of pages that should exist in the block-based area. The number of pages must not be greater than 98 percent of the number of pages for the buffer pool (SQLSTATE 54052). Specifying the value 0 disables block I/O. The actual value of NUMBLOCKPAGES used will be a multiple of BLOCKSIZE. BLOCKSIZE number-of-pages: Specifies the number of pages in a block. The block size must be a value between 2 and 256 (SQLSTATE 54053). The default value is 32. PAGESIZE integer [K]: Defines the size of pages used for the bufferpool. The valid values for integer without the suffix K are 4 096, 8 192, 16 384 or 32 768. The valid values for integer with the suffix K are 4, 8, 16 or 32. An error occurs if the page size is not one of these values (SQLSTATE 428DE). The default is 4 096 byte (4K) pages. Any number of spaces is allowed between integer and K, including no space. EXTENDED STORAGE If extended storage is enabled, pages that are being evicted from this buffer pool will be cached in extended storage. (Extended storage is enabled by setting the database configuration parameters NUM_ESTORE_SEGS and ESTORE_SEG_SIZE to non-zero values.) NOT EXTENDED STORAGE Even if extended storage is enabled, pages that are being evicted from this buffer pool are not cached in extended storage. Notes: Compatibilities: for compatibility with previous versions of DB2: - NODE can be specified in place of DBPARTITIONNUM - NODES can be specified in place of DBPARTITIONNUMS - NODEGROUP can be specified in place of DATABASE PARTITION GROUP - If the buffer pool is created using the DEFERRED option, any table space created in this buffer pool will use a small system buffer pool of the same page size, until next database activation. The database has to be restarted for the buffer pool to become active and for table space assignments to the new buffer pool to take effect. The default option is IMMEDIATE. - A buffer pool cannot be created with both extended storage and block-based support. - There should be enough real memory on the machine for the total of all the buffer pools, as well as for the rest of the database manager and application requirements. If DB2 is unable to obtain memory for the regular buffer pools, it will attempt to start up with small system buffer pools, one for each page size (4K, 8K, 16K and 32K). In this situation, a warning will be returned to the user (SQLSTATE 01626), and the pages from all table spaces will use the system buffer pools.

The following features are supported:

See Also:
LUWPackage.getLUWBufferPool()

Method Summary
 int getBlockSize()
          Returns the value of the 'Block Size' attribute.
 BufferPoolType getCreateType()
          Returns the value of the 'Create Type' attribute.
 LUWDatabase getDatabase()
          Returns the value of the 'Database' reference.
 int getNumBlockPages()
          Returns the value of the 'Num Block Pages' attribute.
 PageSizeType getPageSize()
          Returns the value of the 'Page Size' attribute.
 org.eclipse.emf.common.util.EList getPartitionGroup()
          Returns the value of the 'Partition Group' reference list.
 org.eclipse.emf.common.util.EList getPartitions()
          Returns the value of the 'Partitions' reference list.
 int getSize()
          Returns the value of the 'Size' attribute.
 org.eclipse.emf.common.util.EList getTableSpaces()
          Returns the value of the 'Table Spaces' reference list.
 boolean isAutomatic()
          Returns the value of the 'Automatic' attribute.
 boolean isExtendedStorage()
          Returns the value of the 'Extended Storage' attribute.
 void setAutomatic(boolean value)
          Sets the value of the 'Automatic' attribute.
 void setBlockSize(int value)
          Sets the value of the 'Block Size' attribute.
 void setCreateType(BufferPoolType value)
          Sets the value of the 'Create Type' attribute.
 void setDatabase(LUWDatabase value)
          Sets the value of the 'Database' reference.
 void setExtendedStorage(boolean value)
          Sets the value of the 'Extended Storage' attribute.
 void setNumBlockPages(int value)
          Sets the value of the 'Num Block Pages' attribute.
 void setPageSize(PageSizeType value)
          Sets the value of the 'Page Size' attribute.
 void setSize(int value)
          Sets the value of the 'Size' attribute.
 
Methods inherited from interface org.eclipse.wst.rdb.internal.models.sql.schema.SQLObject
addEAnnotation, addEAnnotationDetail, getComments, getDependencies, getDescription, getEAnnotation, getEAnnotationDetail, getLabel, getPrivileges, removeEAnnotationDetail, setAnnotationDetail, setDescription, setLabel
 
Methods inherited from interface org.eclipse.emf.ecore.sdo.EDataObject
getInstanceProperties
 
Methods inherited from interface commonj.sdo.DataObject
createDataObject, createDataObject, createDataObject, createDataObject, createDataObject, createDataObject, delete, get, get, get, getBigDecimal, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getBytes, getBytes, getBytes, getChar, getChar, getChar, getContainer, getContainmentProperty, getDataGraph, getDataObject, getDataObject, getDataObject, getDate, getDate, getDate, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInt, getInt, getInt, getList, getList, getList, getLong, getLong, getLong, getSequence, getSequence, getSequence, getShort, getShort, getShort, getString, getString, getString, getType, isSet, isSet, isSet, set, set, set, setBigDecimal, setBigDecimal, setBigDecimal, setBigInteger, setBigInteger, setBigInteger, setBoolean, setBoolean, setBoolean, setByte, setByte, setByte, setBytes, setBytes, setBytes, setChar, setChar, setChar, setDataObject, setDataObject, setDataObject, setDate, setDate, setDate, setDouble, setDouble, setDouble, setFloat, setFloat, setFloat, setInt, setInt, setInt, setList, setList, setList, setLong, setLong, setLong, setShort, setShort, setShort, setString, setString, setString, unset, unset, unset
 
Methods inherited from interface org.eclipse.emf.ecore.ENamedElement
getName, setName
 
Methods inherited from interface org.eclipse.emf.ecore.EModelElement
getEAnnotations
 

Method Detail

getCreateType

BufferPoolType getCreateType()
Returns the value of the 'Create Type' attribute. The literals are from the enumeration BufferPoolType.

If the meaning of the 'Create Type' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Create Type' attribute.
See Also:
BufferPoolType, setCreateType(BufferPoolType), LUWPackage.getLUWBufferPool_CreateType()

setCreateType

void setCreateType(BufferPoolType value)
Sets the value of the 'Create Type' attribute.

Parameters:
value - the new value of the 'Create Type' attribute.
See Also:
BufferPoolType, getCreateType()

getSize

int getSize()
Returns the value of the 'Size' attribute.

If the meaning of the 'Size' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Size' attribute.
See Also:
setSize(int), LUWPackage.getLUWBufferPool_Size()

setSize

void setSize(int value)
Sets the value of the 'Size' attribute.

Parameters:
value - the new value of the 'Size' attribute.
See Also:
getSize()

getPageSize

PageSizeType getPageSize()
Returns the value of the 'Page Size' attribute. The default value is "FOUR_K". The literals are from the enumeration PageSizeType.

If the meaning of the 'Page Size' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Page Size' attribute.
See Also:
PageSizeType, setPageSize(PageSizeType), LUWPackage.getLUWBufferPool_PageSize()

setPageSize

void setPageSize(PageSizeType value)
Sets the value of the 'Page Size' attribute.

Parameters:
value - the new value of the 'Page Size' attribute.
See Also:
PageSizeType, getPageSize()

getBlockSize

int getBlockSize()
Returns the value of the 'Block Size' attribute. The default value is "32".

If the meaning of the 'Block Size' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Block Size' attribute.
See Also:
setBlockSize(int), LUWPackage.getLUWBufferPool_BlockSize()

setBlockSize

void setBlockSize(int value)
Sets the value of the 'Block Size' attribute.

Parameters:
value - the new value of the 'Block Size' attribute.
See Also:
getBlockSize()

getNumBlockPages

int getNumBlockPages()
Returns the value of the 'Num Block Pages' attribute.

If the meaning of the 'Num Block Pages' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Num Block Pages' attribute.
See Also:
setNumBlockPages(int), LUWPackage.getLUWBufferPool_NumBlockPages()

setNumBlockPages

void setNumBlockPages(int value)
Sets the value of the 'Num Block Pages' attribute.

Parameters:
value - the new value of the 'Num Block Pages' attribute.
See Also:
getNumBlockPages()

isExtendedStorage

boolean isExtendedStorage()
Returns the value of the 'Extended Storage' attribute.

If the meaning of the 'Extended Storage' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Extended Storage' attribute.
See Also:
setExtendedStorage(boolean), LUWPackage.getLUWBufferPool_ExtendedStorage()

setExtendedStorage

void setExtendedStorage(boolean value)
Sets the value of the 'Extended Storage' attribute.

Parameters:
value - the new value of the 'Extended Storage' attribute.
See Also:
isExtendedStorage()

isAutomatic

boolean isAutomatic()
Returns the value of the 'Automatic' attribute. The default value is "true".

If the meaning of the 'Automatic' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Automatic' attribute.
See Also:
setAutomatic(boolean), LUWPackage.getLUWBufferPool_Automatic()

setAutomatic

void setAutomatic(boolean value)
Sets the value of the 'Automatic' attribute.

Parameters:
value - the new value of the 'Automatic' attribute.
See Also:
isAutomatic()

getTableSpaces

org.eclipse.emf.common.util.EList getTableSpaces()
Returns the value of the 'Table Spaces' reference list. The list contents are of type LUWTableSpace. It is bidirectional and its opposite is 'Buffer Pool'.

If the meaning of the 'Table Spaces' reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Table Spaces' reference list.
See Also:
LUWPackage.getLUWBufferPool_TableSpaces(), LUWTableSpace.getBufferPool()

getPartitions

org.eclipse.emf.common.util.EList getPartitions()
Returns the value of the 'Partitions' reference list. The list contents are of type LUWDatabasePartition. It is bidirectional and its opposite is 'Buffer Pool'.

If the meaning of the 'Partitions' reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Partitions' reference list.
See Also:
LUWPackage.getLUWBufferPool_Partitions(), LUWDatabasePartition.getBufferPool()

getPartitionGroup

org.eclipse.emf.common.util.EList getPartitionGroup()
Returns the value of the 'Partition Group' reference list. The list contents are of type LUWPartitionGroup. It is bidirectional and its opposite is 'Buffer Pool'.

If the meaning of the 'Partition Group' reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Partition Group' reference list.
See Also:
LUWPackage.getLUWBufferPool_PartitionGroup(), LUWPartitionGroup.getBufferPool()

getDatabase

LUWDatabase getDatabase()
Returns the value of the 'Database' reference. It is bidirectional and its opposite is 'Bufferpools'.

If the meaning of the 'Database' reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Database' reference.
See Also:
setDatabase(LUWDatabase), LUWPackage.getLUWBufferPool_Database(), LUWDatabase.getBufferpools()

setDatabase

void setDatabase(LUWDatabase value)
Sets the value of the 'Database' reference.

Parameters:
value - the new value of the 'Database' reference.
See Also:
getDatabase()