JdbcToArrowConfigBuilder (Apache Arrow Java Root POM 13.0.0 API)

java.lang.Object
- org.apache.arrow.adapter.jdbc.JdbcToArrowConfigBuilder

public class JdbcToArrowConfigBuilder
extends Object

This class builds JdbcToArrowConfigs.

Constructor Summary

Constructors
Constructor and Description
`JdbcToArrowConfigBuilder()` Default constructor for the `JdbcToArrowConfigBuilder}`.
`JdbcToArrowConfigBuilder(BufferAllocator allocator, Calendar calendar)` Constructor for the `JdbcToArrowConfigBuilder`.
`JdbcToArrowConfigBuilder(BufferAllocator allocator, Calendar calendar, boolean includeMetadata)` Constructor for the `JdbcToArrowConfigBuilder`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JdbcToArrowConfig`	`build()` This builds the `JdbcToArrowConfig` from the provided `BufferAllocator` and `Calendar`.
`JdbcToArrowConfigBuilder`	`setAllocator(BufferAllocator allocator)` Sets the memory allocator to use when constructing the Arrow vectors from the ResultSet.
`JdbcToArrowConfigBuilder`	`setArraySubTypeByColumnIndexMap(Map<Integer,JdbcFieldInfo> map)` Sets the mapping of column-index-to-`JdbcFieldInfo` used for columns of type `Types.ARRAY`.
`JdbcToArrowConfigBuilder`	`setArraySubTypeByColumnNameMap(Map<String,JdbcFieldInfo> map)` Sets the mapping of column-name-to-`JdbcFieldInfo` used for columns of type `Types.ARRAY`.
`JdbcToArrowConfigBuilder`	`setBigDecimalRoundingMode(RoundingMode bigDecimalRoundingMode)` Set the rounding mode used when the scale of the actual value does not match the declared scale.
`JdbcToArrowConfigBuilder`	`setCalendar(Calendar calendar)` Sets the `Calendar` to use when constructing timestamp fields in the Arrow schema, and reading time-based fields from the JDBC `ResultSet`.
`JdbcToArrowConfigBuilder`	`setColumnMetadataByColumnIndex(Map<Integer,Map<String,String>> columnMetadataByColumnIndex)` Set metadata from columnIndex->meta map on per field basis.
`JdbcToArrowConfigBuilder`	`setExplicitTypesByColumnIndex(Map<Integer,JdbcFieldInfo> map)` Sets the mapping of column-index-to-`JdbcFieldInfo` used for column types.
`JdbcToArrowConfigBuilder`	`setExplicitTypesByColumnName(Map<String,JdbcFieldInfo> map)` Sets the mapping of column-name-to-`JdbcFieldInfo` used for column types.
`JdbcToArrowConfigBuilder`	`setIncludeMetadata(boolean includeMetadata)` Sets whether to include JDBC ResultSet field metadata in the Arrow Schema field metadata.
`JdbcToArrowConfigBuilder`	`setJdbcToArrowTypeConverter(Function<JdbcFieldInfo,ArrowType> jdbcToArrowTypeConverter)` Set the function used to convert JDBC types to Arrow types.
`JdbcToArrowConfigBuilder`	`setReuseVectorSchemaRoot(boolean reuseVectorSchemaRoot)` Set whether to use the same `VectorSchemaRoot` instance on each iteration, or to allocate a new one.
`JdbcToArrowConfigBuilder`	`setSchemaMetadata(Map<String,String> schemaMetadata)` Set metadata for schema.
`JdbcToArrowConfigBuilder`	`setTargetBatchSize(int targetBatchSize)` Set the target number of rows to convert at once.

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

- Constructor Detail
  - JdbcToArrowConfigBuilder
```
public JdbcToArrowConfigBuilder()
```
    Default constructor for the JdbcToArrowConfigBuilder}. Use the setter methods for the allocator and calendar; the allocator must be set. Otherwise, build() will throw a NullPointerException.
  - JdbcToArrowConfigBuilder
```
public JdbcToArrowConfigBuilder(BufferAllocator allocator,
                                Calendar calendar)
```
    Constructor for the JdbcToArrowConfigBuilder. The allocator is required, and a NullPointerException will be thrown if it is null.
    The allocator is used to construct Arrow vectors from the JDBC ResultSet. The calendar is used to determine the time zone of Timestamp fields and convert Date, Time, and Timestamp fields to a single, common time zone when reading from the result set.
    
    Parameters:
    
    allocator - The Arrow Vector memory allocator.
    
    calendar - The calendar to use when constructing timestamp fields.
  - JdbcToArrowConfigBuilder
```
public JdbcToArrowConfigBuilder(BufferAllocator allocator,
                                Calendar calendar,
                                boolean includeMetadata)
```
    Constructor for the JdbcToArrowConfigBuilder. Both the allocator and calendar are required. A NullPointerException will be thrown if either of those arguments is null.
    The allocator is used to construct Arrow vectors from the JDBC ResultSet. The calendar is used to determine the time zone of Timestamp fields and convert Date, Time, and Timestamp fields to a single, common time zone when reading from the result set.
    
    The includeMetadata argument, if true will cause various information about each database field to be added to the Vector Schema's field metadata.
    
    Parameters:
    
    allocator - The Arrow Vector memory allocator.
    
    calendar - The calendar to use when constructing timestamp fields.
- Method Detail
  - setAllocator
```
public JdbcToArrowConfigBuilder setAllocator(BufferAllocator allocator)
```
    Sets the memory allocator to use when constructing the Arrow vectors from the ResultSet.
    
    Parameters:
    
    allocator - the allocator to set.
    
    Throws:
    
    NullPointerException - if allocator is null.
  - setCalendar
```
public JdbcToArrowConfigBuilder setCalendar(Calendar calendar)
```
    Sets the Calendar to use when constructing timestamp fields in the Arrow schema, and reading time-based fields from the JDBC ResultSet.
    
    Parameters:
    
    calendar - the calendar to set.
  - setIncludeMetadata
```
public JdbcToArrowConfigBuilder setIncludeMetadata(boolean includeMetadata)
```
    Sets whether to include JDBC ResultSet field metadata in the Arrow Schema field metadata.
    
    Parameters:
    
    includeMetadata - Whether to include or exclude JDBC metadata in the Arrow Schema field metadata.
    
    Returns:
    
    This instance of the JdbcToArrowConfig, for chaining.
  - setArraySubTypeByColumnIndexMap
```
public JdbcToArrowConfigBuilder setArraySubTypeByColumnIndexMap(Map<Integer,JdbcFieldInfo> map)
```
    Sets the mapping of column-index-to-JdbcFieldInfo used for columns of type Types.ARRAY. The column index is 1-based, to match the JDBC column index.
    
    Parameters:
    
    map - The mapping.
    
    Returns:
    
    This instance of the JdbcToArrowConfig, for chaining.
  - setArraySubTypeByColumnNameMap
```
public JdbcToArrowConfigBuilder setArraySubTypeByColumnNameMap(Map<String,JdbcFieldInfo> map)
```
    Sets the mapping of column-name-to-JdbcFieldInfo used for columns of type Types.ARRAY.
    
    Parameters:
    
    map - The mapping.
    
    Returns:
    
    This instance of the JdbcToArrowConfig, for chaining.
  - setExplicitTypesByColumnIndex
```
public JdbcToArrowConfigBuilder setExplicitTypesByColumnIndex(Map<Integer,JdbcFieldInfo> map)
```
    Sets the mapping of column-index-to-JdbcFieldInfo used for column types.
    This can be useful to override type information from JDBC drivers that provide incomplete type info, e.g. DECIMAL with precision = scale = 0.
    The column index is 1-based, to match the JDBC column index.
    
    Parameters:
    
    map - The mapping.
  - setExplicitTypesByColumnName
```
public JdbcToArrowConfigBuilder setExplicitTypesByColumnName(Map<String,JdbcFieldInfo> map)
```
    Sets the mapping of column-name-to-JdbcFieldInfo used for column types.
    This can be useful to override type information from JDBC drivers that provide incomplete type info, e.g. DECIMAL with precision = scale = 0.
    
    Parameters:
    
    map - The mapping.
  - setTargetBatchSize
```
public JdbcToArrowConfigBuilder setTargetBatchSize(int targetBatchSize)
```
    Set the target number of rows to convert at once.
    Use JdbcToArrowConfig.NO_LIMIT_BATCH_SIZE to read all rows at once.
  - setJdbcToArrowTypeConverter
```
public JdbcToArrowConfigBuilder setJdbcToArrowTypeConverter(Function<JdbcFieldInfo,ArrowType> jdbcToArrowTypeConverter)
```
    Set the function used to convert JDBC types to Arrow types.
    Defaults to wrapping JdbcToArrowUtils.getArrowTypeFromJdbcType(JdbcFieldInfo, Calendar).
  - setReuseVectorSchemaRoot
```
public JdbcToArrowConfigBuilder setReuseVectorSchemaRoot(boolean reuseVectorSchemaRoot)
```
    Set whether to use the same VectorSchemaRoot instance on each iteration, or to allocate a new one.
  - setSchemaMetadata
```
public JdbcToArrowConfigBuilder setSchemaMetadata(Map<String,String> schemaMetadata)
```
    Set metadata for schema.
  - setColumnMetadataByColumnIndex
```
public JdbcToArrowConfigBuilder setColumnMetadataByColumnIndex(Map<Integer,Map<String,String>> columnMetadataByColumnIndex)
```
    Set metadata from columnIndex->meta map on per field basis.
  - setBigDecimalRoundingMode
```
public JdbcToArrowConfigBuilder setBigDecimalRoundingMode(RoundingMode bigDecimalRoundingMode)
```
    Set the rounding mode used when the scale of the actual value does not match the declared scale.
    By default, an error is raised in such cases.
  - build
```
public JdbcToArrowConfig build()
```
    This builds the JdbcToArrowConfig from the provided BufferAllocator and Calendar.
    
    Returns:
    
    The built JdbcToArrowConfig
    
    Throws:
    
    NullPointerException - if either the allocator or calendar was not set.

Class JdbcToArrowConfigBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JdbcToArrowConfigBuilder

JdbcToArrowConfigBuilder

JdbcToArrowConfigBuilder

Method Detail

setAllocator

setCalendar

setIncludeMetadata

setArraySubTypeByColumnIndexMap

setArraySubTypeByColumnNameMap

setExplicitTypesByColumnIndex

setExplicitTypesByColumnName

setTargetBatchSize

setJdbcToArrowTypeConverter

setReuseVectorSchemaRoot

setSchemaMetadata

setColumnMetadataByColumnIndex

setBigDecimalRoundingMode

build