Package oracle.pgx.config
Class AbstractRdbmsEntityProviderConfig
- java.lang.Object
-
- oracle.pgx.config.AbstractConfig
-
- oracle.pgx.config.EntityProviderConfig
-
- oracle.pgx.config.AbstractRdbmsEntityProviderConfig
-
- All Implemented Interfaces:
CommonLoadableConfig<ProviderFormat>,DbConnectionConfig,oracle.pgx.config.internal.ConvertibleToEntityProviderConfigBuilder
- Direct Known Subclasses:
RdbmsEntityProviderConfig
public abstract class AbstractRdbmsEntityProviderConfig extends EntityProviderConfig implements DbConnectionConfig
-
-
Field Summary
-
Fields inherited from class oracle.pgx.config.AbstractConfig
ENV_SEPARATOR, ENV_VARIABLE_PREFIX, SYSTEM_PROPERTY_PREFIX
-
-
Constructor Summary
Constructors Constructor Description AbstractRdbmsEntityProviderConfig()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object o)abstract java.lang.StringgetDatabaseTableName()java.lang.StringgetDataSourceId(AbstractPartitionedGraphConfig graphConfig)abstract java.lang.StringgetDestinationColumn()abstract java.util.List<? extends ForeignKeyColumnDescriptor>getDestinationKeyColumns()Get the destination key declaration associated with this entity provider config.java.lang.StringgetJdbcUrl(AbstractPartitionedGraphConfig graphConfig)abstract java.lang.StringgetKeyColumn()abstract java.lang.StringgetKeystoreAlias()Gets the keystore alias.java.lang.StringgetKeystoreAlias(AbstractPartitionedGraphConfig graphConfig)java.lang.StringgetLoadedDatabaseTableName()Gives the name of the table in the database the we should load the data from.java.lang.IntegergetMaxPrefetchedRows(AbstractPartitionedGraphConfig graphConfig)abstract java.lang.IntegergetNumConnections()number of connections to read/write data from/to the RDBMS tablejava.lang.IntegergetNumConnections(AbstractPartitionedGraphConfig graphConfig)java.lang.IntegergetNumConnections(AbstractPartitionedGraphConfig graphConfig, int machineCount, int defaultNumConnectionsTotal)java.lang.StringgetSchema(AbstractPartitionedGraphConfig graphConfig)abstract java.lang.StringgetSourceColumn()abstract java.util.List<? extends ForeignKeyColumnDescriptor>getSourceKeyColumns()Get the source key declaration associated with this entity provider config.java.lang.StringgetUsername(AbstractPartitionedGraphConfig graphConfig)java.util.List<? extends ForeignKeyColumnDescriptor>getValidatedDestinationKeyColumns()Validate and get the source key declaration associated with this provider configuration.java.util.List<? extends ForeignKeyColumnDescriptor>getValidatedSourceKeyColumns()Validate and get the source key declaration associated with this provider configuration.abstract booleanhasDefaultValue(RdbmsEntityProviderConfig.Field field)inthashCode()booleansupportsVectorProperties()Check if this graph configuration's format supports having vector properties or notRdbmsEntityProviderConfigBuildertoEntityProviderConfigBuilder()-
Methods inherited from class oracle.pgx.config.EntityProviderConfig
getDestinationVertexKeyType, getDestinationVertexProvider, getKeyColumns, getKeyType, getLabel, getLoading, getName, getPropertyDefault, getPropertyDimension, getPropertyName, getPropertyType, getProps, getSourceVertexKeyType, getSourceVertexProvider, getValidatedKeyColumns, getValidatedLabel, hasKeys, isKeyMappingEnabled, isLabelLoadingEnabled, numProperties, supportsPropertyColumn, supportsPropertyColumn, supportsVectorProperties
-
Methods inherited from class oracle.pgx.config.AbstractConfig
getDefault, getValueFromEnvironment, getValueFromEnvironment, getValues, parseString, setSerializable
-
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface oracle.pgx.config.CommonLoadableConfig
createLocalDateFormat, createTimeFormat, createTimestampFormat, createTimestampWithTimezoneFormat, createTimeWithTimezoneFormat, getAttributes, getErrorHandling, getFormat, getLocalDateFormat, getTimeFormat, getTimestampFormat, getTimestampWithTimezoneFormat, getTimeWithTimezoneFormat, getVectorComponentDelimiter
-
Methods inherited from interface oracle.pgx.config.DbConnectionConfig
getDataSourceId, getJdbcUrl, getMaxPrefetchedRows, getSchema, getUsername
-
-
-
-
Method Detail
-
toEntityProviderConfigBuilder
public RdbmsEntityProviderConfigBuilder toEntityProviderConfigBuilder()
- Specified by:
toEntityProviderConfigBuilderin interfaceoracle.pgx.config.internal.ConvertibleToEntityProviderConfigBuilder
-
hasDefaultValue
public abstract boolean hasDefaultValue(RdbmsEntityProviderConfig.Field field)
-
getKeyColumn
public abstract java.lang.String getKeyColumn()
- See Also:
validating version of this API
-
getSourceColumn
public abstract java.lang.String getSourceColumn()
- See Also:
validating version of this API
-
getDestinationColumn
public abstract java.lang.String getDestinationColumn()
- See Also:
validating version of this API
-
getSourceKeyColumns
@BetaApi public abstract java.util.List<? extends ForeignKeyColumnDescriptor> getSourceKeyColumns()
Get the source key declaration associated with this entity provider config. A source key is composed of one or more source key columns, each referring to one key column of the source vertex provider. UsegetValidatedSourceKeyColumns()()} instead of this function, as that function will also consider legacy configs.- Returns:
- Source key columns declared in the config.
- Since:
- 25.2.0
-
getValidatedSourceKeyColumns
@BetaApi public java.util.List<? extends ForeignKeyColumnDescriptor> getValidatedSourceKeyColumns()
Validate and get the source key declaration associated with this provider configuration. This function will use the source key returned by eithergetSourceKeyColumns()or legacy function.- Returns:
- A list of validated foreign key column descriptors.
- Since:
- 25.2.0
-
getDestinationKeyColumns
@BetaApi public abstract java.util.List<? extends ForeignKeyColumnDescriptor> getDestinationKeyColumns()
Get the destination key declaration associated with this entity provider config. A destination key is composed of one or more destination key columns, each referring to one key column of the destination vertex provider. UsegetValidatedDestinationKeyColumns()instead of this function, as that function will also consider legacy configs.- Returns:
- Destination key columns declared in the config.
- Since:
- 25.2.0
-
getValidatedDestinationKeyColumns
@BetaApi public java.util.List<? extends ForeignKeyColumnDescriptor> getValidatedDestinationKeyColumns()
Validate and get the source key declaration associated with this provider configuration. This function will use the source key returned by eithergetDestinationKeyColumns()or legacy function.- Returns:
- A list of validated foreign key column descriptors.
- Since:
- 25.2.0
-
supportsVectorProperties
public boolean supportsVectorProperties()
Check if this graph configuration's format supports having vector properties or not- Overrides:
supportsVectorPropertiesin classEntityProviderConfig- Returns:
trueif this graph configuration's format supports vector properties,falseotherwise
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equalsin classEntityProviderConfig
-
hashCode
public int hashCode()
- Overrides:
hashCodein classEntityProviderConfig
-
getKeystoreAlias
public abstract java.lang.String getKeystoreAlias()
Description copied from interface:CommonLoadableConfigGets the keystore alias.- Specified by:
getKeystoreAliasin interfaceCommonLoadableConfig<ProviderFormat>- Returns:
- the keystore alias or null if underlying format does not require a keystore
-
getDatabaseTableName
public abstract java.lang.String getDatabaseTableName()
-
getNumConnections
public abstract java.lang.Integer getNumConnections()
number of connections to read/write data from/to the RDBMS table- Returns:
- the number of connections
-
getLoadedDatabaseTableName
public java.lang.String getLoadedDatabaseTableName()
Gives the name of the table in the database the we should load the data from. If the database table name field is not set, it uses the name of the (PGX) table in the graph config.- Returns:
- the name of the database table to load the data from
-
getDataSourceId
public java.lang.String getDataSourceId(AbstractPartitionedGraphConfig graphConfig)
-
getJdbcUrl
public java.lang.String getJdbcUrl(AbstractPartitionedGraphConfig graphConfig)
-
getUsername
public java.lang.String getUsername(AbstractPartitionedGraphConfig graphConfig)
-
getKeystoreAlias
public java.lang.String getKeystoreAlias(AbstractPartitionedGraphConfig graphConfig)
-
getSchema
public java.lang.String getSchema(AbstractPartitionedGraphConfig graphConfig)
-
getMaxPrefetchedRows
public java.lang.Integer getMaxPrefetchedRows(AbstractPartitionedGraphConfig graphConfig)
-
getNumConnections
public java.lang.Integer getNumConnections(AbstractPartitionedGraphConfig graphConfig)
-
getNumConnections
public java.lang.Integer getNumConnections(AbstractPartitionedGraphConfig graphConfig, int machineCount, int defaultNumConnectionsTotal)
-
-