io.r2dbc.postgresql.message.backend

Enum Field.FieldType

java.lang.Object

java.lang.Enum<Field.FieldType>

io.r2dbc.postgresql.message.backend.Field.FieldType

All Implemented Interfaces:

Serializable, Comparable<Field.FieldType>

Enclosing class:

Field

public static enum Field.FieldType
extends Enum<Field.FieldType>

An enumeration of field types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CODE Code: the SQLSTATE code for the error.
COLUMN_NAME Column name: if the error was associated with a specific table column, the name of the column.
CONSTRAINT_NAME Constraint name: if the error was associated with a specific constraint, the name of the constraint.
DATA_TYPE_NAME Data type name: if the error was associated with a specific data type, the name of the data type.
DETAIL Detail: an optional secondary error message carrying more detail about the problem.
FILE File: the file name of the source-code location where the error was reported.
HINT Hint: an optional suggestion what to do about the problem.
INTERNAL_POSITION Internal position: this is defined the same as the P field, but it is used when the cursor position refers to an internally generated command rather than the one submitted by the client.
INTERNAL_QUERY Internal query: the text of a failed internally-generated command.
LINE Line: the line number of the source-code location where the error was reported.
MESSAGE Message: the primary human-readable error message.
POSITION Position: the field value is a decimal ASCII integer, indicating an error cursor position as an index into the original query string.
ROUTINE Routine: the name of the source-code routine reporting the error.
SCHEMA_NAME Schema name: if the error was associated with a specific database object, the name of the schema containing that object, if any.
SEVERITY_LOCALIZED Severity: the field contents are ERROR, FATAL, or PANIC (in an error message), or WARNING, NOTICE, DEBUG, INFO, or LOG (in a notice message), or a localized translation of one of these.
SEVERITY_NON_LOCALIZED Severity: the field contents are ERROR, FATAL, or PANIC (in an error message), or WARNING, NOTICE, DEBUG, INFO, or LOG (in a notice message).
TABLE_NAME Table name: if the error was associated with a specific table, the name of the table.
UNKNOWN An unknown field type.
WHERE Where: an indication of the context in which the error occurred.

Method Summary

Modifier and Type	Method and Description
static Field.FieldType	valueOf(String name) Returns the enum constant of this type with the specified name.
static Field.FieldType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CODE

public static final Field.FieldType CODE

Code: the SQLSTATE code for the error. Not localizable. Always present.

COLUMN_NAME

public static final Field.FieldType COLUMN_NAME

Column name: if the error was associated with a specific table column, the name of the column. (Refer to the schema and table name fields to identify the table.)

CONSTRAINT_NAME

public static final Field.FieldType CONSTRAINT_NAME

Constraint name: if the error was associated with a specific constraint, the name of the constraint. Refer to fields listed above for the associated table or domain. (For this purpose, indexes are treated as constraints, even if they weren't created with constraint syntax.)

DATA_TYPE_NAME

public static final Field.FieldType DATA_TYPE_NAME

Data type name: if the error was associated with a specific data type, the name of the data type. (Refer to the schema name field for the name of the data type's schema.)

DETAIL

public static final Field.FieldType DETAIL

Detail: an optional secondary error message carrying more detail about the problem. Might run to multiple lines.

FILE

public static final Field.FieldType FILE

File: the file name of the source-code location where the error was reported.

HINT

public static final Field.FieldType HINT

Hint: an optional suggestion what to do about the problem. This is intended to differ from Detail in that it offers advice (potentially inappropriate) rather than hard facts. Might run to multiple lines.

INTERNAL_POSITION

public static final Field.FieldType INTERNAL_POSITION

Internal position: this is defined the same as the P field, but it is used when the cursor position refers to an internally generated command rather than the one submitted by the client. The q field will always appear when this field appears.

INTERNAL_QUERY

public static final Field.FieldType INTERNAL_QUERY

Internal query: the text of a failed internally-generated command. This could be, for example, a SQL query issued by a PL/pgSQL function.

LINE

public static final Field.FieldType LINE

Line: the line number of the source-code location where the error was reported.

MESSAGE

public static final Field.FieldType MESSAGE

Message: the primary human-readable error message. This should be accurate but terse (typically one line). Always present.

POSITION

public static final Field.FieldType POSITION

Position: the field value is a decimal ASCII integer, indicating an error cursor position as an index into the original query string. The first character has index 1, and positions are measured in characters not bytes.

ROUTINE

public static final Field.FieldType ROUTINE

Routine: the name of the source-code routine reporting the error.

SCHEMA_NAME

public static final Field.FieldType SCHEMA_NAME

Schema name: if the error was associated with a specific database object, the name of the schema containing that object, if any.

SEVERITY_LOCALIZED

public static final Field.FieldType SEVERITY_LOCALIZED

Severity: the field contents are ERROR, FATAL, or PANIC (in an error message), or WARNING, NOTICE, DEBUG, INFO, or LOG (in a notice message), or a localized translation of one of these. Always present.

SEVERITY_NON_LOCALIZED

public static final Field.FieldType SEVERITY_NON_LOCALIZED

Severity: the field contents are ERROR, FATAL, or PANIC (in an error message), or WARNING, NOTICE, DEBUG, INFO, or LOG (in a notice message). This is identical to the S field except that the contents are never localized. This is present only in messages generated by PostgreSQL versions 9.6 and later.

TABLE_NAME

public static final Field.FieldType TABLE_NAME

Table name: if the error was associated with a specific table, the name of the table. (Refer to the schema name field for the name of the table's schema.)

UNKNOWN

public static final Field.FieldType UNKNOWN

An unknown field type.

WHERE

public static final Field.FieldType WHERE

Where: an indication of the context in which the error occurred. Presently this includes a call stack traceback of active procedural language functions and internally-generated queries. The trace is one entry per line, most recent first.

Method Detail

values

public static Field.FieldType[] 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 (Field.FieldType c : Field.FieldType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Field.FieldType 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