Package oracle.pgx.config

Class PgRdbmsGraphConfig

    • Method Detail

      • parse

        public static PgRdbmsGraphConfig 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 PgRdbmsGraphConfig 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 PgRdbmsGraphConfig 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.

      • hasDefaultValue

        public boolean hasDefaultValue​(PgRdbmsGraphConfig.Field field)
        Checks for default value.
        Parameters:
        field - the field
        Returns:
        true, if value for given field is the default value

      • getValuesWithoutDefaults

        public java.util.Map<PgRdbmsGraphConfig.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)

      • getOwner

        public java.lang.String getOwner()
        owner (username) of graph in case it differs from given username

      • getSecurityPolicy

        public java.lang.String getSecurityPolicy()
        the policy for the given label or row label

      • getLabel

        public java.lang.String getLabel()
        the label to use when reading the graph

      • getRowLabel

        public java.lang.String getRowLabel()
        the row label to use when reading the graph

      • getOptions

        public java.lang.String getOptions()
        a parameter that is used by the data access layer (and the underlying database) to change default behaviors of graph instance creation or initialization. Please refer to the data access layer documentation for possible configuration options

      • getVerticesViewName

        public java.lang.String getVerticesViewName()
        the name of view for vertices

      • getEdgesViewName

        public java.lang.String getEdgesViewName()
        the name of view for edges

      • getViewParallelHintDegree

        public java.lang.Integer getViewParallelHintDegree()
        if view names are given, the resulting query will be hinted to run in parallel with the given degree. If the value is negative, the parallel hint will be omitted. If the value is zero, a parallel hint without degree is generated.

      • 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

      • getName

        public java.lang.String getName()
        prefix of the table name (for edge and vertex tables)
        Returns:
        the graph name

      • getMaxNumConnections

        public java.lang.Integer getMaxNumConnections()
        maximum number of database connections to use when reading the graph
        Specified by:
        getMaxNumConnections in class AbstractPgGraphConfig
        Returns:
        the maximum number of connections

      • getOptimizedFor

        public GraphOptimizedFor getOptimizedFor()
        Indicates if the graph should use data-structures optimized for read-intensive scenarios or for fast updates
        Specified by:
        getOptimizedFor in class GraphConfig
        Returns:
        by_label if the graph should be partitioned during loading, false Indicates if the graph should use data-structures optimized for fast updates

      • getPartitionWhileLoading

        public PartitionWhileLoading getPartitionWhileLoading()
        Indicates if the graph should be partitioned while loading
        Specified by:
        getPartitionWhileLoading in class GraphConfig
        Returns:
        true if the graph should be heterogenized during loading, false or null otherwise

      • getVertexIdStrategy

        public IdStrategy getVertexIdStrategy()
        Indicates what ID strategy should be used for the vertices of this graph. If not specified (or set to null), the strategy will be automatically detected

      • getEdgeIdStrategy

        public IdStrategy getEdgeIdStrategy()
        Indicates what ID strategy should be used for the edges of this graph. If not specified (or set to null), the strategy will be determined during loading or using a default value

      • getVertexIdType

        public IdType getVertexIdType()
        type of the vertex ID. For homogeneous graphs, if not specified (or set to null), it will default to a specific value (depending on the origin of the data).
        Overrides:
        getVertexIdType in class AbstractPgGraphConfig
        Returns:
        the vertex ID type

      • getEdgeIdType

        public IdType getEdgeIdType()
        type of the edge ID. For homogeneous graphs, if not specified (or set to null), it will default to long.
        Overrides:
        getEdgeIdType in class GraphConfig
        Returns:
        the edge ID type

      • getFormat

        public Format getFormat()
        graph format
        Returns:
        the format

      • getArrayCompactionThreshold

        public java.lang.Double getArrayCompactionThreshold()
        [only relevant if the graph is optimized for updates] threshold used to determined when to compact the delta-logs into a new array. If lower than the engine min_array_compaction_threshold value, min_array_compaction_threshold will be used instead
        Specified by:
        getArrayCompactionThreshold in class GraphConfig
        Returns:
        the compaction threshold

      • getVertexProps

        public java.util.List<GraphPropertyConfig> getVertexProps()
        specification of vertex properties associated with graph
        Specified by:
        getVertexProps in class GraphConfig
        Returns:
        the list of vertex properties

      • getEdgeProps

        public java.util.List<GraphPropertyConfig> getEdgeProps()
        specification of edge properties associated with graph
        Specified by:
        getEdgeProps in class GraphConfig
        Returns:
        the list of vertex properties

      • 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

      • getKeystoreAlias

        public java.lang.String getKeystoreAlias()
        alias to the keystore to use when connecting to database
        Returns:
        the keystore alias or null if underlying format does not require a keystore

      • equals

        public boolean equals​(java.lang.Object obj)

      • toGraphConfigBuilder

        public PgRdbmsGraphConfigBuilder toGraphConfigBuilder()
        Specified by:
        toGraphConfigBuilder in interface oracle.pgx.config.internal.ConvertibleToGraphConfigBuilder

      • getSchema

        public final java.lang.String getSchema()
        Description copied from interface: DbConnectionConfig
        schema to use when reading/writing RDBMS objects
        Specified by:
        getSchema in interface DbConnectionConfig
        Returns:
        the schema