Package oracle.pgx.config
Class PgNosqlGraphConfig
- java.lang.Object
-
- oracle.pgx.config.AbstractConfig
-
- oracle.pgx.config.GraphConfig
-
- oracle.pgx.config.AbstractPgGraphConfig
-
- oracle.pgx.config.PgNosqlGraphConfig
-
- All Implemented Interfaces:
CommonLoadableConfig<Format>
,oracle.pgx.config.internal.ConvertibleToGraphConfigBuilder
@Generated("config_generator.py") public class PgNosqlGraphConfig extends AbstractPgGraphConfig
PGX Engine PG NoSQL Graph Config
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PgNosqlGraphConfig.Field
Fields of PGX Engine PG NoSQL Graph Config
-
Field Summary
-
Fields inherited from class oracle.pgx.config.AbstractConfig
ENV_SEPARATOR, ENV_VARIABLE_PREFIX, SYSTEM_PROPERTY_PREFIX
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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 datastatic PgNosqlGraphConfig.Field[]
getConfigFields()
DbEngine
getDbEngine()
underlying database engineIdStrategy
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 graphGraphErrorHandlingConfig
getErrorHandling()
error handling configurationjava.util.List<ExternalStoreConfig>
getExternalStores()
Specification of the external stores where external string properties reside.Format
getFormat()
graph formatjava.util.List<java.lang.String>
getHosts()
list of NoSQL hostsjava.lang.String
getKeystoreAlias()
alias to the keystore to use when connecting to databasejava.util.Map<java.lang.String,java.lang.Object>
getLeftoverValues()
Gets the values that do not belong to any field.GraphLoadingConfig
getLoading()
loading-specific configurationjava.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 graphjava.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 updatesPartitionWhileLoading
getPartitionWhileLoading()
Indicates if the graph should be partitioned while loadingjava.lang.String
getPoint2d()
longitude and latitude as floating point values separated by a spacejava.lang.Integer
getRequestTimeoutMs()
NoSQL request timeout in millisecondsjava.lang.String
getStoreName()
NoSQL store namejava.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()
name of a NoSQL userjava.util.Map<PgNosqlGraphConfig.Field,java.lang.Object>
getValues()
Gets the parsed values.java.util.Map<PgNosqlGraphConfig.Field,java.lang.Object>
getValuesWithoutDefaults()
Gets the values without defaults.java.lang.Character
getVectorComponentDelimiter()
delimiter for the different components of vector propertiesIdStrategy
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 graphboolean
hasDefaultValue(PgNosqlGraphConfig.Field field)
Checks for default value.int
hashCode()
boolean
isEmpty()
Checks if it's empty.static PgNosqlGraphConfig
parse(java.io.InputStream is, boolean strict, java.lang.String parentPath)
Parses an input stream.static PgNosqlGraphConfig
parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath)
Parses a raw key/value mapping.static PgNosqlGraphConfig
parse(java.util.Properties props, boolean strict)
Parses a properties file.PgNosqlGraphConfigBuilder
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 interface oracle.pgx.config.CommonLoadableConfig
createLocalDateFormat, createTimeFormat, createTimestampFormat, createTimestampWithTimezoneFormat, createTimeWithTimezoneFormat
-
-
-
-
Method Detail
-
parse
public static PgNosqlGraphConfig parse(java.io.InputStream is, boolean strict, java.lang.String parentPath) throws java.io.IOException
Parses an input stream.- Parameters:
is
- the input streamstrict
- if true, parses in strict modeparentPath
- 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 PgNosqlGraphConfig 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 parsestrict
- if true, parses in strict modeparentPath
- if not null, resolves relative paths against this parentPath- Returns:
- the parsed graph config
-
parse
public static PgNosqlGraphConfig parse(java.util.Properties props, boolean strict)
Parses a properties file.- Parameters:
props
- the properties to parsestrict
- if true, parses in strict mode- Returns:
- the parsed graph config
-
getConfigFields
public static PgNosqlGraphConfig.Field[] getConfigFields()
-
getValues
public java.util.Map<PgNosqlGraphConfig.Field,java.lang.Object> getValues()
Gets the parsed values.- Specified by:
getValues
in classAbstractConfig
- Returns:
- the parsed values
-
isEmpty
public boolean isEmpty()
Checks if it's empty.- Returns:
- true, if the Map 'values' is empty.
-
hasDefaultValue
public boolean hasDefaultValue(PgNosqlGraphConfig.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<PgNosqlGraphConfig.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 classjava.lang.Object
-
toString
public java.lang.String toString(boolean hideSensitiveData)
-
getHosts
public java.util.List<java.lang.String> getHosts()
list of NoSQL hosts
-
getStoreName
public java.lang.String getStoreName()
NoSQL store name
-
getRequestTimeoutMs
public java.lang.Integer getRequestTimeoutMs()
NoSQL request timeout in milliseconds
-
getUsername
public java.lang.String getUsername()
name of a NoSQL user
-
getDbEngine
public DbEngine getDbEngine()
underlying database engine- Specified by:
getDbEngine
in classAbstractPgGraphConfig
- Returns:
- the database engine
-
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 classAbstractPgGraphConfig
- 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 classGraphConfig
- 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 classGraphConfig
- Returns:
true
if the graph should be heterogenized during loading,false
ornull
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 classAbstractPgGraphConfig
- 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 classGraphConfig
- 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 classGraphConfig
- Returns:
- the compaction threshold
-
getVertexProps
public java.util.List<GraphPropertyConfig> getVertexProps()
specification of vertex properties associated with graph- Specified by:
getVertexProps
in classGraphConfig
- Returns:
- the list of vertex properties
-
getEdgeProps
public java.util.List<GraphPropertyConfig> getEdgeProps()
specification of edge properties associated with graph- Specified by:
getEdgeProps
in classGraphConfig
- Returns:
- the list of vertex properties
-
getLoading
public GraphLoadingConfig getLoading()
loading-specific configuration
-
getExternalStores
public java.util.List<ExternalStoreConfig> getExternalStores()
Specification of the external stores where external string properties reside.- Specified by:
getExternalStores
in classGraphConfig
-
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 PgNosqlGraphConfigBuilder toGraphConfigBuilder()
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classAbstractPgGraphConfig
-
-