RecordBatchSizer (Drill : 1.20.3 API)

java.lang.Object
- org.apache.drill.exec.record.RecordBatchSizer

```
public class RecordBatchSizer
extends Object
```
Given a record batch or vector container, determines the actual memory consumed by each column, the average row, and the entire record batch.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class RecordBatchSizer.ColumnSize
Column size information.

Nested Classes
Modifier and Type	Class and Description
`class`	`RecordBatchSizer.ColumnSize` Column size information.

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`maxSize` Maximum width of a column; used for memory estimation in case of Varchars
`int`	`nullableCount` Count the nullable columns; used for memory estimation
`SelectionVector2`	`sv2`

Constructor Summary

Constructors
Constructor and Description
`RecordBatchSizer(RecordBatch batch)`
`RecordBatchSizer(VectorAccessible va)` Create empirical metadata for a record batch given a vector accessible (basically, an iterator over the vectors in the batch.)
`RecordBatchSizer(VectorAccessible va, SelectionVector2 sv2)` Create empirical metadata for a record batch given a vector accessible (basically, an iterator over the vectors in the batch) along with a selection vector for those records.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`allocateVectors(VectorContainer container, int recordCount)`
`void`	`applySv2()`
`VectorInitializer`	`buildVectorInitializer()` The column size information gathered here represents empirically-derived schema metadata.
`Map<String,RecordBatchSizer.ColumnSize>`	`columns()`
`List<RecordBatchSizer.ColumnSize>`	`columnsList()` This is a convenience method to get the sizes of columns in the same order that the corresponding value vectors are stored within a `VectorAccessible`.
`long`	`getActualSize()`
`int`	`getAvgDensity()`
`RecordBatchSizer.ColumnSize`	`getColumn(String name)`
`int`	`getGrossRowWidth()`
`int`	`getMaxAvgColumnSize()`
`long`	`getNetBatchSize()`
`int`	`getNetRowWidth()`
`int`	`getNetRowWidthCap50()` Compute the "real" width of the row, taking into account each varchar column size (historically capped at 50, and rounded up to power of 2 to match drill buf allocation) and null marking columns.
`int`	`getRowAllocWidth()`
`static int`	`getStdNetSizePerEntryCommon(TypeProtos.MajorType majorType, boolean isOptional, boolean isRepeated, boolean isRepeatedList, Map<String,RecordBatchSizer.ColumnSize> children)`
`int`	`getStdRowWidth()`
`boolean`	`hasSv2()`
`static long`	`multiplyByFactor(long size, double factor)`
`static long`	`multiplyByFactors(long size, double... factors)`
`int`	`rowCount()`
`static int`	`safeDivide(int num, double denom)`
`static int`	`safeDivide(int num, float denom)`
`static int`	`safeDivide(int num, int denom)`
`static int`	`safeDivide(long num, long denom)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - sv2
```
public SelectionVector2 sv2
```
  - maxSize
```
public int maxSize
```
    Maximum width of a column; used for memory estimation in case of Varchars
  - nullableCount
```
public int nullableCount
```
    Count the nullable columns; used for memory estimation
- Constructor Detail
  - RecordBatchSizer
```
public RecordBatchSizer(RecordBatch batch)
```
  - RecordBatchSizer
```
public RecordBatchSizer(VectorAccessible va)
```
    Create empirical metadata for a record batch given a vector accessible (basically, an iterator over the vectors in the batch.)
    
    Parameters:
    
    va - iterator over the batch's vectors
  - RecordBatchSizer
```
public RecordBatchSizer(VectorAccessible va,
                        SelectionVector2 sv2)
```
    Create empirical metadata for a record batch given a vector accessible (basically, an iterator over the vectors in the batch) along with a selection vector for those records. The selection vector is used to pad the estimated row width with the extra two bytes needed per record. The selection vector memory is added to the total memory consumed by this batch.
    
    Parameters:
    
    va - iterator over the batch's vectors
    
    sv2 - selection vector associated with this batch
- Method Detail
  - multiplyByFactors
```
public static long multiplyByFactors(long size,
                                     double... factors)
```
  - multiplyByFactor
```
public static long multiplyByFactor(long size,
                                    double factor)
```
  - getStdNetSizePerEntryCommon
```
public static int getStdNetSizePerEntryCommon(TypeProtos.MajorType majorType,
                                              boolean isOptional,
                                              boolean isRepeated,
                                              boolean isRepeatedList,
                                              Map<String,RecordBatchSizer.ColumnSize> children)
```
  - getColumn
```
public RecordBatchSizer.ColumnSize getColumn(String name)
```
  - applySv2
```
public void applySv2()
```
  - safeDivide
```
public static int safeDivide(long num,
                             long denom)
```
  - safeDivide
```
public static int safeDivide(int num,
                             int denom)
```
  - safeDivide
```
public static int safeDivide(int num,
                             float denom)
```
  - safeDivide
```
public static int safeDivide(int num,
                             double denom)
```
  - rowCount
```
public int rowCount()
```
  - getStdRowWidth
```
public int getStdRowWidth()
```
  - getRowAllocWidth
```
public int getRowAllocWidth()
```
  - getActualSize
```
public long getActualSize()
```
  - getGrossRowWidth
```
public int getGrossRowWidth()
```
  - getAvgDensity
```
public int getAvgDensity()
```
  - getNetRowWidth
```
public int getNetRowWidth()
```
  - columns
```
public Map<String,RecordBatchSizer.ColumnSize> columns()
```
  - columnsList
```
public List<RecordBatchSizer.ColumnSize> columnsList()
```
    This is a convenience method to get the sizes of columns in the same order that the corresponding value vectors are stored within a VectorAccessible.
    
    Returns:
    
    The sizes of columns in the same order that the corresponding value vectors are stored within a VectorAccessible.
  - getNetRowWidthCap50
```
public int getNetRowWidthCap50()
```
    Compute the "real" width of the row, taking into account each varchar column size (historically capped at 50, and rounded up to power of 2 to match drill buf allocation) and null marking columns.
    
    Returns:
    
    "real" width of the row
  - hasSv2
```
public boolean hasSv2()
```
  - getNetBatchSize
```
public long getNetBatchSize()
```
  - getMaxAvgColumnSize
```
public int getMaxAvgColumnSize()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - buildVectorInitializer
```
public VectorInitializer buildVectorInitializer()
```
    The column size information gathered here represents empirically-derived schema metadata. Use that metadata to create an instance of a class that allocates memory for new vectors based on the observed size information. The caller provides the row count; the size information here provides column widths and the number of elements in each array.
  - allocateVectors
```
public void allocateVectors(VectorContainer container,
                            int recordCount)
```

Class RecordBatchSizer

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sv2

maxSize

nullableCount

Constructor Detail

RecordBatchSizer

RecordBatchSizer

RecordBatchSizer

Method Detail

multiplyByFactors

multiplyByFactor

getStdNetSizePerEntryCommon

getColumn

applySv2

safeDivide

safeDivide

safeDivide

safeDivide

rowCount

getStdRowWidth

getRowAllocWidth

getActualSize

getGrossRowWidth

getAvgDensity

getNetRowWidth

columns

columnsList

getNetRowWidthCap50

hasSv2

getNetBatchSize

getMaxAvgColumnSize

toString

buildVectorInitializer

allocateVectors