/ 
App-DBCritic-0.023
River stage zero No dependents
/ App::DBCritic

NAME

App::DBCritic - Critique a database schema for best practices

VERSION

version 0.023

SYNOPSIS

use App::DBCritic;

my $critic = App::DBCritic->new(
    dsn => 'dbi:Oracle:HR', username => 'scott', password => 'tiger');
$critic->critique();

DESCRIPTION

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!

ATTRIBUTES

username

The optional username used to connect to the database.

password

The optional password used to connect to the database.

class_name

The name of a DBIx::Class::Schema class you wish to "critique". Only settable at construction time.

dsn

The DBI data source name (required) 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.

schema

A DBIx::Class::Schema object you wish to "critique". Only settable at construction time.

has_schema

An attribute predicates that is true or false, depending on whether "schema" has been defined.

METHODS

policies

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.

critique

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.

violations

Returns an array reference of all App::DBCritic::Violations picked up by the various policies.

SEE ALSO

Perl::Critic
DBIx::Class
DBIx::Class::Schema::Loader

SUPPORT

Perldoc

You can find documentation for this module with the perldoc command.

perldoc App::DBCritic

Websites

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.

Bugs / Feature Requests

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.

Source Code

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

https://github.com/mjgardner/dbcritic

git clone git://github.com/mjgardner/dbcritic.git

AUTHOR

Mark Gardner <mjgardner@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2019 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.