=for comment POD_DERIVED_INDEX_GENERATED
The following documentation is automatically generated.  Please do not edit
this file, but rather the original, inline with Protocol::Database::PostgreSQL::Error
at lib/Protocol/Database/PostgreSQL/Error.pm
(on the system that originally ran this).
If you do edit this file, and don't want your changes to be removed, make
sure you change the first line.

=cut

=head1 NAME

Protocol::Database::PostgreSQL::Error - represents a PostgreSQL error

=head1 DESCRIPTION

This inherits from L<Ryu::Exception> to provide a wrapper for exceptions and notices
raised by the server.

=head1 METHODS

=head2 code

The failing code.

=head2 file

Which PostgreSQL source file the error was raised from.

=head2 line

The line number in the PostgreSQL source file which raised this error.

=head2 message

The error message from the server.

=head2 position

The character offset in the input query.

=head2 routine

Which PostgreSQL processing routine raised this.

=head2 severity

Relative severity of the error, e.g. NOTICE or FATAL.

=head2 type

Look up the error information in tables extracted from PostgreSQL official documentation.
Returns a string corresponding to the error code, or C<unknown> if it's not in the tables
(or from a newer version than this module supports, currently 11.2).

=head1 INHERITED METHODS

=over 4

=item L<Ryu::Exception>

L<as_future|Ryu::Exception/as_future>, L<details|Ryu::Exception/details>, L<fail|Ryu::Exception/fail>, L<from_future|Ryu::Exception/from_future>, L<future|Ryu::Exception/future>, L<new|Ryu::Exception/new>, L<throw|Ryu::Exception/throw>

=back

=head1 AUTHOR

Tom Molesworth <TEAM@cpan.org>

=head1 LICENSE

Copyright Tom Molesworth 2010-2019. Licensed under the same terms as Perl itself.

