Package oracle.pgx.config

Class RdbmsEntityProviderConfig

    • Method Detail

      • parse

        public static RdbmsEntityProviderConfig parse​(java.io.InputStream is,
                                              boolean strict,
                                              java.lang.String parentPath)
                                       throws java.io.IOException
        Parses an input stream.
        Parameters:
        is - the input stream
        strict - if true, parses in strict mode
        parentPath - if not null, resolves relative paths against this parentPath
        Returns:
        the parsed graph config
        Throws:
        java.io.IOException - Signals that an I/O exception has occurred.

      • parse

        public static RdbmsEntityProviderConfig parse​(java.util.Map<java.lang.String,​java.lang.Object> raw,
                                              boolean strict,
                                              java.lang.String parentPath)
        Parses a raw key/value mapping.
        Parameters:
        raw - the raw key/value mapping to parse
        strict - if true, parses in strict mode
        parentPath - if not null, resolves relative paths against this parentPath
        Returns:
        the parsed graph config

      • parse

        public static RdbmsEntityProviderConfig parse​(java.util.Properties props,
                                              boolean strict)
        Parses a properties file.
        Parameters:
        props - the properties to parse
        strict - if true, parses in strict mode
        Returns:
        the parsed graph config

      • isEmpty

        public boolean isEmpty()
        Checks if it's empty.
        Returns:
        true, if the Map 'values' is empty.

      • getValuesWithoutDefaults

        public java.util.Map<RdbmsEntityProviderConfig.Field,​java.lang.Object> getValuesWithoutDefaults()
        Gets the values without defaults.
        Returns:
        the values without defaults

      • getLeftoverValues

        public java.util.Map<java.lang.String,​java.lang.Object> getLeftoverValues()
        Gets the values that do not belong to any field.
        Returns:
        the values that do not belong to any field

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • toString

        public java.lang.String toString​(boolean hideSensitiveData)

      • getAsOf

        public java.lang.String getAsOf()
        SCN value to use when executing Oracle Flashback queries, use `<current-scn>` to determine SCN automatically during loading. Use `<no-scn>` to disable this feature.

      • getParallelHintDegree

        public java.lang.Integer getParallelHintDegree()
        parallel hint degree to use for internal queries. If the value is negative, the parallel hint will be omitted. If the value is zero, a parallel hint without degree is generated.

      • getNumConnections

        public java.lang.Integer getNumConnections()
        number of connections to read/write data from/to the RDBMS table. For the distributed runtime, this value will be multiplied by the number of machines used
        Specified by:
        getNumConnections in class AbstractRdbmsEntityProviderConfig
        Returns:
        the number of connections

      • getSchema

        public java.lang.String getSchema()
        schema to use when reading/writing RDBMS objects
        Returns:
        the schema

      • getJdbcUrl

        public java.lang.String getJdbcUrl()
        jdbc URL pointing to an RDBMS instance
        Returns:
        the JDBC URL

      • getUsername

        public java.lang.String getUsername()
        username to use when connecting to an RDBMS instance
        Returns:
        the username

      • getDataSourceId

        public java.lang.String getDataSourceId()
        data source id to use to connect to an RDBMS instance
        Returns:
        the data source id

      • getMaxPrefetchedRows

        public java.lang.Integer getMaxPrefetchedRows()
        maximum number of rows prefetched during each round trip resultset-database
        Returns:
        the maximum number of prefetched rows

      • getLabel

        public java.lang.String getLabel()
        label for the entities loaded from this provider
        Specified by:
        getLabel in class EntityProviderConfig
        Returns:
        the custom label

      • getFormat

        public ProviderFormat getFormat()
        provider format
        Returns:
        the format

      • getSourceVertexProvider

        public java.lang.String getSourceVertexProvider()
        name of the source vertex provider to be used for this edge provider
        Specified by:
        getSourceVertexProvider in class EntityProviderConfig
        Returns:
        the name of the source vertex provider

      • getDestinationVertexProvider

        public java.lang.String getDestinationVertexProvider()
        name of the destination vertex provider to be used for this edge provider
        Specified by:
        getDestinationVertexProvider in class EntityProviderConfig
        Returns:
        the name of the destination vertex provider

      • hasKeys

        public java.lang.Boolean hasKeys()
        indicates if the provided entities data have keys
        Specified by:
        hasKeys in class EntityProviderConfig

      • getErrorHandling

        public GraphErrorHandlingConfig getErrorHandling()
        error handling configuration
        Returns:
        the error handling configuration

      • getLocalDateFormat

        public java.util.List<java.lang.String> getLocalDateFormat()
        array of local_date formats to use when loading and storing local_date properties. Please see DateTimeFormatter for a documentation of the format string
        Returns:
        the date format

      • getTimeFormat

        public java.util.List<java.lang.String> getTimeFormat()
        the time format to use when loading and storing time properties. Please see DateTimeFormatter for a documentation of the format string
        Returns:
        the time format

      • getTimestampFormat

        public java.util.List<java.lang.String> getTimestampFormat()
        the timestamp format to use when loading and storing timestamp properties. Please see DateTimeFormatter for a documentation of the format string
        Returns:
        the timestamp format

      • getTimeWithTimezoneFormat

        public java.util.List<java.lang.String> getTimeWithTimezoneFormat()
        the time with timezone format to use when loading and storing time with timezone properties. Please see DateTimeFormatter for a documentation of the format string
        Returns:
        the time with timezone format

      • getTimestampWithTimezoneFormat

        public java.util.List<java.lang.String> getTimestampWithTimezoneFormat()
        the timestamp with timezone format to use when loading and storing timestamp with timezone properties. Please see DateTimeFormatter for a documentation of the format string
        Returns:
        the timestamp with timezone format

      • getVectorComponentDelimiter

        public java.lang.Character getVectorComponentDelimiter()
        delimiter for the different components of vector properties

      • getPoint2d

        public java.lang.String getPoint2d()
        longitude and latitude as floating point values separated by a space

      • getAttributes

        public java.util.Map getAttributes()
        additional attributes needed to read/write the graph data
        Returns:
        the map of attributes