App::DBCritic - Critique a database schema for best practices
my $critic = App::DBCritic->new(
dsn => 'dbi:Oracle:HR', username => 'scott', password => 'tiger');
This package is used to scan a database schema and catalog any violations of best practices as defined by a set of policy plugins. It takes conceptual and API inspiration from Perl::Critic.
dbcritic is the command line interface.
This is a work in progress - please see the "SUPPORT" section below for information on how to contribute. It especially needs ideas (and implementations!) of new policies!
The name of a DBIx::Class::Schema class you wish to "critique". Only settable at construction time.
A DBIx::Class::Schema object you wish to "critique". Only settable at construction time.
The DBI data source name (required) and optional username and password used to connect to the database. If no "class_name" or "schema" is provided, DBIx::Class::Schema::Loader will then construct schema classes dynamically to be critiqued.
Returns an array of loaded policy names that will be applied during "critique". By default all modules under the App::DBCritic::Policy namespace are loaded.
Runs the "schema" through the App::DBCritic engine using all the policies that have been loaded and dumps a string representation of "violations" to STDOUT.
Returns an array reference of all App::DBCritic::Violations picked up by the various policies.
You can find documentation for this module with the perldoc command.
The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.
The default CPAN search engine, useful to view POD in HTML format.
The AnnoCPAN is a website that allows community annonations of Perl module documentation.
The CPAN Ratings is a website that allows community ratings and reviews of Perl modules.
The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.
The CPAN Testers is a network of smokers who run automated tests on uploaded CPAN distributions.
CPAN Testers Matrix
The CPAN Testers Matrix is a website that provides a visual way to determine what Perls/platforms PASSed for a distribution.
CPAN Testers Dependencies
The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.
Please report any bugs or feature requests through the web interface at https://github.com/mjgardner/dbcritic/issues. You will be automatically notified of any progress on the request by the system.
The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)
git clone git://github.com/mjgardner/dbcritic.git
Mark Gardner <email@example.com>
This software is copyright (c) 2011 by Mark Gardner.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install App::DBCritic, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell
For more information on module installation, please visit the detailed CPAN module installation guide.