view release on metacpan or  search on metacpan

lib/DBIx/ParseDSN.pm  view on Meta::CPAN

=head1 VERSION

This document describes DBIx::ParseDSN version 0.9.3

=head1 SYNOPSIS

    use DBIx::ParseDSN;

    my $dsn = parse_dsn("dbi:SQLite:database=/var/foo.db");

    $dsn->scheme; ## dbi
    $dsn->driver; ## SQLite
    $dsn->database; ## /var/foo.db

    $dsn->dbd_driver; ## DBD::SQLite

    ## information in user string
    my $dsn2 = parse_dsn( 'dbi:Oracle:host=foobar;port=1521', 'scott@DB/tiger' )
    $dsn2->database; ## DB
    $dsn2->port; ## 1521
    $dsn2->host; ## foobar

    ## uri connector
    my $dsn3 = parse_dsn( 'dbi:Oracle://myhost:1522/ORCL' )
    $dsn3->database; ## ORCL
    $dsn3->port; ## 1522
    $dsn3->host; ## myhost

=head1 DESCRIPTION

Exports parse_dsn that parses a DSN. It returns a
L<DBIx::ParseDSN::Default> that has attributes from the dsn.

This module looks for parser classes of the form DBIx::ParseDSN::Foo,
where Foo literally matches the DSN driver, ie the 2nd part of the DSN
string. Case sensitive.

Example: dbi:SQLite:database=/foo/bar would look for
DBIx::ParseDSN::SQLite and use that as a parser, if found.

If DBIx::ParseDSN::Foo is loaded, it uses that. If the module can be
loaded, it will load it.

It falls back to L<DBIx::ParseDSN::Default> if no specific parser is
found.

To implement not supported DBI driver strings, subclass
L<DBIx::ParseDSN::Default> and reimplement C<sub parse> or change for
example C<sub names_for_database> if database is just called something
else.

=head1 INTERFACE

=head2 parse_dsn( $dsn );

Parses a DSN and returns a L<DBIx::ParseDSN::Default> object that has
properties reflecting the parameters found in the DSN.

See L<DBIx::ParseDSN::Default/DSN ATTRIBUTES> for details.

=head1 BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to
C<bug-dbix-parsedsn@rt.cpan.org>, or through the web interface at
L<http://rt.cpan.org>.

=head1 SEE ALSO

L<DBI>
L<DBIx::ParseDSN::Default>

=head1 AUTHOR

Torbjørn Lindahl  C<< <torbjorn.lindahl@gmail.com> >>

=head1 LICENCE AND COPYRIGHT

Copyright (c) 2014, Torbjørn Lindahl C<< <torbjorn.lindahl@gmail.com> >>. All rights reserved.

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


=head1 DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.