com.vertica.jdbc

Interface VerticaDatabaseErrorInfo

public interface VerticaDatabaseErrorInfo

Exposes additional information about errors that occur on the database server.

When a server-side error occurs, the database may provide the the client with additional context and troubleshooting information about the error. The information available depends on the type of error that occurred. For example, when a SQL Syntax error occurs, the database may indicate a position within the SQL query text where the syntax was invalid, and a suggestion for altering the query text to make the query succeed.

The information provided by this interface is also queryable in the database via the v_monitor.error_messages system table.

This interface provides accessors to retrieve that information after an error has occurred. If the type of information was not available or relevant for the given error, the method should return null.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDetail()
int	getErrorCode()
java.lang.String	getErrorLevel() Returns the severity classification for the error.
java.lang.String	getHint()
java.lang.String	getMessage()
int	getPosition()
java.lang.String	getSQLState()

Method Detail

getMessage

java.lang.String getMessage()

Returns:

A description of the error.

getDetail

java.lang.String getDetail()

Returns:

Additional information about the error (optional). Null if not applicable.

getHint

java.lang.String getHint()

Returns:

A suggestion for how to resolve the error (optional). Null if not applicable.

getSQLState

java.lang.String getSQLState()

Returns:

The SQLState code for this error.

getErrorCode

int getErrorCode()

Returns:

A unique error code for this error.

getPosition

int getPosition()

Returns:

The position within the SQL command that caused the error. The first character is at position 1. Returns 0 if not applicable to the error.

getErrorLevel

java.lang.String getErrorLevel()

Returns the severity classification for the error. Possible values are:

"NOTICE": The command completed but also yielded some diagnostic information.

"WARNING": The command completed but also yielded some warning information.

"ERROR": The error caused the command the fail.

"ROLLBACK": The error caused the current transaction to roll back.

"FATAL": The error caused the database server to end the client's session.

"PANIC": The error caused the database server to shut down.

Returns:

The severity of the error.