Package org.apache.arrow.adbc.core

Enum AdbcStatusCode

java.lang.Object
java.lang.Enum<AdbcStatusCode>
org.apache.arrow.adbc.core.AdbcStatusCode
All Implemented Interfaces:
Serializable, Comparable<AdbcStatusCode>
public enum AdbcStatusCode extends Enum<AdbcStatusCode>
A status code indicating the general category of error that occurred.

Also see the ADBC C API definition, which has similar status codes.

  • Enum Constant Details

    • UNKNOWN

      public static final AdbcStatusCode UNKNOWN
      An unknown error occurred.

      May indicate client-side or database-side error.

    • NOT_IMPLEMENTED

      public static final AdbcStatusCode NOT_IMPLEMENTED
      The operation is not supported.

      May indicate client-side or database-side error.

    • NOT_FOUND

      public static final AdbcStatusCode NOT_FOUND
      \brief A requested resource already exists.

      May indicate a driver-side or database-side error.

    • ALREADY_EXISTS

      public static final AdbcStatusCode ALREADY_EXISTS
      A requested resource already exists.

      May indicate a driver-side or database-side error.

    • INVALID_ARGUMENT

      public static final AdbcStatusCode INVALID_ARGUMENT
      The arguments are invalid, likely a programming error.

      For instance, they may be of the wrong format, or out of range.

      May indicate a driver-side or database-side error.

    • INVALID_STATE

      public static final AdbcStatusCode INVALID_STATE
      The preconditions for the operation are not met, likely a programming error.

      For instance, the object may be uninitialized, or may have not been fully configured.

      May indicate a driver-side or database-side error.

    • INVALID_DATA

      public static final AdbcStatusCode INVALID_DATA
      Invalid data was processed (not a programming error).

      For instance, a division by zero may have occurred during query execution.

      May indicate a database-side error only.

    • INTEGRITY

      public static final AdbcStatusCode INTEGRITY
      The database's integrity was affected.

      For instance, a foreign key check may have failed, or a uniqueness constraint may have been violated.

      May indicate a database-side error only.

    • INTERNAL

      public static final AdbcStatusCode INTERNAL
      An error internal to the driver or database occurred.

      May indicate a driver-side or database-side error.

    • IO

      public static final AdbcStatusCode IO
      An I/O error occurred.

      For instance, a remote service may be unavailable.

      May indicate a driver-side or database-side error.

    • CANCELLED

      public static final AdbcStatusCode CANCELLED
      The operation was cancelled, not due to a timeout.

      May indicate a driver-side or database-side error.

    • TIMEOUT

      public static final AdbcStatusCode TIMEOUT
      The operation was cancelled due to a timeout.

      May indicate a driver-side or database-side error.

    • UNAUTHENTICATED

      public static final AdbcStatusCode UNAUTHENTICATED
      Authentication failed.

      May indicate a database-side error only.

    • UNAUTHORIZED

      public static final AdbcStatusCode UNAUTHORIZED
      The client is not authorized to perform the given operation.

      May indicate a database-side error only.

  • Method Details

    • values

      public static AdbcStatusCode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static AdbcStatusCode valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null