oracle.pgx.config

Class TwoTablesRdbmsGraphConfig

java.lang.Object

oracle.pgx.config.AbstractConfig

oracle.pgx.config.GraphConfig

oracle.pgx.config.AbstractTwoTablesRdbmsGraphConfig

oracle.pgx.config.TwoTablesRdbmsGraphConfig

All Implemented Interfaces:

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

@Generated(value="config_generator.py")
public class TwoTablesRdbmsGraphConfig
extends AbstractTwoTablesRdbmsGraphConfig

PGX Engine Two Tables Rdbms Graph Config

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TwoTablesRdbmsGraphConfig.Field Fields of PGX Engine Two Tables 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 TwoTablesRdbmsGraphConfig.Field[]	getConfigFields()
java.lang.String	getDataSourceId() the data source id to use to connect to database
TwoTablesDatastore	getDatastore() underlying datastore
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	getEdgesKeyColumn() name of primary key column in edges table
java.lang.String	getEdgesLabelColumn() column name for edge label
java.lang.String	getEdgesTableName() name of edges table
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	getFromNidColumn() column name for source node
java.lang.Integer	getInsertBatchSize() batch size of the rows to be inserted
java.lang.String	getJdbcUrl() jdbc URL pointing to database
java.lang.String	getKeystoreAlias() alias to the keystore to use when connecting to database
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	getMaxPrefetchedRows() maximun number or rows prefetched during each round trip (resultset-the database)
java.lang.String	getNodesKeyColumn() name of primary key column in nodes table
java.lang.String	getNodesLabelColumn() column name for node label
java.lang.String	getNodesTableName() name of nodes table
java.lang.Integer	getNumConnections() number of connections to read/write data from/to two tables
GraphOptimizedFor	getOptimizedFor() Indicates if the graph should use data-structures optimized for read-intensive scenarios or for fast updates
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	getSchema() schema where the tables are going to be written
java.lang.String	getTablespace() tablespace where the tables are going to be written
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	getToNidColumn() column name for destination node
java.lang.String	getUsername() username to use when connecting to database
java.util.Map<TwoTablesRdbmsGraphConfig.Field,java.lang.Object>	getValues() Gets the parsed values.
java.util.Map<TwoTablesRdbmsGraphConfig.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
boolean	hasDefaultValue(TwoTablesRdbmsGraphConfig.Field field) Checks for default value.
boolean	isEmpty() Checks if it's empty.
static TwoTablesRdbmsGraphConfig	parse(java.io.InputStream is, boolean strict, java.lang.String parentPath) Parses an input stream.
static TwoTablesRdbmsGraphConfig	parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath) Parses a raw key/value mapping.
static TwoTablesRdbmsGraphConfig	parse(java.util.Properties props, boolean strict) Parses a properties file.
java.lang.String	toString()
java.lang.String	toString(boolean hideSensitiveData)

Methods inherited from class oracle.pgx.config.AbstractTwoTablesRdbmsGraphConfig

getLabelValueDelimiter, getName, hasEdgeKeys, hasEdgesTable, hashCode, hasNodesTable, skipEdgeLoading, skipVertexLoading, supportsVectorProperties, toGraphConfigBuilder

Methods inherited from class oracle.pgx.config.GraphConfig

getEdgePropertyDefault, getEdgePropertyDimension, getEdgePropertyName, getEdgePropertyType, getEdgePropertyTypes, getLoadingFilter, 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, supportsEdgeLabel, supportsEdgeLabel, supportsPropertyColumn, supportsPropertyColumn, 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)

Overrides:

equals in class java.lang.Object

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 TwoTablesRdbmsGraphConfig.Field[] getConfigFields()

getDataSourceId

public java.lang.String getDataSourceId()

the data source id to use to connect to database

Specified by:

getDataSourceId in class AbstractTwoTablesRdbmsGraphConfig

getDatastore

public TwoTablesDatastore getDatastore()

underlying datastore

Returns:

the datastore

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

getEdgesKeyColumn

public java.lang.String getEdgesKeyColumn()

name of primary key column in edges table

getEdgesLabelColumn

public java.lang.String getEdgesLabelColumn()

column name for edge label

getEdgesTableName

public java.lang.String getEdgesTableName()

name of edges table

Specified by:

getEdgesTableName in class AbstractTwoTablesRdbmsGraphConfig

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

getFromNidColumn

public java.lang.String getFromNidColumn()

column name for source node

getInsertBatchSize

public java.lang.Integer getInsertBatchSize()

batch size of the rows to be inserted

getJdbcUrl

public java.lang.String getJdbcUrl()

jdbc URL pointing to database

Specified by:

getJdbcUrl in class AbstractTwoTablesRdbmsGraphConfig

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

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

getMaxPrefetchedRows

public java.lang.Integer getMaxPrefetchedRows()

maximun number or rows prefetched during each round trip (resultset-the database)

getNodesKeyColumn

public java.lang.String getNodesKeyColumn()

name of primary key column in nodes table

getNodesLabelColumn

public java.lang.String getNodesLabelColumn()

column name for node label

getNodesTableName

public java.lang.String getNodesTableName()

name of nodes table

Specified by:

getNodesTableName in class AbstractTwoTablesRdbmsGraphConfig

getNumConnections

public java.lang.Integer getNumConnections()

number of connections to read/write data from/to two tables

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

getPoint2d

public java.lang.String getPoint2d()

longitude and latitude as floating point values separated by a space

getSchema

public java.lang.String getSchema()

schema where the tables are going to be written

Specified by:

getSchema in class AbstractTwoTablesRdbmsGraphConfig

getTablespace

public java.lang.String getTablespace()

tablespace where the tables are going to be written

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

getToNidColumn

public java.lang.String getToNidColumn()

column name for destination node

getUsername

public java.lang.String getUsername()

username to use when connecting to database

Specified by:

getUsername in class AbstractTwoTablesRdbmsGraphConfig

getValues

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

Gets the parsed values.

Returns:

the parsed values

getValuesWithoutDefaults

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

Specified by:

getVertexIdType in class GraphConfig

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

hasDefaultValue

public boolean hasDefaultValue(TwoTablesRdbmsGraphConfig.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 TwoTablesRdbmsGraphConfig 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 TwoTablesRdbmsGraphConfig 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 TwoTablesRdbmsGraphConfig 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)