Package oracle.pgx.config

Enum TwoTablesTextGraphConfig.Field

    • 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 data
      DATASTORE
      underlying datastore
      DETECT_GZIP
      enable/disable automatic gzip compression detection when loading graphs
      EDGE_DESTINATION_COLUMN
      name or index (starting from 1) of column corresponding to edge destination (for CSV format only)
      EDGE_ID_COLUMN
      name or index (starting from 1) of column corresponding to edge id (for CSV format only)
      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_LABEL_COLUMN
      name or index (starting from 1) of column corresponding to edge label (for CSV format only)
      EDGE_PROPS
      specification of edge properties associated with graph
      EDGE_SOURCE_COLUMN
      name or index (starting from 1) of column corresponding to edge source (for CSV format only)
      EDGE_URIS
      list of unified resource identifiers
      EDGES_KEY_COLUMN
      name of primary key column in edges table
      EDGES_LABEL_COLUMN
      column name for edge label
      ERROR_HANDLING
      error handling configuration
      EXTERNAL_STORES
      Specification of the external stores where external string properties reside.
      FORMAT
      graph format
      FROM_NID_COLUMN
      column name for source node
      HEADER
      first line of file is meant for headers, e.g.
      KEYSTORE_ALIAS
      alias to the keystore to use when connecting to database
      LOADING
      loading-specific configuration
      LOCAL_DATE_FORMAT
      array of local_date formats to use when loading and storing local_date properties.
      NODES_KEY_COLUMN
      name of primary key column in nodes table
      NODES_LABEL_COLUMN
      column name for node label
      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
      SEPARATOR
      a series of single-character separators for tokenizing.
      STORING
      storing-specific configuration
      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.
      TO_NID_COLUMN
      column name for destination node
      VECTOR_COMPONENT_DELIMITER
      delimiter for the different components of vector properties
      VERTEX_ID_COLUMN
      name or index (starting from 1) of column corresponding to vertex id (for CSV format only)
      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_LABELS_COLUMN
      name or index (starting from 1) of column corresponding to vertex labels (for CSV format only)
      VERTEX_PROPS
      specification of vertex properties associated with graph
      VERTEX_URIS
      list of unified resource identifiers

    • 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 TwoTablesTextGraphConfig.Field valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static TwoTablesTextGraphConfig.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

    • Enum Constant Detail

      • VERTEX_ID_COLUMN

        public static final TwoTablesTextGraphConfig.Field VERTEX_ID_COLUMN
        name or index (starting from 1) of column corresponding to vertex id (for CSV format only)

      • EDGE_ID_COLUMN

        public static final TwoTablesTextGraphConfig.Field EDGE_ID_COLUMN
        name or index (starting from 1) of column corresponding to edge id (for CSV format only)

      • EDGE_SOURCE_COLUMN

        public static final TwoTablesTextGraphConfig.Field EDGE_SOURCE_COLUMN
        name or index (starting from 1) of column corresponding to edge source (for CSV format only)

      • EDGE_DESTINATION_COLUMN

        public static final TwoTablesTextGraphConfig.Field EDGE_DESTINATION_COLUMN
        name or index (starting from 1) of column corresponding to edge destination (for CSV format only)

      • VERTEX_LABELS_COLUMN

        public static final TwoTablesTextGraphConfig.Field VERTEX_LABELS_COLUMN
        name or index (starting from 1) of column corresponding to vertex labels (for CSV format only)

      • EDGE_LABEL_COLUMN

        public static final TwoTablesTextGraphConfig.Field EDGE_LABEL_COLUMN
        name or index (starting from 1) of column corresponding to edge label (for CSV format only)

      • SEPARATOR

        public static final TwoTablesTextGraphConfig.Field SEPARATOR
        a series of single-character separators for tokenizing. The characters ", {, } and \n cannot be used as separators. Default value is "," for CSV files, and "\t " for other formats. The first character will be used as a separator when storing.

      • HEADER

        public static final TwoTablesTextGraphConfig.Field HEADER
        first line of file is meant for headers, e.g. 'EdgeId, SourceId, DestId, EdgeProp1, EdgeProp2'

      • OPTIMIZED_FOR

        public static final TwoTablesTextGraphConfig.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 TwoTablesTextGraphConfig.Field PARTITION_WHILE_LOADING
        Indicates if the graph should be partitioned while loading

      • VERTEX_ID_STRATEGY

        public static final TwoTablesTextGraphConfig.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 TwoTablesTextGraphConfig.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 TwoTablesTextGraphConfig.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 TwoTablesTextGraphConfig.Field EDGE_ID_TYPE
        type of the edge ID. For homogeneous graphs, if not specified (or set to null), it will default to long.

      • ARRAY_COMPACTION_THRESHOLD

        public static final TwoTablesTextGraphConfig.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

      • EXTERNAL_STORES

        public static final TwoTablesTextGraphConfig.Field EXTERNAL_STORES
        Specification of the external stores where external string properties reside.

      • LOCAL_DATE_FORMAT

        public static final TwoTablesTextGraphConfig.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_WITH_TIMEZONE_FORMAT

        public static final TwoTablesTextGraphConfig.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 TwoTablesTextGraphConfig.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 TwoTablesTextGraphConfig.Field VECTOR_COMPONENT_DELIMITER
        delimiter for the different components of vector properties

    • Method Detail

      • values

        public static TwoTablesTextGraphConfig.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 (TwoTablesTextGraphConfig.Field c : TwoTablesTextGraphConfig.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 TwoTablesTextGraphConfig.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

      • 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

      • 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

      • 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

      • 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

      • 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.

      • 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

      • 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