Show / Hide Table of Contents

Class PostgresException

The exception that is thrown when the PostgreSQL backend reports errors (e.g. query SQL issues, constraint violations).

Inheritance
System.Object
NpgsqlException
PostgresException
Namespace: Npgsql
Assembly: Npgsql.dll
Syntax
public sealed class PostgresException : NpgsqlException
Remarks

This exception only corresponds to a PostgreSQL-delivered error. Other errors (e.g. network issues) will be raised via NpgsqlException, and purely Npgsql-related issues which aren't related to the server will be raised via the standard CLR exceptions (e.g. ArgumentException).

See http://www.postgresql.org/docs/current/static/errcodes-appendix.html, http://www.postgresql.org/docs/current/static/protocol-error-fields.html

Constructors

PostgresException()

Creates a new instance.

Declaration
public PostgresException()

Properties

Code

The SQLSTATE code for the error.

Declaration
public string Code { get; }
Property Value
Type Description
System.String
Remarks

Always present. See http://www.postgresql.org/docs/current/static/errcodes-appendix.html

ColumnName

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

Declaration
public string ColumnName { get; set; }
Property Value
Type Description
System.String
Remarks

PostgreSQL 9.3 and up.

ConstraintName

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

Declaration
public string ConstraintName { get; set; }
Property Value
Type Description
System.String
Remarks

PostgreSQL 9.3 and up.

Data

Gets a collection of key/value pairs that provide additional PostgreSQL fields about the exception.

Declaration
public override IDictionary Data { get; }
Property Value
Type Description
IDictionary

DataTypeName

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

Declaration
public string DataTypeName { get; set; }
Property Value
Type Description
System.String
Remarks

PostgreSQL 9.3 and up.

Detail

An optional secondary error message carrying more detail about the problem. May run to multiple lines.

Declaration
public string Detail { get; set; }
Property Value
Type Description
System.String

File

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

Declaration
public string File { get; set; }
Property Value
Type Description
System.String
Remarks

PostgreSQL 9.3 and up.

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. May run to multiple lines.

Declaration
public string Hint { get; set; }
Property Value
Type Description
System.String

InternalPosition

This is defined the same as the Position field, but it is used when the cursor position refers to an internally generated command rather than the one submitted by the client. The InternalQuery field will always appear when this field appears. 0 means not provided.

Declaration
public int InternalPosition { get; set; }
Property Value
Type Description
System.Int32

InternalQuery

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

Declaration
public string InternalQuery { get; set; }
Property Value
Type Description
System.String

IsTransient

Specifies whether the exception is considered transient, that is, whether retrying to operation could succeed (e.g. a network error). Check SqlState.

Declaration
public override bool IsTransient { get; }
Property Value
Type Description
System.Boolean
Overrides
NpgsqlException.IsTransient

Line

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

Declaration
public string Line { get; set; }
Property Value
Type Description
System.String

Message

Gets a the PostgreSQL error message and code.

Declaration
public override string Message { get; }
Property Value
Type Description
System.String

MessageText

The primary human-readable error message. This should be accurate but terse.

Declaration
public string MessageText { get; set; }
Property Value
Type Description
System.String
Remarks

Always present.

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. 0 means not provided.

Declaration
public int Position { get; set; }
Property Value
Type Description
System.Int32

Routine

The name of the source-code routine reporting the error.

Declaration
public string Routine { get; set; }
Property Value
Type Description
System.String

SchemaName

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

Declaration
public string SchemaName { get; set; }
Property Value
Type Description
System.String
Remarks

PostgreSQL 9.3 and up.

Severity

Severity of the error or notice. Always present.

Declaration
public string Severity { get; set; }
Property Value
Type Description
System.String

SqlState

The SQLSTATE code for the error.

Declaration
public string SqlState { get; set; }
Property Value
Type Description
System.String
Remarks

Always present. See http://www.postgresql.org/docs/current/static/errcodes-appendix.html

Statement

Returns the statement which triggered this exception.

Declaration
public NpgsqlStatement Statement { get; }
Property Value
Type Description
NpgsqlStatement

TableName

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

Declaration
public string TableName { get; set; }
Property Value
Type Description
System.String
Remarks

PostgreSQL 9.3 and up.

Where

An indication of the context in which the error occurred. Presently this includes a call stack traceback of active PL functions. The trace is one entry per line, most recent first.

Declaration
public string Where { get; set; }
Property Value
Type Description
System.String

Methods

GetObjectData(SerializationInfo, StreamingContext)

Populates a with the data needed to serialize the target object.

Declaration
public override void GetObjectData(SerializationInfo info, StreamingContext context)
Parameters
Type Name Description
SerializationInfo info

The to populate with data.

StreamingContext context

The destination (see ) for this serialization.

Back to top Copyright © 2015-2017 Microsoft
Generated by DocFX