RowBlockProperties Class Reference

This class represents the properties that holds constant across all blocks held by one SwapManager instance. More...

List of all members.

Public Member Functions

RowBlockPropertiesoperator= (const RowBlockProperties &in_rhs)
 Assignment operator.
 RowBlockProperties (const RowBlockProperties &in_other)
 Copy Constructor.
 RowBlockProperties (Simba::DSI::IColumns *in_columns, Simba::DSI::IColumn *in_bmCol, const simba_uint32 in_maxCachedLOBSize, const simba_uint64 in_maxBlockSize, bool in_shouldCompress)
 Constructor.
 ~RowBlockProperties ()
 Destructor.

Static Public Member Functions

static simba_uint32 GetMaxColumnWidth (Simba::DSI::IColumn *in_column, const simba_uint32 in_maxCachedLOBSize)
 Get the maximum size of the input column in bytes. This method considers the input long data maximum.

Public Attributes

simba_uint16 m_bookmarkColNum
 The bookmark column number. Only valid if m_hasBookmarkColumn is true.
std::vector< ColumnPropertiesm_colProperties
 Properties of all the columns, including the bookmark column if it is present.
simba_uint16 m_columnCount
 The number of columns in the row block.
bool m_hasBookmarkColumn
 Flag to indicate if there is a bookmark column.
simba_uint64 m_maxBlockSize
 The maximum block size in bytes.
simba_uint64 m_maxRowSize
 The maximum size in bytes that a row can be. If the data is not compressed, this number includes all padding and indicator bytes. If the data is compressed it is The sum of the max size of each column (no padding is necessary).
simba_uint64 m_memManagerBlockSize
 The block size to report to the memory manager. Should be m_maxBlockSize + any additional memory that can be used by classes related to the RowBlock.
AutoPtr< IColumnsm_metadata
 The metadata for the row blocks. (OWN).
simba_uint32 m_nonComprRowsPerBlock
 The number of rows that each block will have. Only used when the data is not compressed because in this case blocks have a fixed number of rows.
bool m_useCompression
 Flag to indicate if the RowBlock should use compression.

Detailed Description

This class represents the properties that holds constant across all blocks held by one SwapManager instance.


Constructor & Destructor Documentation

RowBlockProperties ( Simba::DSI::IColumns in_columns,
Simba::DSI::IColumn in_bmCol,
const simba_uint32  in_maxCachedLOBSize,
const simba_uint64  in_maxBlockSize,
bool  in_shouldCompress 
)

Constructor.

Parameters:
in_columns The columns of a row. Cannot be NULL. (NOT OWN)
in_bmCol Optional bookmark column (NOT OWN).
in_maxCachedLOBSize The maximum length in bytes for Large Object (LOB).
in_maxBlockSize The suggested RowBlock size as seen in SwapManager.
in_shouldCompress If row blocks should use compression.
RowBlockProperties ( const RowBlockProperties in_other  ) 

Copy Constructor.

Parameters:
in_other The other to copy.

Destructor.


Member Function Documentation

static simba_uint32 GetMaxColumnWidth ( Simba::DSI::IColumn in_column,
const simba_uint32  in_maxCachedLOBSize 
) [static]

Get the maximum size of the input column in bytes. This method considers the input long data maximum.

Parameters:
in_column A column. (NOT OWN) Cannot be NULL.
in_maxCachedLOBSize The maximum length for Large Object (LOB).
in_wideCodeUnitSize The size in bytes of wide character.
RowBlockProperties& operator= ( const RowBlockProperties in_rhs  ) 

Assignment operator.

Parameters:
in_rhs The other to copy.

Member Data Documentation

simba_uint16 m_bookmarkColNum

The bookmark column number. Only valid if m_hasBookmarkColumn is true.

Properties of all the columns, including the bookmark column if it is present.

simba_uint16 m_columnCount

The number of columns in the row block.

Flag to indicate if there is a bookmark column.

simba_uint64 m_maxBlockSize

The maximum block size in bytes.

simba_uint64 m_maxRowSize

The maximum size in bytes that a row can be. If the data is not compressed, this number includes all padding and indicator bytes. If the data is compressed it is The sum of the max size of each column (no padding is necessary).

simba_uint64 m_memManagerBlockSize

The block size to report to the memory manager. Should be m_maxBlockSize + any additional memory that can be used by classes related to the RowBlock.

The metadata for the row blocks. (OWN).

simba_uint32 m_nonComprRowsPerBlock

The number of rows that each block will have. Only used when the data is not compressed because in this case blocks have a fixed number of rows.

Flag to indicate if the RowBlock should use compression.


The documentation for this class was generated from the following file:

Generated on Wed May 17 14:21:16 2017 for SimbaEngine 10.1.3.1011 by simba