PostgreSqlSource Class

public final class PostgreSqlSource
extends TabularSource

A copy activity source for PostgreSQL databases.

Constructor Summary

Constructor Description
PostgreSqlSource()

Creates an instance of PostgreSqlSource class.

Method Summary

Modifier and Type Method and Description
static PostgreSqlSource fromJson(JsonReader jsonReader)

Reads an instance of PostgreSqlSource 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.

PostgreSqlSource withAdditionalColumns(Object additionalColumns)

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

PostgreSqlSource withDisableMetricsCollection(Object disableMetricsCollection)

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

PostgreSqlSource withMaxConcurrentConnections(Object maxConcurrentConnections)

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

PostgreSqlSource withQuery(Object query)

Set the query property: Database query.

PostgreSqlSource withQueryTimeout(Object queryTimeout)

Set the queryTimeout property: Query timeout.

PostgreSqlSource withSourceRetryCount(Object sourceRetryCount)

Set the sourceRetryCount property: Source retry count.

PostgreSqlSource withSourceRetryWait(Object sourceRetryWait)

Set the sourceRetryWait property: Source retry wait.

Methods inherited from CopySource

Methods inherited from TabularSource

Methods inherited from java.lang.Object

Constructor Details

PostgreSqlSource

public PostgreSqlSource()

Creates an instance of PostgreSqlSource class.

Method Details

fromJson

public static PostgreSqlSource fromJson(JsonReader jsonReader)

Reads an instance of PostgreSqlSource from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of PostgreSqlSource 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 PostgreSqlSource.

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:

PostgreSqlSource.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: Copy source type.

Overrides:

PostgreSqlSource.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

PostgreSqlSource.validate()

withAdditionalColumns

public PostgreSqlSource 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).

Overrides:

PostgreSqlSource.withAdditionalColumns(Object additionalColumns)

Parameters:

additionalColumns

withDisableMetricsCollection

public PostgreSqlSource 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:

PostgreSqlSource.withDisableMetricsCollection(Object disableMetricsCollection)

Parameters:

disableMetricsCollection

withMaxConcurrentConnections

public PostgreSqlSource 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:

PostgreSqlSource.withMaxConcurrentConnections(Object maxConcurrentConnections)

Parameters:

maxConcurrentConnections

withQuery

public PostgreSqlSource 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 PostgreSqlSource object itself.

withQueryTimeout

public PostgreSqlSource withQueryTimeout(Object queryTimeout)

Set the queryTimeout property: Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Overrides:

PostgreSqlSource.withQueryTimeout(Object queryTimeout)

Parameters:

queryTimeout

withSourceRetryCount

public PostgreSqlSource withSourceRetryCount(Object sourceRetryCount)

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

Overrides:

PostgreSqlSource.withSourceRetryCount(Object sourceRetryCount)

Parameters:

sourceRetryCount

withSourceRetryWait

public PostgreSqlSource 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:

PostgreSqlSource.withSourceRetryWait(Object sourceRetryWait)

Parameters:

sourceRetryWait

Applies to