Package com.exasol.adapter.document.edml

Class EdmlDefinition.EdmlDefinitionBuilder

java.lang.Object

com.exasol.adapter.document.edml.EdmlDefinition.EdmlDefinitionBuilder

Enclosing class:

EdmlDefinition

public static class EdmlDefinition.EdmlDefinitionBuilder
extends Object

A builder for EdmlDefinition.

Method Summary

Modifier and Type	Method	Description
EdmlDefinition.EdmlDefinitionBuilder	additionalConfiguration(String additionalConfiguration)	Set the optional additional configuration options.
EdmlDefinition.EdmlDefinitionBuilder	addSourceReferenceColumn(boolean addSourceReferenceColumn)	Define if a source reference column should be added.
EdmlDefinition.EdmlDefinitionBuilder	autoInferenceColumnNames(ColumnNameMapping autoInferenceColumnNames)	Set the column name mapping for auto-inference.
EdmlDefinition	build()	Build a new EdmlDefinition.
EdmlDefinition.EdmlDefinitionBuilder	description(String description)
EdmlDefinition.EdmlDefinitionBuilder	destinationTable(String destinationTable)
EdmlDefinition.EdmlDefinitionBuilder	mapping(MappingDefinition mapping)	Defines the mapping for the document's properties.
EdmlDefinition.EdmlDefinitionBuilder	source(String source)	Set the source reference, i.e.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

source

public EdmlDefinition.EdmlDefinitionBuilder source(String source)

Set the source reference, i.e. the table name or resource identifier.

Parameters:

source - source reference

Returns:

this.

destinationTable

public EdmlDefinition.EdmlDefinitionBuilder destinationTable(String destinationTable)

Parameters:

destinationTable - destination table

Returns:

this.

description

public EdmlDefinition.EdmlDefinitionBuilder description(String description)

Parameters:

description - description

Returns:

this.

addSourceReferenceColumn

public EdmlDefinition.EdmlDefinitionBuilder addSourceReferenceColumn(boolean addSourceReferenceColumn)

Define if a source reference column should be added. If set to true, this adapter adds the source reference as a column named SOURCE_REFERENCE to the Exasol table.

This feature is mainly useful if multiple sources are used (not supported by all dialects). In that case you can filter on the source name.

Parameters:

addSourceReferenceColumn - true if a source reference column should be added

Returns:

this.

mapping

public EdmlDefinition.EdmlDefinitionBuilder mapping(MappingDefinition mapping)

Defines the mapping for the document's properties. Typically you want to define fields here to define mappings for this document's properties. But you can also use toJsonMapping mapping here. In that case the whole document is mapped to a JSON string.

Omit the mapping to enable auto-inference.

Parameters:

mapping - mapping

Returns:

this.

autoInferenceColumnNames

public EdmlDefinition.EdmlDefinitionBuilder autoInferenceColumnNames(ColumnNameMapping autoInferenceColumnNames)

Set the column name mapping for auto-inference.

Only specify this when mapping is omitted.

Parameters:

autoInferenceColumnNames - column name mapping

Returns:

this.

additionalConfiguration

public EdmlDefinition.EdmlDefinitionBuilder additionalConfiguration(String additionalConfiguration)

Set the optional additional configuration options.

Parameters:

additionalConfiguration - additional configuration

Returns:

this.

build

public EdmlDefinition build()

Build a new EdmlDefinition.

Returns:

a new EdmlDefinition

toString

public String toString()

Overrides:

toString in class Object