Package oracle.pgx.config

Class RdbmsEntityProviderConfigBuilder

java.lang.Object

oracle.pgx.config.AbstractEntityProviderConfigBuilder<RdbmsEntityProviderConfigBuilder,RdbmsEntityProviderConfig>

oracle.pgx.config.RdbmsEntityProviderConfigBuilder

All Implemented Interfaces:

oracle.pgx.config.internal.ConvertibleToEntityProviderConfigBuilder

public final class RdbmsEntityProviderConfigBuilder
extends AbstractEntityProviderConfigBuilder<RdbmsEntityProviderConfigBuilder,RdbmsEntityProviderConfig>

A table configuration builder for rdbms-based table configurations.

Constructor Summary

Constructors

Constructor	Description
RdbmsEntityProviderConfigBuilder()

Method Summary

Modifier and Type	Method	Description
RdbmsEntityProviderConfigBuilder	copyFrom(RdbmsEntityProviderConfig graphConfig)	Sets this builder with all the values of the given provider config.
RdbmsEntityProviderConfigBuilder	setAsOf(java.lang.String asOf)	Sets the SCN value to use as default.
RdbmsEntityProviderConfigBuilder	setDatabaseTableName(java.lang.String databaseTableName)	Sets the table name in the database.
RdbmsEntityProviderConfigBuilder	setDataSourceId(java.lang.String dsId)	Sets the datasource ID.
RdbmsEntityProviderConfigBuilder	setDataTableName(java.lang.String dataTableName)	Alias for setDatabaseTableName(String)
RdbmsEntityProviderConfigBuilder	setDestinationColumn(java.lang.String toVkey)	Sets the name of the column holding the keys of the destination vertices.
RdbmsEntityProviderConfigBuilder	setDestinationKeyColumns(java.util.List<? extends ForeignKeyColumnDescriptor> destinationKeyColumns)	Set destination key columns, i.e., a list of columns with foreign key relations to key columns in the destination vertex provider.
RdbmsEntityProviderConfigBuilder	setJdbcUrl(java.lang.String url)	Sets the jdbc url.
RdbmsEntityProviderConfigBuilder	setKeyColumn(java.lang.String nKey)	Sets the name for the column holding the keys.
RdbmsEntityProviderConfigBuilder	setMaxPreFetchedRows(int maxPreFetchedRows)	Sets the maximum number of prefetched rows.
RdbmsEntityProviderConfigBuilder	setNumConnections(int c)	Sets the number of connections.
RdbmsEntityProviderConfigBuilder	setParallelHintDegree(int parallelHintDegree)	Sets the PARALLEL hint to use for internal queries.
RdbmsEntityProviderConfigBuilder	setSchema(java.lang.String schema)	Sets the schema.
RdbmsEntityProviderConfigBuilder	setSourceColumn(java.lang.String fromVkey)	Sets the name of the column holding the keys of the source vertices.
RdbmsEntityProviderConfigBuilder	setSourceKeyColumns(java.util.List<? extends ForeignKeyColumnDescriptor> sourceKeyColumns)	Set source key columns, i.e., a list of columns with foreign key relations to key columns in the source vertex provider.
RdbmsEntityProviderConfigBuilder	setUsername(java.lang.String un)	Sets the username.
RdbmsEntityProviderConfigBuilder	toEntityProviderConfigBuilder()

Methods inherited from class oracle.pgx.config.AbstractEntityProviderConfigBuilder

addAttribute, addProperty, addProperty, addProperty, addStringProperty, addStringProperty, addVectorProperty, addVectorProperty, addVectorProperty, addVectorProperty, build, clearProperties, copyBaseFrom, createKeyMapping, enableEdgeIdDuplicateCheck, enableVertexIdDuplicateCheck, redactPassword, removeProperty, setDestinationVertexKeyType, setDestinationVertexProvider, setErrorHandlingOnDuplicateEntityId, setErrorHandlingOnMissedPropKey, setErrorHandlingOnMissingVertex, setErrorHandlingOnParsingIssue, setErrorHandlingOnPropConversion, setErrorHandlingOnTypeMismatch, setErrorHandlingOnVectorLengthMismatch, setHasKeys, setKeyColumns, setKeystoreAlias, setKeyType, setLabel, setLocalDateFormat, setName, setPassword, setSourceVertexKeyType, setSourceVertexProvider, setStrictMode, setTimeFormat, setTimestampFormat, setTimestampWithTimezoneFormat, setTimeWithTimezoneFormat

Methods inherited from class java.lang.Object

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

Constructor Detail

RdbmsEntityProviderConfigBuilder

public RdbmsEntityProviderConfigBuilder()

Method Detail

toEntityProviderConfigBuilder

public RdbmsEntityProviderConfigBuilder toEntityProviderConfigBuilder()

copyFrom

public RdbmsEntityProviderConfigBuilder copyFrom(RdbmsEntityProviderConfig graphConfig)

Description copied from class: AbstractEntityProviderConfigBuilder

Sets this builder with all the values of the given provider config. If a format was already specified it will remain unchanged, however any other values copied from the given provider config will overwrite the corresponding values of this builder.

Overrides:

copyFrom in class AbstractEntityProviderConfigBuilder<RdbmsEntityProviderConfigBuilder,RdbmsEntityProviderConfig>

Parameters:

graphConfig - the provider configuration from which to copy the values

Returns:

this builder

setDataSourceId

public RdbmsEntityProviderConfigBuilder setDataSourceId(java.lang.String dsId)

Sets the datasource ID.

Parameters:

dsId - the datasource ID

Returns:

this builder

setJdbcUrl

public RdbmsEntityProviderConfigBuilder setJdbcUrl(java.lang.String url)

Sets the jdbc url.

Parameters:

url - the url

Returns:

this builder

setUsername

public RdbmsEntityProviderConfigBuilder setUsername(java.lang.String un)

Sets the username.

Parameters:

un - the username

Returns:

this builder

setDataTableName

public RdbmsEntityProviderConfigBuilder setDataTableName(java.lang.String dataTableName)

Alias for setDatabaseTableName(String)

Parameters:

dataTableName - the data table name

Returns:

this builder

setDatabaseTableName

public RdbmsEntityProviderConfigBuilder setDatabaseTableName(java.lang.String databaseTableName)

Sets the table name in the database.

Parameters:

databaseTableName - the nodes table name

Returns:

this builder

setNumConnections

public RdbmsEntityProviderConfigBuilder setNumConnections(int c)

Sets the number of connections.

Parameters:

c - the number of connections

Returns:

this builder

setKeyColumn

public RdbmsEntityProviderConfigBuilder setKeyColumn(java.lang.String nKey)

Sets the name for the column holding the keys.

Warning: Setting this deprecated field in addition to AbstractEntityProviderConfigBuilder.setKeyColumns(List) will cause AbstractEntityProviderConfigBuilder.build() to fail, as the generated config build be invalid.

Parameters:

nKey - the name of the key column

Returns:

this builder

See Also:

API with support for multiple key columns

setSourceColumn

public RdbmsEntityProviderConfigBuilder setSourceColumn(java.lang.String fromVkey)

Sets the name of the column holding the keys of the source vertices.

Warning: Setting this deprecated field in addition to setSourceKeyColumns(List) will cause AbstractEntityProviderConfigBuilder.build() to fail, as the generated config build be invalid.

Parameters:

fromVkey - the column name

Returns:

this builder

See Also:

API with support for multiple key columns

setSourceKeyColumns

@BetaApi
public RdbmsEntityProviderConfigBuilder setSourceKeyColumns(java.util.List<? extends ForeignKeyColumnDescriptor> sourceKeyColumns)

Set source key columns, i.e., a list of columns with foreign key relations to key columns in the source vertex provider.

Parameters:

sourceKeyColumns - source key columns

Returns:

this builder

Since:

25.2.0

setDestinationColumn

public RdbmsEntityProviderConfigBuilder setDestinationColumn(java.lang.String toVkey)

Sets the name of the column holding the keys of the destination vertices.

Warning: Setting this deprecated field in addition to setDestinationKeyColumns(List) will cause AbstractEntityProviderConfigBuilder.build() to fail, as the generated config build be invalid.

Parameters:

toVkey - the column id

Returns:

this builder

See Also:

API with support for multiple key columns

setDestinationKeyColumns

@BetaApi
public RdbmsEntityProviderConfigBuilder setDestinationKeyColumns(java.util.List<? extends ForeignKeyColumnDescriptor> destinationKeyColumns)

Set destination key columns, i.e., a list of columns with foreign key relations to key columns in the destination vertex provider.

Parameters:

destinationKeyColumns - destination key columns

Returns:

this builder

Since:

25.2.0

setMaxPreFetchedRows

public RdbmsEntityProviderConfigBuilder setMaxPreFetchedRows(int maxPreFetchedRows)

Sets the maximum number of prefetched rows.

Parameters:

maxPreFetchedRows - the maximum number of prefetched rows

Returns:

this builder

setSchema

public RdbmsEntityProviderConfigBuilder setSchema(java.lang.String schema)

Sets the schema.

Parameters:

schema - the schema

Returns:

this builder

setAsOf

public RdbmsEntityProviderConfigBuilder setAsOf(java.lang.String asOf)

Sets the SCN value to use as default.

Parameters:

asOf - the scn value

Returns:

this builder

Since:

21.4

setParallelHintDegree

public RdbmsEntityProviderConfigBuilder setParallelHintDegree(int parallelHintDegree)

Sets the PARALLEL hint to use for internal queries.

Parameters:

parallelHintDegree - the degree of parallelism

Returns:

this builder

Since:

22.3