Package io.deephaven.importers

Interface JdbcSchemaCreator.Builder

Enclosing class:

JdbcSchemaCreator

public static interface JdbcSchemaCreator.Builder

A Builder object for ImmutableJdbcSchemaCreator

Method Summary

Modifier and Type	Method	Description
JdbcSchemaCreator.Builder	arrayDelimiter(String arrayDelimiter)	The array delimiter to be added to the import source.
JdbcSchemaCreator.Builder	assessmentMethod(JdbcSchemaCreator.AssessmentMethod assessmentMethod)	The {JdbcSchemaCreator.AssessmentMethod to use when inferring the schema.
JdbcSchemaCreator.Builder	bestFit(boolean bestFit)	Whether to try to use smaller types like int and float, or to use bigger types, like long and double.
JdbcSchemaCreator	build()	Build the JdbcSchemaCreator
JdbcSchemaCreator.Builder	casingStyle(CasingStyle casingStyle)	The CasingStyle to use when generating column names.
JdbcSchemaCreator.Builder	connectionUrl(String connectionUrl)	The connection URL.
JdbcSchemaCreator.Builder	groupingColumn(String groupingColumn)	The grouping column for the table.
JdbcSchemaCreator.Builder	importStyle(ImportStyle importStyle)	The ImportStyle.
JdbcSchemaCreator.Builder	jdbcDriver(String jdbcDriver)	The JDBC driver name.
JdbcSchemaCreator.Builder	logFormat(int logFormat)	The log format to use for loggers.
JdbcSchemaCreator.Builder	logger(@NotNull Logger logger)	The Logger.
JdbcSchemaCreator.Builder	maxError(int maxError)	Maximum allowed errors to be added to the schema's ImportSource as a maxError attribute.
JdbcSchemaCreator.Builder	namespace(@NotNull String namespace)	The namespace for the table.
JdbcSchemaCreator.Builder	outPackage(String outPackage)	The package name for loggers and listeners.
JdbcSchemaCreator.Builder	outputMode(SchemaCreatorUtils.OutputMode outputMode)	The SchemaCreatorUtils.OutputMode to use.
JdbcSchemaCreator.Builder	partitionColumn(String partitionColumn)	The partition column for the table.
JdbcSchemaCreator.Builder	password(String password)	The password.
JdbcSchemaCreator.Builder	replacement(String replacement)	String to use for replacements of space or hyphen in source column names.
JdbcSchemaCreator.Builder	resultSet(ResultSet resultSet)	An optional ResultSet instead of JDBC connection details.
JdbcSchemaCreator.Builder	schemaPath(String schemaPath)	The output path for the schema.
JdbcSchemaCreator.Builder	sourceName(String sourceName)	The import source name.
JdbcSchemaCreator.Builder	sourcePartitionColumn(String sourcePartitionColumn)	The column name in the source data to use for multi-partition imports.
JdbcSchemaCreator.Builder	sqlQuery(String sqlQuery)	The SQL query to execute.
JdbcSchemaCreator.Builder	tableName(@NotNull String tableName)	The table name for the table.
JdbcSchemaCreator.Builder	useNanos(boolean useNanos)	Whether to try to use nanos for time calculations.
JdbcSchemaCreator.Builder	user(String user)	The username.

Method Details

logger

JdbcSchemaCreator.Builder logger(@NotNull
 @NotNull Logger logger)

The Logger.

Parameters:

logger - the logger

Returns:

this JdbcSchemaCreator.Builder

namespace

JdbcSchemaCreator.Builder namespace(@NotNull
 @NotNull String namespace)

The namespace for the table. This is added to the schema in the namespace attribute of the Table element.

Parameters:

namespace - the namespace

Returns:

this JdbcSchemaCreator.Builder

tableName

JdbcSchemaCreator.Builder tableName(@NotNull
 @NotNull String tableName)

The table name for the table. This is added to the schema in the name attribute of the Table element.

Parameters:

tableName - the table name

Returns:

this JdbcSchemaCreator.Builder

groupingColumn

JdbcSchemaCreator.Builder groupingColumn(String groupingColumn)

The grouping column for the table. This is added to the schema by adding columnType="Grouping" to the specified column's definition.

Parameters:

groupingColumn - the grouping column

Returns:

this JdbcSchemaCreator.Builder

partitionColumn

JdbcSchemaCreator.Builder partitionColumn(String partitionColumn)

The partition column for the table. This is added to the schema by adding columnType="Partitioning" to the specified column's definition.

Parameters:

partitionColumn - the partitioning column

Returns:

this JdbcSchemaCreator.Builder

sourceName

JdbcSchemaCreator.Builder sourceName(String sourceName)

The import source name. This defines the schema's ImportSource name attribute.

Parameters:

sourceName - the import source name

Returns:

this JdbcSchemaCreator.Builder

jdbcDriver

JdbcSchemaCreator.Builder jdbcDriver(String jdbcDriver)

The JDBC driver name.

Parameters:

jdbcDriver - the JDBC driver name

Returns:

this JdbcSchemaCreator.Builder

connectionUrl

JdbcSchemaCreator.Builder connectionUrl(String connectionUrl)

The connection URL.

Parameters:

connectionUrl - the connection URL

Returns:

this JdbcSchemaCreator.Builder

user

JdbcSchemaCreator.Builder user(String user)

The username. If not provided, then the connectionUrl(java.lang.String) must contain everything needed to connect.

Parameters:

user - the username

Returns:

this JdbcSchemaCreator.Builder

password

JdbcSchemaCreator.Builder password(String password)

The password. If not provided, then the connectionUrl(java.lang.String) must contain everything needed to connect.

Parameters:

password - the password

Returns:

this JdbcSchemaCreator.Builder

sqlQuery

JdbcSchemaCreator.Builder sqlQuery(String sqlQuery)

The SQL query to execute.

Parameters:

sqlQuery - the SQL query to execute

Returns:

this JdbcSchemaCreator.Builder

schemaPath

JdbcSchemaCreator.Builder schemaPath(String schemaPath)

The output path for the schema.

Parameters:

schemaPath - the output path

Returns:

this JdbcSchemaCreator.Builder

assessmentMethod

JdbcSchemaCreator.Builder assessmentMethod(JdbcSchemaCreator.AssessmentMethod assessmentMethod)

The {JdbcSchemaCreator.AssessmentMethod to use when inferring the schema. The default is JdbcSchemaCreator.AssessmentMethod.META_ONLY.

Parameters:

assessmentMethod - the assessment method to use

Returns:

this JdbcSchemaCreator.Builder

sourcePartitionColumn

JdbcSchemaCreator.Builder sourcePartitionColumn(String sourcePartitionColumn)

The column name in the source data to use for multi-partition imports.

Parameters:

sourcePartitionColumn - the column name

Returns:

this JdbcSchemaCreator.Builder

importStyle

JdbcSchemaCreator.Builder importStyle(ImportStyle importStyle)

The ImportStyle. Default is ImportStyle.BATCH.

Parameters:

importStyle - the import style

Returns:

this JdbcSchemaCreator.Builder

outPackage

JdbcSchemaCreator.Builder outPackage(String outPackage)

The package name for loggers and listeners. Required if generating loggers and listeners.

Parameters:

outPackage - the package name

Returns:

this JdbcSchemaCreator.Builder

bestFit

JdbcSchemaCreator.Builder bestFit(boolean bestFit)

Whether to try to use smaller types like int and float, or to use bigger types, like long and double. If true then try to use smaller types. Default is false.

Parameters:

bestFit - if true, use best-fit parsing to determine column types

Returns:

this JdbcSchemaCreator.Builder

casingStyle

JdbcSchemaCreator.Builder casingStyle(CasingStyle casingStyle)

The CasingStyle to use when generating column names. Default is CasingStyle.None.

Parameters:

casingStyle - the casing style

Returns:

this JdbcSchemaCreator.Builder

outputMode

JdbcSchemaCreator.Builder outputMode(SchemaCreatorUtils.OutputMode outputMode)

The SchemaCreatorUtils.OutputMode to use. Default is SchemaCreatorUtils.OutputMode.SAFE.

Parameters:

outputMode - the output mode

Returns:

this JdbcSchemaCreator.Builder

replacement

JdbcSchemaCreator.Builder replacement(String replacement)

String to use for replacements of space or hyphen in source column names. Default is _.

Parameters:

replacement - the replacement String

Returns:

this JdbcSchemaCreator.Builder

arrayDelimiter

JdbcSchemaCreator.Builder arrayDelimiter(String arrayDelimiter)

The array delimiter to be added to the import source. Default is ,.

Parameters:

arrayDelimiter - the array delimiter

Returns:

this JdbcSchemaCreator.Builder

logFormat

JdbcSchemaCreator.Builder logFormat(int logFormat)

The log format to use for loggers. Default is 1.

Parameters:

logFormat - the log format

Returns:

this JdbcSchemaCreator.Builder

maxError

JdbcSchemaCreator.Builder maxError(int maxError)

Maximum allowed errors to be added to the schema's ImportSource as a maxError attribute. Default is 0, meaning the property isn't added to the schema.

Parameters:

maxError - the maximum allowed errors

Returns:

this JdbcSchemaCreator.Builder

useNanos

JdbcSchemaCreator.Builder useNanos(boolean useNanos)

Whether to try to use nanos for time calculations. Default is false.

Parameters:

useNanos - if true, use nanos for time calculations

Returns:

this JdbcSchemaCreator.Builder

resultSet

JdbcSchemaCreator.Builder resultSet(ResultSet resultSet)

An optional ResultSet instead of JDBC connection details. If this is used then no JDBC connection details should be provided.

Parameters:

resultSet - the ResultSet

Returns:

this JdbcSchemaCreator.Builder

build

JdbcSchemaCreator build()

Build the JdbcSchemaCreator

Returns:

the built JdbcSchemaCreator