oracle.pgx.config

Class PgRdbmsGraphConfig

java.lang.Object

oracle.pgx.config.AbstractConfig

oracle.pgx.config.GraphConfig

oracle.pgx.config.AbstractPgGraphConfig

oracle.pgx.config.PgRdbmsGraphConfig

All Implemented Interfaces:

CommonLoadableConfig<Format>, DbConnectionConfig, oracle.pgx.config.internal.ConvertibleToGraphConfigBuilder

@Generated(value="config_generator.py")
public class PgRdbmsGraphConfig
extends AbstractPgGraphConfig

PGX Engine PG RDBMS Graph Config

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PgRdbmsGraphConfig.Field Fields of PGX Engine PG RDBMS Graph Config

Field Summary

Fields inherited from class oracle.pgx.config.AbstractConfig

ENV_SEPARATOR, ENV_VARIABLE_PREFIX, SYSTEM_PROPERTY_PREFIX

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
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.
java.util.Map	getAttributes() additional attributes needed to read/write the graph data
static PgRdbmsGraphConfig.Field[]	getConfigFields()
java.lang.String	getDataSourceId() data source id to use to connect to an RDBMS instance
DbEngine	getDbEngine() underlying database engine
IdStrategy	getEdgeIdStrategy() Indicates what ID strategy should be used for the edges of this graph.
IdType	getEdgeIdType() type of the edge ID.
java.util.List<GraphPropertyConfig>	getEdgeProps() specification of edge properties associated with graph
java.lang.String	getEdgesViewName() the name of view for edges
GraphErrorHandlingConfig	getErrorHandling() error handling configuration
java.util.List<ExternalStoreConfig>	getExternalStores() Specification of the external stores where external string properties reside.
Format	getFormat() graph format
java.lang.String	getJdbcUrl() jdbc URL pointing to an RDBMS instance
java.lang.String	getKeystoreAlias() alias to the keystore to use when connecting to database
java.lang.String	getLabel() the label to use when reading the graph
java.util.Map<java.lang.String,java.lang.Object>	getLeftoverValues() Gets the values that do not belong to any field.
GraphLoadingConfig	getLoading() loading-specific configuration
java.util.List<java.lang.String>	getLocalDateFormat() array of local_date formats to use when loading and storing local_date properties.
java.lang.Integer	getMaxNumConnections() maximum number of database connections to use when reading the graph
java.lang.Integer	getMaxPrefetchedRows() maximum number of rows prefetched during each round trip resultset-database
java.lang.String	getName() prefix of the table name (for edge and vertex tables)
GraphOptimizedFor	getOptimizedFor() Indicates if the graph should use data-structures optimized for read-intensive scenarios or for fast updates
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.
java.lang.String	getOwner() owner (username) of graph in case it differs from given username
PartitionWhileLoading	getPartitionWhileLoading() Indicates if the graph should be partitioned while loading
java.lang.String	getPoint2d() longitude and latitude as floating point values separated by a space
java.lang.String	getRowLabel() the row label to use when reading the graph
java.lang.String	getSchema() schema to use when reading/writing RDBMS objects
java.lang.String	getSecurityPolicy() the policy for the given label or row label
java.util.List<java.lang.String>	getTimeFormat() the time format to use when loading and storing time properties.
java.util.List<java.lang.String>	getTimestampFormat() the timestamp format to use when loading and storing timestamp properties.
java.util.List<java.lang.String>	getTimestampWithTimezoneFormat() the timestamp with timezone format to use when loading and storing timestamp with timezone properties.
java.util.List<java.lang.String>	getTimeWithTimezoneFormat() the time with timezone format to use when loading and storing time with timezone properties.
java.lang.String	getUsername() username to use when connecting to an RDBMS instance
java.util.Map<PgRdbmsGraphConfig.Field,java.lang.Object>	getValues() Gets the parsed values.
java.util.Map<PgRdbmsGraphConfig.Field,java.lang.Object>	getValuesWithoutDefaults() Gets the values without defaults.
java.lang.Character	getVectorComponentDelimiter() delimiter for the different components of vector properties
IdStrategy	getVertexIdStrategy() Indicates what ID strategy should be used for the vertices of this graph.
IdType	getVertexIdType() type of the vertex ID.
java.util.List<GraphPropertyConfig>	getVertexProps() specification of vertex properties associated with graph
java.lang.String	getVerticesViewName() the name of view for vertices
java.lang.Integer	getViewParallelHintDegree() if view names are given, the resulting query will be hinted to run in parallel with the given degree.
boolean	hasDefaultValue(PgRdbmsGraphConfig.Field field) Checks for default value.
int	hashCode()
boolean	isEmpty() Checks if it's empty.
static PgRdbmsGraphConfig	parse(java.io.InputStream is, boolean strict, java.lang.String parentPath) Parses an input stream.
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.
static PgRdbmsGraphConfig	parse(java.util.Properties props, boolean strict) Parses a properties file.
PgRdbmsGraphConfigBuilder	toGraphConfigBuilder()
java.lang.String	toString()
java.lang.String	toString(boolean hideSensitiveData)

Methods inherited from class oracle.pgx.config.AbstractPgGraphConfig

getOraclePropertyGraph, setOraclePropertyGraph

Methods inherited from class oracle.pgx.config.GraphConfig

getEdgePropertyDefault, getEdgePropertyDimension, getEdgePropertyName, getEdgePropertyType, getEdgePropertyTypes, getLoadingOptions, getNodeKeyType, getNodePropertyDefault, getNodePropertyDimension, getNodePropertyName, getNodePropertyType, getValidatedEdgeIdStrategy, getValidatedEdgeIdType, getValidatedVertexIdStrategy, getValidatedVertexIdType, getVertexPropertyTypes, hasVerticesAndEdgesSeparatedFileFormat, hasVerticesAndEdgesSeparatedFileFormat, isEdgeLabelLoadingEnabled, isFileFormat, isFileFormat, isLoadEdgeKeys, isLoadVertexKeys, isMultipleFileFormat, isMultipleFileFormat, isSingleFileFormat, isSingleFileFormat, isVertexLabelsLoadingEnabled, numEdgeProperties, numNodeProperties, skipEdgeLoading, skipVertexLoading, supportsEdgeLabel, supportsEdgeLabel, supportsPropertyColumn, supportsPropertyColumn, supportsVectorProperties, supportsVectorProperties, supportsVertexLabels, supportsVertexLabels

Methods inherited from class oracle.pgx.config.AbstractConfig

getDefault, getValueFromEnvironment, getValueFromEnvironment, parseString, setSerializable

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.pgx.config.CommonLoadableConfig

createLocalDateFormat, createTimeFormat, createTimestampFormat, createTimestampWithTimezoneFormat, createTimeWithTimezoneFormat

Method Detail

equals

public boolean equals(java.lang.Object obj)

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

getAttributes

public java.util.Map getAttributes()

additional attributes needed to read/write the graph data

Returns:

the map of attributes

getConfigFields

public static PgRdbmsGraphConfig.Field[] getConfigFields()

getDataSourceId

public java.lang.String getDataSourceId()

data source id to use to connect to an RDBMS instance

Returns:

the data source id

getDbEngine

public DbEngine getDbEngine()

underlying database engine

Specified by:

getDbEngine in class AbstractPgGraphConfig

Returns:

the database engine

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

Returns:

the ID strategy used for the edges of the graph

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

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

getEdgesViewName

public java.lang.String getEdgesViewName()

the name of view for edges

Returns:

the name of view for edges

getErrorHandling

public GraphErrorHandlingConfig getErrorHandling()

error handling configuration

Returns:

the error handling configuration

getExternalStores

public java.util.List<ExternalStoreConfig> getExternalStores()

Specification of the external stores where external string properties reside.

Specified by:

getExternalStores in class GraphConfig

getFormat

public Format getFormat()

graph format

Returns:

the format

getJdbcUrl

public java.lang.String getJdbcUrl()

jdbc URL pointing to an RDBMS instance

Returns:

the JDBC URL

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

getLabel

public java.lang.String getLabel()

the label to use when reading the graph

Returns:

the label

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

getLoading

public GraphLoadingConfig getLoading()

loading-specific configuration

Specified by:

getLoading in class GraphConfig

Returns:

the loading 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

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

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

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

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

getOwner

public java.lang.String getOwner()

owner (username) of graph in case it differs from given username

Returns:

the owner

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

getPoint2d

public java.lang.String getPoint2d()

longitude and latitude as floating point values separated by a space

getRowLabel

public java.lang.String getRowLabel()

the row label to use when reading the graph

Returns:

the row label

getSecurityPolicy

public java.lang.String getSecurityPolicy()

the policy for the given label or row label

Returns:

the policy

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

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

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

getUsername

public java.lang.String getUsername()

username to use when connecting to an RDBMS instance

Returns:

the username

getValues

public java.util.Map<PgRdbmsGraphConfig.Field,java.lang.Object> getValues()

Gets the parsed values.

Specified by:

getValues in class AbstractConfig

Returns:

the parsed values

getValuesWithoutDefaults

public java.util.Map<PgRdbmsGraphConfig.Field,java.lang.Object> getValuesWithoutDefaults()

Gets the values without defaults.

Returns:

the values without defaults

getVectorComponentDelimiter

public java.lang.Character getVectorComponentDelimiter()

delimiter for the different components of vector properties

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

Returns:

the ID strategy used for the vertices of the graph

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

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

getVerticesViewName

public java.lang.String getVerticesViewName()

the name of view for vertices

Returns:

the name of view for vertices

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.

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

isEmpty

public boolean isEmpty()

Checks if it's empty.

Returns:

true, if the Map 'values' is empty.

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(boolean hideSensitiveData)

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

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractPgGraphConfig

toGraphConfigBuilder

public PgRdbmsGraphConfigBuilder toGraphConfigBuilder()

Specified by:

toGraphConfigBuilder in interface oracle.pgx.config.internal.ConvertibleToGraphConfigBuilder