PgRdbmsGraphConfig.Field (Oracle Big Data Spatial and Graph In-memory Analyst Java API Reference v2.2.0 (E62127

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
`ATTRIBUTES` additional attributes
`DATA_SOURCE_ID` the data source id to use to connect to database
`DATE_FORMAT` the date format to use when loading and storing date properties.
`DB_ENGINE` underlying database engine
`EDGE_PROPS` specification of edge properties associated with graph
`EDGES_VIEW_NAME` the name of view for edges
`ERROR_HANDLING` error handling configuration
`FORMAT` graph format (Note: `bin` is deprecated, use `pgb` instead)
`JDBC_URL` jdbc URL pointing to database
`LABEL` the label to use when reading the graph
`LOADING` loading-specific configuration
`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)
`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
`PASSWORD` password to use when connecting to database
`ROW_LABEL` the row label to use when reading the graph
`SECURITY_POLICY` the policy for the given label or row label
`USERNAME` username to use when connecting to database
`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`	`isPath()` Checks if this field is a path.
`boolean`	`isRequired()` Checks if this field is required.
`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
  - ATTRIBUTES
```
public static final PgRdbmsGraphConfig.Field ATTRIBUTES
```
    additional attributes
  - DATA_SOURCE_ID
```
public static final PgRdbmsGraphConfig.Field DATA_SOURCE_ID
```
    the data source id to use to connect to database
  - DATE_FORMAT
```
public static final PgRdbmsGraphConfig.Field DATE_FORMAT
```
    the date format to use when loading and storing date properties. Please see SimpleDateFormat for a documentation of the format string
  - DB_ENGINE
```
public static final PgRdbmsGraphConfig.Field DB_ENGINE
```
    underlying database engine
  - 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
  - FORMAT
```
public static final PgRdbmsGraphConfig.Field FORMAT
```
    graph format (Note: bin is deprecated, use pgb instead)
  - JDBC_URL
```
public static final PgRdbmsGraphConfig.Field JDBC_URL
```
    jdbc URL pointing 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
  - 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)
  - 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
  - PASSWORD
```
public static final PgRdbmsGraphConfig.Field PASSWORD
```
    password to use when connecting to database
  - 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
  - USERNAME
```
public static final PgRdbmsGraphConfig.Field USERNAME
```
    username to use when connecting to database
  - 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
  - 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
  - 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

ATTRIBUTES

DATA_SOURCE_ID

DATE_FORMAT

DB_ENGINE

EDGE_PROPS

EDGES_VIEW_NAME

ERROR_HANDLING

FORMAT

JDBC_URL

LABEL

LOADING

MAX_NUM_CONNECTIONS

NAME

OPTIONS

OWNER

PASSWORD

ROW_LABEL

SECURITY_POLICY

USERNAME

VERTEX_PROPS

VERTICES_VIEW_NAME

VIEW_PARALLEL_HINT_DEGREE

Method Detail

getDefaultVal

getKeyAliases

getSingletonListKeyAliases

getType

isArray

isPath

isRequired

toKey

toString

valueOf

values