Package oracle.pgx.config
Enum TwoTablesRdbmsGraphConfig.Field
- java.lang.Object
-
- java.lang.Enum<TwoTablesRdbmsGraphConfig.Field>
-
- oracle.pgx.config.TwoTablesRdbmsGraphConfig.Field
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<TwoTablesRdbmsGraphConfig.Field>
,ConfigField
- Enclosing class:
- TwoTablesRdbmsGraphConfig
public static enum TwoTablesRdbmsGraphConfig.Field extends java.lang.Enum<TwoTablesRdbmsGraphConfig.Field> implements ConfigField
Fields of PGX Engine Two Tables Rdbms Graph Config
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ARRAY_COMPACTION_THRESHOLD
[only relevant if the graph is optimized for updates] threshold used to determined when to compact the delta-logs into a new array.ATTRIBUTES
additional attributes needed to read/write the graph dataDATA_SOURCE_ID
data source id to use to connect to an RDBMS instanceDATASTORE
underlying datastoreEDGE_ID_STRATEGY
Indicates what ID strategy should be used for the edges of this graph.EDGE_ID_TYPE
type of the edge ID.EDGE_PROPS
specification of edge properties associated with graphEDGES_KEY_COLUMN
name of primary key column in edges tableEDGES_LABEL_COLUMN
column name for edge labelEDGES_TABLE_NAME
name of edges tableERROR_HANDLING
error handling configurationEXTERNAL_STORES
Specification of the external stores where external string properties reside.FORMAT
graph formatFROM_NID_COLUMN
column name for source nodeINSERT_BATCH_SIZE
batch size of the rows to be insertedJDBC_URL
jdbc URL pointing to an RDBMS instanceKEYSTORE_ALIAS
alias to the keystore to use when connecting to databaseLOADING
loading-specific configurationLOCAL_DATE_FORMAT
array of local_date formats to use when loading and storing local_date properties.MAX_PREFETCHED_ROWS
maximum number of rows prefetched during each round trip resultset-databaseNODES_KEY_COLUMN
name of primary key column in nodes tableNODES_LABEL_COLUMN
column name for node labelNODES_TABLE_NAME
name of nodes tableNUM_CONNECTIONS
number of connections to read/write data from/to the RDBMS table.OPTIMIZED_FOR
Indicates if the graph should use data-structures optimized for read-intensive scenarios or for fast updatesPARTITION_WHILE_LOADING
Indicates if the graph should be partitioned while loadingPASSWORD
password to use when connecting to databasePOINT2D
longitude and latitude as floating point values separated by a spaceSCHEMA
schema to use when reading/writing RDBMS objectsTABLESPACE
tablespace where the tables are going to be writtenTIME_FORMAT
the time format to use when loading and storing time properties.TIME_WITH_TIMEZONE_FORMAT
the time with timezone format to use when loading and storing time with timezone properties.TIMESTAMP_FORMAT
the timestamp format to use when loading and storing timestamp properties.TIMESTAMP_WITH_TIMEZONE_FORMAT
the timestamp with timezone format to use when loading and storing timestamp with timezone properties.TO_NID_COLUMN
column name for destination nodeUSERNAME
username to use when connecting to an RDBMS instanceVECTOR_COMPONENT_DELIMITER
delimiter for the different components of vector propertiesVERTEX_ID_STRATEGY
Indicates what ID strategy should be used for the vertices of this graph.VERTEX_ID_TYPE
type of the vertex ID.VERTEX_PROPS
specification of vertex properties associated with graph
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
getDefaultVal()
Gets the default value of this field.java.util.List<java.lang.String>
getKeyAliases()
Gets the key aliases of this field which are also recognized during parsing.java.util.List<java.lang.String>
getSingletonListKeyAliases()
Gets the key aliases of this field which contain single values for lists and are also recognized during parsing.java.lang.Class<?>
getType()
Gets the type of this field.boolean
isArray()
Checks if this field is an array.boolean
isHidden()
Checks if this field should be hidden.boolean
isPath()
Checks if this field is a path.boolean
isRequired()
Checks if this field is required.boolean
isSensitive()
Checks if this field holds a sensitive data.java.lang.String
toKey()
Get the key of this field, which is how this field is represented in serialized form.java.lang.String
toString()
static TwoTablesRdbmsGraphConfig.Field
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static TwoTablesRdbmsGraphConfig.Field[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.-
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf
-
Methods inherited from interface oracle.pgx.config.ConfigField
isEnum, isPrimitive
-
-
-
-
Enum Constant Detail
-
NODES_TABLE_NAME
public static final TwoTablesRdbmsGraphConfig.Field NODES_TABLE_NAME
name of nodes table
-
EDGES_TABLE_NAME
public static final TwoTablesRdbmsGraphConfig.Field EDGES_TABLE_NAME
name of edges table
-
TABLESPACE
public static final TwoTablesRdbmsGraphConfig.Field TABLESPACE
tablespace where the tables are going to be written
-
INSERT_BATCH_SIZE
public static final TwoTablesRdbmsGraphConfig.Field INSERT_BATCH_SIZE
batch size of the rows to be inserted
-
NUM_CONNECTIONS
public static final TwoTablesRdbmsGraphConfig.Field NUM_CONNECTIONS
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
-
SCHEMA
public static final TwoTablesRdbmsGraphConfig.Field SCHEMA
schema to use when reading/writing RDBMS objects
-
JDBC_URL
public static final TwoTablesRdbmsGraphConfig.Field JDBC_URL
jdbc URL pointing to an RDBMS instance
-
USERNAME
public static final TwoTablesRdbmsGraphConfig.Field USERNAME
username to use when connecting to an RDBMS instance
-
DATA_SOURCE_ID
public static final TwoTablesRdbmsGraphConfig.Field DATA_SOURCE_ID
data source id to use to connect to an RDBMS instance
-
MAX_PREFETCHED_ROWS
public static final TwoTablesRdbmsGraphConfig.Field MAX_PREFETCHED_ROWS
maximum number of rows prefetched during each round trip resultset-database
-
DATASTORE
public static final TwoTablesRdbmsGraphConfig.Field DATASTORE
underlying datastore
-
NODES_KEY_COLUMN
public static final TwoTablesRdbmsGraphConfig.Field NODES_KEY_COLUMN
name of primary key column in nodes table
-
EDGES_KEY_COLUMN
public static final TwoTablesRdbmsGraphConfig.Field EDGES_KEY_COLUMN
name of primary key column in edges table
-
FROM_NID_COLUMN
public static final TwoTablesRdbmsGraphConfig.Field FROM_NID_COLUMN
column name for source node
-
TO_NID_COLUMN
public static final TwoTablesRdbmsGraphConfig.Field TO_NID_COLUMN
column name for destination node
-
NODES_LABEL_COLUMN
public static final TwoTablesRdbmsGraphConfig.Field NODES_LABEL_COLUMN
column name for node label
-
EDGES_LABEL_COLUMN
public static final TwoTablesRdbmsGraphConfig.Field EDGES_LABEL_COLUMN
column name for edge label
-
OPTIMIZED_FOR
public static final TwoTablesRdbmsGraphConfig.Field OPTIMIZED_FOR
Indicates if the graph should use data-structures optimized for read-intensive scenarios or for fast updates
-
PARTITION_WHILE_LOADING
public static final TwoTablesRdbmsGraphConfig.Field PARTITION_WHILE_LOADING
Indicates if the graph should be partitioned while loading
-
VERTEX_ID_STRATEGY
public static final TwoTablesRdbmsGraphConfig.Field VERTEX_ID_STRATEGY
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
-
EDGE_ID_STRATEGY
public static final TwoTablesRdbmsGraphConfig.Field EDGE_ID_STRATEGY
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
-
VERTEX_ID_TYPE
public static final TwoTablesRdbmsGraphConfig.Field VERTEX_ID_TYPE
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).
-
EDGE_ID_TYPE
public static final TwoTablesRdbmsGraphConfig.Field EDGE_ID_TYPE
type of the edge ID. For homogeneous graphs, if not specified (or set to null), it will default to long.
-
FORMAT
public static final TwoTablesRdbmsGraphConfig.Field FORMAT
graph format
-
ARRAY_COMPACTION_THRESHOLD
public static final TwoTablesRdbmsGraphConfig.Field ARRAY_COMPACTION_THRESHOLD
[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
-
VERTEX_PROPS
public static final TwoTablesRdbmsGraphConfig.Field VERTEX_PROPS
specification of vertex properties associated with graph
-
EDGE_PROPS
public static final TwoTablesRdbmsGraphConfig.Field EDGE_PROPS
specification of edge properties associated with graph
-
LOADING
public static final TwoTablesRdbmsGraphConfig.Field LOADING
loading-specific configuration
-
EXTERNAL_STORES
public static final TwoTablesRdbmsGraphConfig.Field EXTERNAL_STORES
Specification of the external stores where external string properties reside.
-
ERROR_HANDLING
public static final TwoTablesRdbmsGraphConfig.Field ERROR_HANDLING
error handling configuration
-
LOCAL_DATE_FORMAT
public static final TwoTablesRdbmsGraphConfig.Field LOCAL_DATE_FORMAT
array of local_date formats to use when loading and storing local_date properties. Please see DateTimeFormatter for a documentation of the format string
-
TIME_FORMAT
public static final TwoTablesRdbmsGraphConfig.Field TIME_FORMAT
the time format to use when loading and storing time properties. Please see DateTimeFormatter for a documentation of the format string
-
TIMESTAMP_FORMAT
public static final TwoTablesRdbmsGraphConfig.Field TIMESTAMP_FORMAT
the timestamp format to use when loading and storing timestamp properties. Please see DateTimeFormatter for a documentation of the format string
-
TIME_WITH_TIMEZONE_FORMAT
public static final TwoTablesRdbmsGraphConfig.Field TIME_WITH_TIMEZONE_FORMAT
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
-
TIMESTAMP_WITH_TIMEZONE_FORMAT
public static final TwoTablesRdbmsGraphConfig.Field TIMESTAMP_WITH_TIMEZONE_FORMAT
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
-
VECTOR_COMPONENT_DELIMITER
public static final TwoTablesRdbmsGraphConfig.Field VECTOR_COMPONENT_DELIMITER
delimiter for the different components of vector properties
-
POINT2D
public static final TwoTablesRdbmsGraphConfig.Field POINT2D
longitude and latitude as floating point values separated by a space
-
ATTRIBUTES
public static final TwoTablesRdbmsGraphConfig.Field ATTRIBUTES
additional attributes needed to read/write the graph data
-
PASSWORD
public static final TwoTablesRdbmsGraphConfig.Field PASSWORD
password to use when connecting to database
-
KEYSTORE_ALIAS
public static final TwoTablesRdbmsGraphConfig.Field KEYSTORE_ALIAS
alias to the keystore to use when connecting to database
-
-
Method Detail
-
values
public static TwoTablesRdbmsGraphConfig.Field[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (TwoTablesRdbmsGraphConfig.Field c : TwoTablesRdbmsGraphConfig.Field.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static TwoTablesRdbmsGraphConfig.Field valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
getKeyAliases
public java.util.List<java.lang.String> getKeyAliases()
Description copied from interface:ConfigField
Gets the key aliases of this field which are also recognized during parsing.- Specified by:
getKeyAliases
in interfaceConfigField
- Returns:
- the key aliases
-
getSingletonListKeyAliases
public java.util.List<java.lang.String> getSingletonListKeyAliases()
Description copied from interface:ConfigField
Gets the key aliases of this field which contain single values for lists and are also recognized during parsing.- Specified by:
getSingletonListKeyAliases
in interfaceConfigField
- Returns:
- the singleton list key aliases
-
getType
public java.lang.Class<?> getType()
Description copied from interface:ConfigField
Gets the type of this field.- Specified by:
getType
in interfaceConfigField
- Returns:
- the type
-
isRequired
public boolean isRequired()
Description copied from interface:ConfigField
Checks if this field is required.- Specified by:
isRequired
in interfaceConfigField
- Returns:
- true, if required
-
isArray
public boolean isArray()
Description copied from interface:ConfigField
Checks if this field is an array.- Specified by:
isArray
in interfaceConfigField
- Returns:
- true, if array
-
isPath
public boolean isPath()
Description copied from interface:ConfigField
Checks if this field is a path.- Specified by:
isPath
in interfaceConfigField
- Returns:
- true, if path
-
getDefaultVal
public java.lang.Object getDefaultVal()
Description copied from interface:ConfigField
Gets the default value of this field.- Specified by:
getDefaultVal
in interfaceConfigField
- Returns:
- the default value
-
toKey
public java.lang.String toKey()
Description copied from interface:ConfigField
Get the key of this field, which is how this field is represented in serialized form.- Specified by:
toKey
in interfaceConfigField
- Returns:
- the key.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Enum<TwoTablesRdbmsGraphConfig.Field>
-
isSensitive
public boolean isSensitive()
Description copied from interface:ConfigField
Checks if this field holds a sensitive data.- Specified by:
isSensitive
in interfaceConfigField
- Returns:
- true, if use for sensitive data
-
isHidden
public boolean isHidden()
Description copied from interface:ConfigField
Checks if this field should be hidden. Hidden fields are used to hid desired field from the user and only allow it for internal usage.- Specified by:
isHidden
in interfaceConfigField
- Returns:
- true if field should be hidden, false otherwise
-
-