Package oracle.pgx.config

Class PartitionedGraphConfig

    • Method Detail

      • parse

        public static PartitionedGraphConfig 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 PartitionedGraphConfig 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 PartitionedGraphConfig 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<PartitionedGraphConfig.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)

      • getName

        public java.lang.String getName()
        name of the graph
        Returns:
        the graph name

      • getQueries

        public java.util.List<java.lang.String> getQueries()
        A list of queries used to determine which data to load from the database. Data matching at least one of the queries will be loaded. Not setting any query will load the entire graph.

      • getPreparedQueries

        public java.util.List<PreparedQueryConfig> getPreparedQueries()
        An additional list of prepared queries with arguments, working in the same way as 'queries'. Data matching at least one those queries will also be loaded.

      • 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

      • 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 determined during loading or using a default value

      • 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 partitioned graphs, setting it to a specific type requires the IDs in the vertex providers to be unique across the graphs; those IDs will be used as global IDs; setting it to null (or omitting it) will allow repeated IDs across different vertex providers and PGX will automatically generate globally-unique 'partitioned' IDs for the vertices
        Specified by:
        getVertexIdType in class GraphConfig
        Returns:
        the vertex ID type

      • getEdgeIdType

        public IdType getEdgeIdType()
        type of the edge ID. For partitioned graphs, setting it to long requires the IDs in the edge providers to be unique across the graphs; those IDs will be used as global IDs; setting it to null (or omitting it) will allow repeated IDs across different edge providers and PGX will automatically generate globally-unique 'partitioned' IDs for the edges
        Overrides:
        getEdgeIdType in class GraphConfig
        Returns:
        the edge ID type

      • 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

      • getRedactionRules

        public java.util.List<oracle.pgx.config.PgxRedactionRuleConfig> getRedactionRules()
        array of redaction rules
        Specified by:
        getRedactionRules in class AbstractPartitionedGraphConfig
        Returns:
        the list of PgxRedactionRuleConfig

      • getRulesMapping

        public java.util.List<oracle.pgx.config.PgxRedactionRuleMappingConfig> getRulesMapping()
        mapping for redaction rules to users/roles
        Specified by:
        getRulesMapping in class AbstractPartitionedGraphConfig
        Returns:
        the list of PgxRedactionRuleMappingConfig

      • getSourceName

        public java.lang.String getSourceName()
        name of the database graph, if the graph is loaded from a database

      • getSourceType

        public SourceType getSourceType()
        source type for database graphs

      • getMaxBatchSize

        public java.lang.Integer getMaxBatchSize()
        maximal batch size of Elasticsearch response objects
        Returns:
        the maximum number of requested docs

      • getEsUrl

        public java.lang.String getEsUrl()
        Elasticsearch URL pointing to an Elasticsearch instance
        Returns:
        the Es URL

      • getEsIndexName

        public java.lang.String getEsIndexName()
        Index name on the Elasticsearch server form which graph data is loaded
        Returns:
        the Es Index

      • getProxyUrl

        public java.lang.String getProxyUrl()
        proxy server URL to be used for connection to es_url
        Returns:
        the proxy URL

      • getScrollTime

        public java.lang.String getScrollTime()
        time to keep Elasticsearch-scroll alive, batch data needs to be received and processed in that time window. Follows time unit format: [number][time unit] where time unit is d for day, h for hour m for minute etc.
        Returns:
        the Elasticsearch scroll time

      • getUsername

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

      • 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 AbstractPartitionedGraphConfig
        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

      • 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

      • 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