PgHbaseGraphConfig.Field (Oracle Graph Java API Reference for Property Graph Release 22.4 (F52518-01))

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

All Implemented Interfaces:

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

Enclosing class:

PgHbaseGraphConfig
```
public static enum PgHbaseGraphConfig.Field
extends java.lang.Enum<PgHbaseGraphConfig.Field>
implements ConfigField
```
Fields of PGX Engine PG Hbase 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
`BLOCK_CACHE_SIZE` block_cache_size
`COMPRESSION` which HBase compression algorithm to use.
`DATA_BLOCK_ENCODING` which datablock encoding algorithm to use.
`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
`ERROR_HANDLING` error handling configuration
`EXTERNAL_STORES` Specification of the external stores where external string properties reside.
`FORMAT` graph format
`HADOOP_SEC_AUTH` Hadoop authentication string
`HBASE_SEC_AUTH` HBase authentication string
`HM_KERBEROS_PRINCIPAL` HM Kerberos principal
`INITIAL_EDGE_NUM_REGIONS` how many initial edge regions defined for the HBase tables
`INITIAL_VERTEX_NUM_REGIONS` how many initial vertex regions defined for the HBase tables
`KEYSTORE_ALIAS` alias to the keystore to use when connecting to database
`KEYTAB` path to keytab file
`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
`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
`RS_KERBEROS_PRINCIPAL` RS Kerberos principal
`SPLITS_PER_REGION` how many splits per region to use when scanning vertices/edges
`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.
`USER_PRINCIPAL` User principal
`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
`ZK_CLIENT_PORT` ZooKeeper client port
`ZK_NODE_PARENT` ZooKeeper node parent
`ZK_QUORUM` ZooKeeper Quorum value
`ZK_SESSION_TIMEOUT` ZooKeeper session timeout (in milliseconds)

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 PgHbaseGraphConfig.Field`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static PgHbaseGraphConfig.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 PgHbaseGraphConfig.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 PgHbaseGraphConfig.Field ATTRIBUTES
```
    additional attributes needed to read/write the graph data
  - BLOCK_CACHE_SIZE
```
public static final PgHbaseGraphConfig.Field BLOCK_CACHE_SIZE
```
    block_cache_size
  - COMPRESSION
```
public static final PgHbaseGraphConfig.Field COMPRESSION
```
    which HBase compression algorithm to use. Check HBase documentation for list of supported algorithms
  - DATA_BLOCK_ENCODING
```
public static final PgHbaseGraphConfig.Field DATA_BLOCK_ENCODING
```
    which datablock encoding algorithm to use. Supported values are 'none', 'prefix', 'diff', 'fast_diff' and 'prefix_tree'. See the DataBlockEncoding class in the org.apache.hadoop.hbase.io.encoding package for details.
  - DB_ENGINE
```
public static final PgHbaseGraphConfig.Field DB_ENGINE
```
    underlying database engine
  - EDGE_ID_STRATEGY
```
public static final PgHbaseGraphConfig.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 PgHbaseGraphConfig.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 PgHbaseGraphConfig.Field EDGE_PROPS
```
    specification of edge properties associated with graph
  - ERROR_HANDLING
```
public static final PgHbaseGraphConfig.Field ERROR_HANDLING
```
    error handling configuration
  - EXTERNAL_STORES
```
public static final PgHbaseGraphConfig.Field EXTERNAL_STORES
```
    Specification of the external stores where external string properties reside.
  - FORMAT
```
public static final PgHbaseGraphConfig.Field FORMAT
```
    graph format
  - HADOOP_SEC_AUTH
```
public static final PgHbaseGraphConfig.Field HADOOP_SEC_AUTH
```
    Hadoop authentication string
  - HBASE_SEC_AUTH
```
public static final PgHbaseGraphConfig.Field HBASE_SEC_AUTH
```
    HBase authentication string
  - HM_KERBEROS_PRINCIPAL
```
public static final PgHbaseGraphConfig.Field HM_KERBEROS_PRINCIPAL
```
    HM Kerberos principal
  - INITIAL_EDGE_NUM_REGIONS
```
public static final PgHbaseGraphConfig.Field INITIAL_EDGE_NUM_REGIONS
```
    how many initial edge regions defined for the HBase tables
  - INITIAL_VERTEX_NUM_REGIONS
```
public static final PgHbaseGraphConfig.Field INITIAL_VERTEX_NUM_REGIONS
```
    how many initial vertex regions defined for the HBase tables
  - KEYSTORE_ALIAS
```
public static final PgHbaseGraphConfig.Field KEYSTORE_ALIAS
```
    alias to the keystore to use when connecting to database
  - KEYTAB
```
public static final PgHbaseGraphConfig.Field KEYTAB
```
    path to keytab file
  - LOADING
```
public static final PgHbaseGraphConfig.Field LOADING
```
    loading-specific configuration
  - LOCAL_DATE_FORMAT
```
public static final PgHbaseGraphConfig.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 PgHbaseGraphConfig.Field MAX_NUM_CONNECTIONS
```
    maximum number of database connections to use when reading the graph
  - NAME
```
public static final PgHbaseGraphConfig.Field NAME
```
    prefix of the table name (for edge and vertex tables)
  - OPTIMIZED_FOR
```
public static final PgHbaseGraphConfig.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 PgHbaseGraphConfig.Field PARTITION_WHILE_LOADING
```
    Indicates if the graph should be partitioned while loading
  - PASSWORD
```
public static final PgHbaseGraphConfig.Field PASSWORD
```
    password to use when connecting to database
  - POINT2D
```
public static final PgHbaseGraphConfig.Field POINT2D
```
    longitude and latitude as floating point values separated by a space
  - RS_KERBEROS_PRINCIPAL
```
public static final PgHbaseGraphConfig.Field RS_KERBEROS_PRINCIPAL
```
    RS Kerberos principal
  - SPLITS_PER_REGION
```
public static final PgHbaseGraphConfig.Field SPLITS_PER_REGION
```
    how many splits per region to use when scanning vertices/edges
  - TIME_FORMAT
```
public static final PgHbaseGraphConfig.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 PgHbaseGraphConfig.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 PgHbaseGraphConfig.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 PgHbaseGraphConfig.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
  - USER_PRINCIPAL
```
public static final PgHbaseGraphConfig.Field USER_PRINCIPAL
```
    User principal
  - VECTOR_COMPONENT_DELIMITER
```
public static final PgHbaseGraphConfig.Field VECTOR_COMPONENT_DELIMITER
```
    delimiter for the different components of vector properties
  - VERTEX_ID_STRATEGY
```
public static final PgHbaseGraphConfig.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 PgHbaseGraphConfig.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 PgHbaseGraphConfig.Field VERTEX_PROPS
```
    specification of vertex properties associated with graph
  - ZK_CLIENT_PORT
```
public static final PgHbaseGraphConfig.Field ZK_CLIENT_PORT
```
    ZooKeeper client port
  - ZK_NODE_PARENT
```
public static final PgHbaseGraphConfig.Field ZK_NODE_PARENT
```
    ZooKeeper node parent
  - ZK_QUORUM
```
public static final PgHbaseGraphConfig.Field ZK_QUORUM
```
    ZooKeeper Quorum value
  - ZK_SESSION_TIMEOUT
```
public static final PgHbaseGraphConfig.Field ZK_SESSION_TIMEOUT
```
    ZooKeeper session timeout (in milliseconds)
- 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<PgHbaseGraphConfig.Field>
  - valueOf
```
public static PgHbaseGraphConfig.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 PgHbaseGraphConfig.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 (PgHbaseGraphConfig.Field c : PgHbaseGraphConfig.Field.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared

Enum PgHbaseGraphConfig.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

BLOCK_CACHE_SIZE

COMPRESSION

DATA_BLOCK_ENCODING

DB_ENGINE

EDGE_ID_STRATEGY

EDGE_ID_TYPE

EDGE_PROPS

ERROR_HANDLING

EXTERNAL_STORES

FORMAT

HADOOP_SEC_AUTH

HBASE_SEC_AUTH

HM_KERBEROS_PRINCIPAL

INITIAL_EDGE_NUM_REGIONS

INITIAL_VERTEX_NUM_REGIONS

KEYSTORE_ALIAS

KEYTAB

LOADING

LOCAL_DATE_FORMAT

MAX_NUM_CONNECTIONS

NAME

OPTIMIZED_FOR

PARTITION_WHILE_LOADING

PASSWORD

POINT2D

RS_KERBEROS_PRINCIPAL

SPLITS_PER_REGION

TIME_FORMAT

TIME_WITH_TIMEZONE_FORMAT

TIMESTAMP_FORMAT

TIMESTAMP_WITH_TIMEZONE_FORMAT

USER_PRINCIPAL

VECTOR_COMPONENT_DELIMITER

VERTEX_ID_STRATEGY

VERTEX_ID_TYPE

VERTEX_PROPS

ZK_CLIENT_PORT

ZK_NODE_PARENT

ZK_QUORUM

ZK_SESSION_TIMEOUT

Method Detail

getDefaultVal

getKeyAliases

getSingletonListKeyAliases

getType

isArray

isHidden

isPath

isRequired

isSensitive

toKey

toString

valueOf

values