Package oracle.pgx.config

Enum RdbmsEntityProviderConfig.Field

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      AS_OF
      SCN value to use when executing Oracle Flashback queries, use `<current-scn>` to determine SCN automatically during loading.
      ATTRIBUTES
      additional attributes needed to read/write the graph data
      DATA_SOURCE_ID
      data source id to use to connect to an RDBMS instance
      DATABASE_TABLE_NAME
      name of the table in the database
      DESTINATION_COLUMN
      name of the column in the database containing the keys of the destination vertices
      DESTINATION_VERTEX_PROVIDER
      name of the destination vertex provider to be used for this edge provider
      ERROR_HANDLING
      error handling configuration
      FORMAT
      provider format
      HAS_KEYS
      indicates if the provided entities data have keys
      JDBC_URL
      jdbc URL pointing to an RDBMS instance
      KEY_COLUMN
      name of the column in the database table containing the keys of the entities
      KEY_TYPE
      type of the keys
      KEYSTORE_ALIAS
      alias to the keystore to use when connecting to database
      LABEL
      label for the entities loaded from this provider
      LOADING
      loading-specific configuration
      LOCAL_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-database
      NAME
      entity provider name
      NUM_CONNECTIONS
      number of connections to read/write data from/to the RDBMS table.
      PARALLEL_HINT_DEGREE
      parallel hint degree to use for internal queries.
      PASSWORD
      password to use when connecting to database
      POINT2D
      longitude and latitude as floating point values separated by a space
      PROPS
      specification of the properties associated with this entity provider
      SCHEMA
      schema to use when reading/writing RDBMS objects
      SOURCE_COLUMN
      name of the column in the database containing the keys of the source vertices
      SOURCE_VERTEX_PROVIDER
      name of the source vertex provider to be used for this edge provider
      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 an RDBMS instance
      VECTOR_COMPONENT_DELIMITER
      delimiter for the different components of vector properties

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

    • Method Detail

      • values

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