Package com.gpudb.filesystem.ingest

Class IngestOptions

java.lang.Object

com.gpudb.filesystem.ingest.IngestOptions

public class IngestOptions
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IngestOptions.Option

Constructor Summary

Constructors

Constructor	Description
IngestOptions()	Default constructor

Method Summary

Modifier and Type	Method	Description
long	getBadRecordTableLimit()	Returns the value of 'bad_record_table_limit'
String	getBadRecordTableName()	Returns the value of 'bad_record_table_name'
Map<String,org.apache.commons.lang3.tuple.Pair<String,String>>	getColumnFormats()	Gets the 'column_format' as a Map representing a JSON
Set<String>	getColumnsToLoad()	Gets the set of column names to load
Set<String>	getColumnsToSkip()	Gets the set of column names to skip
Map<String,String>	getDefaultColumnFormats()	Gets a Map of default column formats
ErrorHandlingMode	getErrorHandlingMode()	Getter for ErrorHandlingMode
FileType	getFileType()
Map<String,String>	getOptions()	Getter method for all the options set
List<String>	getPrimaryKeys()
List<String>	getShardKeys()
String	getTextCommentString()
String	getTextDelimiter()
String	getTextEscapeCharacter()
String	getTextHeaderPropertyDelimiter()
String	getTextNullString()
String	getTextQuoteCharacter()
TypeInferenceMode	getTypeInferenceMode()
boolean	isTextHasHeader()
boolean	isTruncateTable()
void	put(String key, boolean value)
void	put(String key, int value)
void	put(String key, long value)
void	put(String key, String value)
IngestOptions	setBadRecordTableLimit(long badRecordTableLimit)	Sets the value of 'bad_record_table_limit'
IngestOptions	setBadRecordTableName(String badRecordTableName)	Sets the value of 'bad_record_table_name'.
IngestOptions	setColumnFormats(Map<String,org.apache.commons.lang3.tuple.Pair<String,String>> columnFormats)	Sets the column formats
IngestOptions	setColumnsToLoad(Set<String> columnsToLoad)	Sets the set of column names to load
IngestOptions	setColumnsToSkip(Set<String> columnsToSkip)	Sets the column names to skip
IngestOptions	setDefaultColumnFormats(Map<String,String> defaultColumnFormats)	Sets the default column formats
IngestOptions	setErrorHandlingMode(ErrorHandlingMode errorHandlingMode)
IngestOptions	setFileType(FileType fileType)
IngestOptions	setPrimaryKeys(List<String> primaryKeys)
IngestOptions	setShardKeys(List<String> shardKeys)
IngestOptions	setTextCommentString(String textCommentString)
IngestOptions	setTextDelimiter(String textDelimiter)
IngestOptions	setTextEscapeCharacter(String textEscapeCharacter)
IngestOptions	setTextHasHeader(boolean textHasHeader)
IngestOptions	setTextHeaderPropertyDelimiter(String textHeaderPropertyDelimiter)
IngestOptions	setTextNullString(String textNullString)
IngestOptions	setTextQuoteCharacter(String textQuoteCharacter)	Setter method for text quote character
IngestOptions	setTruncateTable(boolean truncateTable)
IngestOptions	setTypeInferenceMode(TypeInferenceMode typeInferenceMode)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IngestOptions

public IngestOptions()

Default constructor

Method Detail

getBadRecordTableName

public String getBadRecordTableName()

Returns the value of 'bad_record_table_name'

Returns:

- a string

See Also:

setBadRecordTableName(String)

setBadRecordTableName

public IngestOptions setBadRecordTableName(String badRecordTableName)

Sets the value of 'bad_record_table_name'.

Parameters:

badRecordTableName - - a string

Returns:

- an IngestOptions object

See Also:

getBadRecordTableName()

getBadRecordTableLimit

public long getBadRecordTableLimit()

Returns the value of 'bad_record_table_limit'

Returns:

- a long value

See Also:

setBadRecordTableLimit(long)

setBadRecordTableLimit

public IngestOptions setBadRecordTableLimit(long badRecordTableLimit)

Sets the value of 'bad_record_table_limit'

Parameters:

badRecordTableLimit - - a long value

Returns:

- an IngestOptions object

See Also:

getBadRecordTableLimit()

getColumnFormats

public Map<String,org.apache.commons.lang3.tuple.Pair<String,String>> getColumnFormats()

Gets the 'column_format' as a Map representing a JSON

Returns:

- a Map of a String to a Pair of Strings

See Also:

setColumnFormats(Map)

setColumnFormats

public IngestOptions setColumnFormats(Map<String,org.apache.commons.lang3.tuple.Pair<String,String>> columnFormats)
                               throws com.fasterxml.jackson.core.JsonProcessingException

Sets the column formats

Parameters:

columnFormats - - A Map of String to a Pair of Strings

Returns:

- an IngestOptions object

Throws:

com.fasterxml.jackson.core.JsonProcessingException - - when conversion to JSON fails

See Also:

getColumnFormats()

getColumnsToLoad

public Set<String> getColumnsToLoad()

Gets the set of column names to load

Returns:

- a Set of column names

See Also:

setColumnsToLoad(Set)

setColumnsToLoad

public IngestOptions setColumnsToLoad(Set<String> columnsToLoad)
                               throws GPUdbException,
                                      com.fasterxml.jackson.core.JsonProcessingException

Sets the set of column names to load

Parameters:

columnsToLoad - - a Set of column names

Returns:

an IngestOptions object

Throws:

GPUdbException - - when names of columns to skip and load overlap

com.fasterxml.jackson.core.JsonProcessingException - - when JSON conversion fails

See Also:

getColumnsToLoad()

getColumnsToSkip

public Set<String> getColumnsToSkip()

Gets the set of column names to skip

Returns:

- a Set of column names

See Also:

setColumnsToSkip(Set)

setColumnsToSkip

public IngestOptions setColumnsToSkip(Set<String> columnsToSkip)
                               throws GPUdbException

Sets the column names to skip

Parameters:

columnsToSkip - - a Set of column names

Returns:

- an IngestOptions object

Throws:

GPUdbException

See Also:

getColumnsToSkip()

getDefaultColumnFormats

public Map<String,String> getDefaultColumnFormats()

Gets a Map of default column formats

Returns:

- a Map of String to String

setDefaultColumnFormats

public IngestOptions setDefaultColumnFormats(Map<String,String> defaultColumnFormats)
                                      throws com.fasterxml.jackson.core.JsonProcessingException

Sets the default column formats

Parameters:

defaultColumnFormats - - a Map of string to String

Returns:

an IngestOptions object

Throws:

com.fasterxml.jackson.core.JsonProcessingException

See Also:

getDefaultColumnFormats()

getErrorHandlingMode

public ErrorHandlingMode getErrorHandlingMode()

Getter for ErrorHandlingMode

Returns:

the ErrorHandlingMode value

setErrorHandlingMode

public IngestOptions setErrorHandlingMode(ErrorHandlingMode errorHandlingMode)

getFileType

public FileType getFileType()

setFileType

public IngestOptions setFileType(FileType fileType)

getPrimaryKeys

public List<String> getPrimaryKeys()

setPrimaryKeys

public IngestOptions setPrimaryKeys(List<String> primaryKeys)

getShardKeys

public List<String> getShardKeys()

setShardKeys

public IngestOptions setShardKeys(List<String> shardKeys)

getTextCommentString

public String getTextCommentString()

setTextCommentString

public IngestOptions setTextCommentString(String textCommentString)

getTextDelimiter

public String getTextDelimiter()

setTextDelimiter

public IngestOptions setTextDelimiter(String textDelimiter)

getTextEscapeCharacter

public String getTextEscapeCharacter()

setTextEscapeCharacter

public IngestOptions setTextEscapeCharacter(String textEscapeCharacter)

isTextHasHeader

public boolean isTextHasHeader()

setTextHasHeader

public IngestOptions setTextHasHeader(boolean textHasHeader)

getTextHeaderPropertyDelimiter

public String getTextHeaderPropertyDelimiter()

setTextHeaderPropertyDelimiter

public IngestOptions setTextHeaderPropertyDelimiter(String textHeaderPropertyDelimiter)

getTextNullString

public String getTextNullString()

setTextNullString

public IngestOptions setTextNullString(String textNullString)

getTextQuoteCharacter

public String getTextQuoteCharacter()

setTextQuoteCharacter

public IngestOptions setTextQuoteCharacter(String textQuoteCharacter)

Setter method for text quote character

Parameters:

textQuoteCharacter - - a String value for the text quote character to be set

Returns:

- the current instance of IngestOptions

isTruncateTable

public boolean isTruncateTable()

setTruncateTable

public IngestOptions setTruncateTable(boolean truncateTable)

getTypeInferenceMode

public TypeInferenceMode getTypeInferenceMode()

setTypeInferenceMode

public IngestOptions setTypeInferenceMode(TypeInferenceMode typeInferenceMode)

put

public void put(String key,
                int value)

put

public void put(String key,
                long value)

put

public void put(String key,
                String value)

put

public void put(String key,
                boolean value)

getOptions

public Map<String,String> getOptions()

Getter method for all the options set

Returns:

- the Options as a Map of String to String