Package io.deephaven.importers

Interface CsvSchemaCreator.Builder

Enclosing class:

CsvSchemaCreator

public static interface CsvSchemaCreator.Builder

A Builder object for CsvSchemaCreator.

Method Summary

Modifier and Type	Method	Description
CsvSchemaCreator.Builder	addAllColumnNames(Iterable<String> elements)	An optional list of column names to use when noHeader(boolean) is true.
CsvSchemaCreator.Builder	addColumnNames(String... elements)	An optional list of column names to use when noHeader(boolean) is true.
CsvSchemaCreator.Builder	bestFit(boolean bestFit)	Whether to try to use smaller types like int and float, or to use bigger types, like long and double.
CsvSchemaCreator	build()	Build the CsvSchemaCreator
CsvSchemaCreator.Builder	casingStyle(CasingStyle casingStyle)	The CasingStyle to use when generating column names.
CsvSchemaCreator.Builder	csvString(@NotNull String csvString)	An optional CSV string to be used for schema creation.
CsvSchemaCreator.Builder	delimiter(char delimiter)	The CSV field delimiter.
CsvSchemaCreator.Builder	fileFormat(CsvFormats fileFormat)	The file format to use when reading the CSV from CsvFormats.
CsvSchemaCreator.Builder	groupingColumn(String groupingColumn)	The grouping column for the table.
CsvSchemaCreator.Builder	logger(Logger logger)	The Logger to use.
CsvSchemaCreator.Builder	logProgress(boolean logProgress)	Whether to update the log with progress percentages.
CsvSchemaCreator.Builder	maxRows(long maxRows)	The maximum number of rows to read from the CSV file.
CsvSchemaCreator.Builder	namespace(@NotNull String namespace)	The namespace for the table.
CsvSchemaCreator.Builder	noHeader(boolean noHeader)	If true the CSV does not contain a header row.
CsvSchemaCreator.Builder	partitionColumn(String partitionColumn)	The partition column for the table.
CsvSchemaCreator.Builder	replacement(String replacement)	String to use for replacements of space or hyphen in source column names.
CsvSchemaCreator.Builder	skipFooterLines(int skipFooterLines)	The number of lines to skip from the end of the CSV file.
CsvSchemaCreator.Builder	skipHeaderLines(int skipHeaderLines)	The number of lines to skip at the top of the CSV file before trying to read the header row.
CsvSchemaCreator.Builder	sourceFile(@NotNull File sourceFile)	The source CSV File to be used for schema creation.
CsvSchemaCreator.Builder	sourceName(String sourceName)	The import source name.
CsvSchemaCreator.Builder	sourcePartitionColumn(String sourcePartitionColumn)	The column name in the source data to use for multi-partition imports, added in the schema's ImportSource element.
CsvSchemaCreator.Builder	tableName(@NotNull String tableName)	The table name for the table.
CsvSchemaCreator.Builder	trim(boolean trim)	Whether to trim data around values between delimiters.

Method Details

namespace

CsvSchemaCreator.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 CsvSchemaCreator.Builder

tableName

CsvSchemaCreator.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 CsvSchemaCreator.Builder

groupingColumn

CsvSchemaCreator.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 CsvSchemaCreator.Builder

partitionColumn

CsvSchemaCreator.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 CsvSchemaCreator.Builder

sourceName

CsvSchemaCreator.Builder sourceName(String sourceName)

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

Parameters:

sourceName - the import source name

Returns:

this CsvSchemaCreator.Builder

sourcePartitionColumn

CsvSchemaCreator.Builder sourcePartitionColumn(String sourcePartitionColumn)

The column name in the source data to use for multi-partition imports, added in the schema's ImportSource element.

Parameters:

sourcePartitionColumn - the column name

Returns:

this CsvSchemaCreator.Builder

fileFormat

CsvSchemaCreator.Builder fileFormat(CsvFormats fileFormat)

The file format to use when reading the CSV from CsvFormats. Default is CsvFormats.DEFAULT.

Parameters:

fileFormat - the file format

Returns:

this CsvSchemaCreator.Builder

delimiter

CsvSchemaCreator.Builder delimiter(char delimiter)

The CSV field delimiter. Default is ','.

Parameters:

delimiter - the delimiter

Returns:

this CsvSchemaCreator.Builder

skipHeaderLines

CsvSchemaCreator.Builder skipHeaderLines(int skipHeaderLines)

The number of lines to skip at the top of the CSV file before trying to read the header row. Default is 0.

Parameters:

skipHeaderLines - the number of lines to skip

Returns:

this CsvSchemaCreator.Builder

skipFooterLines

CsvSchemaCreator.Builder skipFooterLines(int skipFooterLines)

The number of lines to skip from the end of the CSV file. Default is 0.

Parameters:

skipFooterLines - the number of lines to skip

Returns:

this CsvSchemaCreator.Builder

sourceFile

CsvSchemaCreator.Builder sourceFile(@NotNull
 @NotNull File sourceFile)

The source CSV File to be used for schema creation. Either this or csvString(String) must be set, but not both.

Parameters:

sourceFile - the source file

Returns:

this CsvSchemaCreator.Builder

csvString

CsvSchemaCreator.Builder csvString(@NotNull
 @NotNull String csvString)

An optional CSV string to be used for schema creation. Either this or sourceFile(File) must be set, but not both.

Parameters:

csvString - the CSV string

Returns:

this CsvSchemaCreator.Builder

bestFit

CsvSchemaCreator.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 CsvSchemaCreator.Builder

trim

CsvSchemaCreator.Builder trim(boolean trim)

Whether to trim data around values between delimiters. Default is false.

Parameters:

trim - whether to trim

Returns:

this CsvSchemaCreator.Builder

noHeader

CsvSchemaCreator.Builder noHeader(boolean noHeader)

If true the CSV does not contain a header row. Default is false.

Parameters:

noHeader - whether there is no header

Returns:

this CsvSchemaCreator.Builder

addColumnNames

CsvSchemaCreator.Builder addColumnNames(String... elements)

An optional list of column names to use when noHeader(boolean) is true. May be null or empty if noHeader(boolean) is false. Empty or null lists are treated the same (as if no column names were passed).

Parameters:

elements - column names to use if the CSV has no header

Returns:

this CsvSchemaCreator.Builder

addAllColumnNames

CsvSchemaCreator.Builder addAllColumnNames(Iterable<String> elements)

An optional list of column names to use when noHeader(boolean) is true. May be null or empty if noHeader(boolean) is false. Empty or null lists are treated the same (as if no column names were passed).

Parameters:

elements - column names to use if the CSV has no header

Returns:

this CsvSchemaCreator.Builder

logProgress

CsvSchemaCreator.Builder logProgress(boolean logProgress)

Whether to update the log with progress percentages. Default is false.

Parameters:

logProgress - whether to log progress

Returns:

this CsvSchemaCreator.Builder

maxRows

CsvSchemaCreator.Builder maxRows(long maxRows)

The maximum number of rows to read from the CSV file. 0 or lower means read all rows. Default is -1 (read all rows).

Parameters:

maxRows - the maximum number of rows to read

Returns:

this CsvSchemaCreator.Builder

casingStyle

CsvSchemaCreator.Builder casingStyle(CasingStyle casingStyle)

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

Parameters:

casingStyle - the casing style

Returns:

this CsvSchemaCreator.Builder

replacement

CsvSchemaCreator.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 CsvSchemaCreator.Builder

logger

CsvSchemaCreator.Builder logger(Logger logger)

The Logger to use. Default is a StreamLoggerImpl with System.out and LogLevel.INFO.

Parameters:

logger - the logger

Returns:

this CsvSchemaCreator.Builder

build

CsvSchemaCreator build()

Build the CsvSchemaCreator

Returns:

the built CsvSchemaCreator