RelationalSource Class

public final class RelationalSource
extends CopySource

A copy activity source for various relational databases.

Constructor Summary

Constructor Description
RelationalSource()

Creates an instance of RelationalSource class.

Method Summary

Modifier and Type Method and Description
Object additionalColumns()

Get the additionalColumns property: Specifies the additional columns to be added to source data.

static RelationalSource fromJson(JsonReader jsonReader)

Reads an instance of RelationalSource from the JsonReader.

Object query()

Get the query property: Database query.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: Copy source type.

void validate()

Validates the instance.

RelationalSource withAdditionalColumns(Object additionalColumns)

Set the additionalColumns property: Specifies the additional columns to be added to source data.

RelationalSource withDisableMetricsCollection(Object disableMetricsCollection)

Set the disableMetricsCollection property: If true, disable data store metrics collection.

RelationalSource withMaxConcurrentConnections(Object maxConcurrentConnections)

Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store.

RelationalSource withQuery(Object query)

Set the query property: Database query.

RelationalSource withSourceRetryCount(Object sourceRetryCount)

Set the sourceRetryCount property: Source retry count.

RelationalSource withSourceRetryWait(Object sourceRetryWait)

Set the sourceRetryWait property: Source retry wait.

Methods inherited from CopySource

Methods inherited from java.lang.Object

Constructor Details

RelationalSource

public RelationalSource()

Creates an instance of RelationalSource class.

Method Details

additionalColumns

public Object additionalColumns()

Get the additionalColumns property: Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Returns:

the additionalColumns value.

fromJson

public static RelationalSource fromJson(JsonReader jsonReader)

Reads an instance of RelationalSource from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of RelationalSource if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the RelationalSource.

query

public Object query()

Get the query property: Database query. Type: string (or Expression with resultType string).

Returns:

the query value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

RelationalSource.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: Copy source type.

Overrides:

RelationalSource.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

RelationalSource.validate()

withAdditionalColumns

public RelationalSource withAdditionalColumns(Object additionalColumns)

Set the additionalColumns property: Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Parameters:

additionalColumns - the additionalColumns value to set.

Returns:

the RelationalSource object itself.

withDisableMetricsCollection

public RelationalSource withDisableMetricsCollection(Object disableMetricsCollection)

Set the disableMetricsCollection property: If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).

Overrides:

RelationalSource.withDisableMetricsCollection(Object disableMetricsCollection)

Parameters:

disableMetricsCollection

withMaxConcurrentConnections

public RelationalSource withMaxConcurrentConnections(Object maxConcurrentConnections)

Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

Overrides:

RelationalSource.withMaxConcurrentConnections(Object maxConcurrentConnections)

Parameters:

maxConcurrentConnections

withQuery

public RelationalSource withQuery(Object query)

Set the query property: Database query. Type: string (or Expression with resultType string).

Parameters:

query - the query value to set.

Returns:

the RelationalSource object itself.

withSourceRetryCount

public RelationalSource withSourceRetryCount(Object sourceRetryCount)

Set the sourceRetryCount property: Source retry count. Type: integer (or Expression with resultType integer).

Overrides:

RelationalSource.withSourceRetryCount(Object sourceRetryCount)

Parameters:

sourceRetryCount

withSourceRetryWait

public RelationalSource withSourceRetryWait(Object sourceRetryWait)

Set the sourceRetryWait property: Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Overrides:

RelationalSource.withSourceRetryWait(Object sourceRetryWait)

Parameters:

sourceRetryWait

Applies to