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

  • Constructor Details

    • AbstractRdbmsEntityProviderConfig

      public AbstractRdbmsEntityProviderConfig()

  • Method Details

    • toEntityProviderConfigBuilder

      public RdbmsEntityProviderConfigBuilder toEntityProviderConfigBuilder()
      Specified by:
      toEntityProviderConfigBuilder in interface oracle.pgx.config.internal.ConvertibleToEntityProviderConfigBuilder

    • hasDefaultValue

      public abstract boolean hasDefaultValue(RdbmsEntityProviderConfig.Field field)

    • getKeyColumn

      public abstract String getKeyColumn()
      See Also:

    • getSourceColumn

      public abstract String getSourceColumn()
      See Also:

    • getDestinationColumn

      public abstract String getDestinationColumn()
      See Also:

    • getSourceKeyColumns

      @BetaApi public abstract 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. Use getValidatedSourceKeyColumns() ()} 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 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 either getSourceKeyColumns() or legacy function.
      Returns:
      A list of validated foreign key column descriptors.
      Since:
      25.2.0

    • getDestinationKeyColumns

      @BetaApi public abstract 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. Use getValidatedDestinationKeyColumns() 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 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 either getDestinationKeyColumns() 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:
      supportsVectorProperties in class EntityProviderConfig
      Returns:
      true if this graph configuration's format supports vector properties, false otherwise

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class EntityProviderConfig

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class EntityProviderConfig

    • getKeystoreAlias

      public abstract String getKeystoreAlias()
      Description copied from interface: CommonLoadableConfig
      Gets the keystore alias.
      Specified by:
      getKeystoreAlias in interface CommonLoadableConfig<ProviderFormat>
      Returns:
      the keystore alias or null if underlying format does not require a keystore

    • getDatabaseTableName

      public abstract String getDatabaseTableName()

    • getNumConnections

      public abstract Integer getNumConnections()
      number of connections to read/write data from/to the RDBMS table
      Returns:
      the number of connections

    • getLoadedDatabaseTableName

      public 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 String getDataSourceId(AbstractPartitionedGraphConfig graphConfig)

    • getJdbcUrl

      public String getJdbcUrl(AbstractPartitionedGraphConfig graphConfig)

    • getUsername

      public String getUsername(AbstractPartitionedGraphConfig graphConfig)

    • getKeystoreAlias

      public String getKeystoreAlias(AbstractPartitionedGraphConfig graphConfig)

    • getSchema

      public String getSchema(AbstractPartitionedGraphConfig graphConfig)

    • getMaxPrefetchedRows

      public Integer getMaxPrefetchedRows(AbstractPartitionedGraphConfig graphConfig)

    • getNumConnections

      public Integer getNumConnections(AbstractPartitionedGraphConfig graphConfig)

    • getNumConnections

      public Integer getNumConnections(AbstractPartitionedGraphConfig graphConfig, int machineCount, int defaultNumConnectionsTotal)