Skip to content

Commit

Permalink
Rename README to README.md and make it proper Markdown.
Browse files Browse the repository at this point in the history
  • Loading branch information
theory committed Jun 20, 2011
1 parent 94ad779 commit b6fa489
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 49 deletions.
49 changes: 0 additions & 49 deletions README

This file was deleted.

53 changes: 53 additions & 0 deletions README.md
@@ -0,0 +1,53 @@
Exception/Class/DBI version 1.01
================================

This module offers a set of DBI-specific exception classes. They inherit from
Exception::Class::Base, the base class for all exception objects created by
the [Exception::Class](http://search.cpan.org/perldoc?Exception::Class) module
from the CPAN. Exception::Class::DBI itself offers a single class method,
`handler()`, that returns a code reference appropriate for passing the
[DBI](http://search.cpan.org/perldoc?DBI) `HandleError` attribute.

The exception classes created by Exception::Class::DBI are designed to be
thrown in certain DBI contexts; the code reference returned by `handler()` and
passed to the DBI `HandleError attribute determines the context, assembles the
necessary metadata, and throws the apopropriate exception.

Each of the Exception::Class::DBI classes offers a set of object accessor
methods in addition to those provided by Exception::Class::Base. These can be
used to output detailed output in the event of an exception.

Installation
------------

To install this module, type the following:

perl Build.PL
./Build
./Build test
./Build install

Or, if you don't have Module::Build installed, type the following:

perl Makefile.PL
make
make test
make install

Dependencies
------------

This module requires these other modules and libraries:

* DBI 1.28 or later (1.30 or later strongly recommended).
* Exception::Class 1.02 or later (1.05 or later strongly recommended).
* Test::Simple 0.40 (for testing).

Copyright and Licence
---------------------

Copyright (c) 2002-2011, David E. Wheeler. Some Rights Reserved.

This module is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.

0 comments on commit b6fa489

Please sign in to comment.