PgRdbmsGraphConfig.Field (Oracle Graph Java API Reference Release 20.3 (F15858-03))

java.lang.Object
- java.lang.Enum<PgRdbmsGraphConfig.Field>
- - oracle.pgx.config.PgRdbmsGraphConfig.Field

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PgRdbmsGraphConfig.Field>, ConfigField

Enclosing class:

PgRdbmsGraphConfig
```
public static enum PgRdbmsGraphConfig.Field
extends java.lang.Enum<PgRdbmsGraphConfig.Field>
implements ConfigField
```
Fields of PGX Engine PG RDBMS Graph Config

Enum Constant Summary

Enum Constants
Enum Constant and 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 data
`DATA_SOURCE_ID` the data source id to use to connect to database
`DB_ENGINE` underlying database engine
`EDGE_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 graph
`EDGES_VIEW_NAME` the name of view for edges
`ERROR_HANDLING` error handling configuration
`EXTERNAL_STORES` Specification of the external stores where external string properties reside.
`FORMAT` graph format
`JDBC_URL` jdbc URL pointing to database
`KEYSTORE_ALIAS` alias to the keystore to use when connecting to database
`LABEL` the label to use when reading the graph
`LOADING` loading-specific configuration
`LOCAL_DATE_FORMAT` array of local_date formats to use when loading and storing local_date properties.
`MAX_NUM_CONNECTIONS` maximum number of database connections to use when reading the graph
`NAME` prefix of the table name (for edge and vertex tables)
`OPTIMIZED_FOR` Indicates if the graph should use data-structures optimized for read-intensive scenarios or for fast updates
`OPTIONS` a parameter that is used by the data access layer (and the underlying database) to change default behaviors of graph instance creation or initialization.
`OWNER` owner (username) of graph in case it differs from given username
`PARTITION_WHILE_LOADING` Indicates if the graph should be partitioned while loading
`PASSWORD` password to use when connecting to database
`POINT2D` longitude and latitude as floating point values separated by a space
`ROW_LABEL` the row label to use when reading the graph
`SECURITY_POLICY` the policy for the given label or row label
`TIME_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.
`USERNAME` username to use when connecting to database
`VECTOR_COMPONENT_DELIMITER` delimiter for the different components of vector properties
`VERTEX_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
`VERTICES_VIEW_NAME` the name of view for vertices
`VIEW_PARALLEL_HINT_DEGREE` if view names are given, the resulting query will be hinted to run in parallel with the given degree.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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 PgRdbmsGraphConfig.Field`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static PgRdbmsGraphConfig.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 class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.pgx.config.ConfigField
isEnum, isPrimitive

- Enum Constant Detail
  - ARRAY_COMPACTION_THRESHOLD
```
public static final PgRdbmsGraphConfig.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
  - ATTRIBUTES
```
public static final PgRdbmsGraphConfig.Field ATTRIBUTES
```
    additional attributes needed to read/write the graph data
  - DATA_SOURCE_ID
```
public static final PgRdbmsGraphConfig.Field DATA_SOURCE_ID
```
    the data source id to use to connect to database
  - DB_ENGINE
```
public static final PgRdbmsGraphConfig.Field DB_ENGINE
```
    underlying database engine
  - EDGE_ID_STRATEGY
```
public static final PgRdbmsGraphConfig.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
  - EDGE_ID_TYPE
```
public static final PgRdbmsGraphConfig.Field EDGE_ID_TYPE
```
    type of the edge ID. For homogeneous graphs, if not specified (or set to null), it will default to long.
  - EDGE_PROPS
```
public static final PgRdbmsGraphConfig.Field EDGE_PROPS
```
    specification of edge properties associated with graph
  - EDGES_VIEW_NAME
```
public static final PgRdbmsGraphConfig.Field EDGES_VIEW_NAME
```
    the name of view for edges
  - ERROR_HANDLING
```
public static final PgRdbmsGraphConfig.Field ERROR_HANDLING
```
    error handling configuration
  - EXTERNAL_STORES
```
public static final PgRdbmsGraphConfig.Field EXTERNAL_STORES
```
    Specification of the external stores where external string properties reside.
  - FORMAT
```
public static final PgRdbmsGraphConfig.Field FORMAT
```
    graph format
  - JDBC_URL
```
public static final PgRdbmsGraphConfig.Field JDBC_URL
```
    jdbc URL pointing to database
  - KEYSTORE_ALIAS
```
public static final PgRdbmsGraphConfig.Field KEYSTORE_ALIAS
```
    alias to the keystore to use when connecting to database
  - LABEL
```
public static final PgRdbmsGraphConfig.Field LABEL
```
    the label to use when reading the graph
  - LOADING
```
public static final PgRdbmsGraphConfig.Field LOADING
```
    loading-specific configuration
  - LOCAL_DATE_FORMAT
```
public static final PgRdbmsGraphConfig.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
  - MAX_NUM_CONNECTIONS
```
public static final PgRdbmsGraphConfig.Field MAX_NUM_CONNECTIONS
```
    maximum number of database connections to use when reading the graph
  - NAME
```
public static final PgRdbmsGraphConfig.Field NAME
```
    prefix of the table name (for edge and vertex tables)
  - OPTIMIZED_FOR
```
public static final PgRdbmsGraphConfig.Field OPTIMIZED_FOR
```
    Indicates if the graph should use data-structures optimized for read-intensive scenarios or for fast updates
  - OPTIONS
```
public static final PgRdbmsGraphConfig.Field OPTIONS
```
    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
  - OWNER
```
public static final PgRdbmsGraphConfig.Field OWNER
```
    owner (username) of graph in case it differs from given username
  - PARTITION_WHILE_LOADING
```
public static final PgRdbmsGraphConfig.Field PARTITION_WHILE_LOADING
```
    Indicates if the graph should be partitioned while loading
  - PASSWORD
```
public static final PgRdbmsGraphConfig.Field PASSWORD
```
    password to use when connecting to database
  - POINT2D
```
public static final PgRdbmsGraphConfig.Field POINT2D
```
    longitude and latitude as floating point values separated by a space
  - ROW_LABEL
```
public static final PgRdbmsGraphConfig.Field ROW_LABEL
```
    the row label to use when reading the graph
  - SECURITY_POLICY
```
public static final PgRdbmsGraphConfig.Field SECURITY_POLICY
```
    the policy for the given label or row label
  - TIME_FORMAT
```
public static final PgRdbmsGraphConfig.Field TIME_FORMAT
```
    the time format to use when loading and storing time properties. Please see DateTimeFormatter for a documentation of the format string
  - TIME_WITH_TIMEZONE_FORMAT
```
public static final PgRdbmsGraphConfig.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_FORMAT
```
public static final PgRdbmsGraphConfig.Field TIMESTAMP_FORMAT
```
    the timestamp format to use when loading and storing timestamp properties. Please see DateTimeFormatter for a documentation of the format string
  - TIMESTAMP_WITH_TIMEZONE_FORMAT
```
public static final PgRdbmsGraphConfig.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
  - USERNAME
```
public static final PgRdbmsGraphConfig.Field USERNAME
```
    username to use when connecting to database
  - VECTOR_COMPONENT_DELIMITER
```
public static final PgRdbmsGraphConfig.Field VECTOR_COMPONENT_DELIMITER
```
    delimiter for the different components of vector properties
  - VERTEX_ID_STRATEGY
```
public static final PgRdbmsGraphConfig.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
  - VERTEX_ID_TYPE
```
public static final PgRdbmsGraphConfig.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).
  - VERTEX_PROPS
```
public static final PgRdbmsGraphConfig.Field VERTEX_PROPS
```
    specification of vertex properties associated with graph
  - VERTICES_VIEW_NAME
```
public static final PgRdbmsGraphConfig.Field VERTICES_VIEW_NAME
```
    the name of view for vertices
  - VIEW_PARALLEL_HINT_DEGREE
```
public static final PgRdbmsGraphConfig.Field VIEW_PARALLEL_HINT_DEGREE
```
    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.
- Method Detail
  - getDefaultVal
```
public java.lang.Object getDefaultVal()
```
    Description copied from interface: ConfigField
    
    Gets the default value of this field.
    
    Specified by:
    
    getDefaultVal in interface ConfigField
    
    Returns:
    
    the default value
  - 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 interface ConfigField
    
    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 interface ConfigField
    
    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 interface ConfigField
    
    Returns:
    
    the type
  - isArray
```
public boolean isArray()
```
    Description copied from interface: ConfigField
    
    Checks if this field is an array.
    
    Specified by:
    
    isArray in interface ConfigField
    
    Returns:
    
    true, if array
  - 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 interface ConfigField
    
    Returns:
    
    true if field should be hidden, false otherwise
  - isPath
```
public boolean isPath()
```
    Description copied from interface: ConfigField
    
    Checks if this field is a path.
    
    Specified by:
    
    isPath in interface ConfigField
    
    Returns:
    
    true, if path
  - isRequired
```
public boolean isRequired()
```
    Description copied from interface: ConfigField
    
    Checks if this field is required.
    
    Specified by:
    
    isRequired in interface ConfigField
    
    Returns:
    
    true, if required
  - isSensitive
```
public boolean isSensitive()
```
    Description copied from interface: ConfigField
    
    Checks if this field holds a sensitive data.
    
    Specified by:
    
    isSensitive in interface ConfigField
    
    Returns:
    
    true, if use for sensitive data
  - 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 interface ConfigField
    
    Returns:
    
    the key.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Enum<PgRdbmsGraphConfig.Field>
  - valueOf
```
public static PgRdbmsGraphConfig.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 name
    
    java.lang.NullPointerException - if the argument is null
  - values
```
public static PgRdbmsGraphConfig.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 (PgRdbmsGraphConfig.Field c : PgRdbmsGraphConfig.Field.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared

Enum PgRdbmsGraphConfig.Field

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface oracle.pgx.config.ConfigField

Enum Constant Detail

ARRAY_COMPACTION_THRESHOLD

ATTRIBUTES

DATA_SOURCE_ID

DB_ENGINE

EDGE_ID_STRATEGY

EDGE_ID_TYPE

EDGE_PROPS

EDGES_VIEW_NAME

ERROR_HANDLING

EXTERNAL_STORES

FORMAT

JDBC_URL

KEYSTORE_ALIAS

LABEL

LOADING

LOCAL_DATE_FORMAT

MAX_NUM_CONNECTIONS

NAME

OPTIMIZED_FOR

OPTIONS

OWNER

PARTITION_WHILE_LOADING

PASSWORD

POINT2D

ROW_LABEL

SECURITY_POLICY

TIME_FORMAT

TIME_WITH_TIMEZONE_FORMAT

TIMESTAMP_FORMAT

TIMESTAMP_WITH_TIMEZONE_FORMAT

USERNAME

VECTOR_COMPONENT_DELIMITER

VERTEX_ID_STRATEGY

VERTEX_ID_TYPE

VERTEX_PROPS

VERTICES_VIEW_NAME

VIEW_PARALLEL_HINT_DEGREE

Method Detail

getDefaultVal

getKeyAliases

getSingletonListKeyAliases

getType

isArray

isHidden

isPath

isRequired

isSensitive

toKey

toString

valueOf

values