NAME ORLite::Pod - Documentation generator for ORLite SYNOPSIS orlite2pod Class::Name DESCRIPTION *This initial release is intended to test whether or not search.cpan.org gets confused by the heredoc POD fragments in this file. Use of this module is not recommended for any users at this time* THIS MODULE IS EXPERIMENTAL AND SUBJECT TO CHANGE WITHOUT NOTICE. YOU HAVE BEEN WARNED! The biggest downside of ORLite is that because it can generate you an entire ORM in one line of code, you can have a large an extensive API without anywhere for documentation for the API to exist. The result is quick efficient creation of APIs that nobody can understand or use :) ORLite::Pod was created to fix this problem by allowing you to keep your slimline Perl module as is, but generating a tree of .pod files alongside the regular modules containing the documentation for the API. ORLite::Pod connects directly to a loaded ORLite instance, interrogating it to find the database it connects to, and discovering which tables have or don't have classes generated for them. TO BE COMPLETED METHODS SYNOPSIS TO BE COMPLETED DESCRIPTION TO BE COMPLETED METHODS END_POD # Add pod for each method that is defined print FILE <<"END_POD" if $pkg->can('dsn'); =head2 dsn my \$string = Foo::Bar->dsn; The "dsn" accessor returns the dbi connection string used to connect to the SQLite database as a string. END_POD print FILE <<"END_POD" if $pkg->can('dbh'); =head2 dbh my \$handle = Foo::Bar->dbh; To reliably prevent potential SQLite deadlocks resulting from multiple connections in a single process, each ORLite package will only ever maintain a single connection to the database. During a transaction, this will be the same (cached) database handle. Although in most situations you should not need a direct DBI connection handle, the "dbh" method provides a method for getting a direct connection in a way that is compatible with ORLite's connection management. Please note that these connections should be short-lived, you should never hold onto a connection beyond the immediate scope. The transaction system in ORLite is specifically designed so that code using the database should never have to know whether or not it is in a transation. Because of this, you should never call the ->disconnect method on the database handles yourself, as the handle may be that of a currently running transaction. Further, you should do your own transaction management on a handle provided by the method. In cases where there are extreme needs, and you absolutely have to violate these connection handling rules, you should create your own completely manual DBI->connect call to the database, using the connect string provided by the "dsn" method. The "dbh" method returns a DBI::db object, or throws an exception on error. END_POD print FILE <<"END_POD" if $pkg->can('begin'); =head2 begin Foo::Bar->begin; The "begin" method indicates the start of a transaction. In the same way that ORLite allows only a single connection, likewise it allows only a single application-wide transaction. No indication is given as to whether you are currently in a transaction or not, all code should be written neutrally so that it works either way or doesn't need to care. Returns true or throws an exception on error. END_POD print FILE <<"END_POD" if $pkg->can('commit'); =head2 commit Foo::Bar->commit; The "commit" method commits the current transaction. If called outside of a current transaction, it is accepted and treated as a null operation. Once the commit has been completed, the database connection falls back into auto-commit state. If you wish to immediately start another transaction, you will need to issue a separate ->begin call. Returns true or throws an exception on error. END_POD print FILE <<"END_POD" if $pkg->can('rollback'); =head2 rollback The "rollback" method rolls back the current transaction. If called outside of a current transaction, it is accepted and treated as a null operation. Once the rollback has been completed, the database connection falls back into auto-commit state. If you wish to immediately start another transaction, you will need to issue a separate ->begin call. If a transaction exists at END-time as the process exits, it will be automatically rolled back. Returns true or throws an exception on error. do Foo::Bar->do('insert into table (foo, bar) values (?, ?)', {}, \$foo_value, \$bar_value, ); The "do" method is a direct wrapper around the equivalent DBI method, but applied to the appropriate locally-provided connection or transaction. It takes the same parameters and has the same return values and error behaviour. END_POD print FILE <<"END_POD" if $pkg->can('selectall_arrayref'); =head2 selectall_arrayref The "selectall_arrayref" method is a direct wrapper around the equivalent DBI method, but applied to the appropriate locally-provided connection or transaction. It takes the same parameters and has the same return values and error behaviour. END_POD print FILE <<"END_POD" if $pkg->can('selectall_hashref'); =head2 selectall_hashref The "selectall_hashref" method is a direct wrapper around the equivalent DBI method, but applied to the appropriate locally-provided connection or transaction. It takes the same parameters and has the same return values and error behaviour. END_POD print FILE <<"END_POD" if $pkg->can('selectcol_arrayref'); =head2 selectcol_arrayref The "selectcol_arrayref" method is a direct wrapper around the equivalent DBI method, but applied to the appropriate locally-provided connection or transaction. It takes the same parameters and has the same return values and error behaviour. END_POD print FILE <<"END_POD" if $pkg->can('selectrow_array'); =head2 selectrow_array The "selectrow_array" method is a direct wrapper around the equivalent DBI method, but applied to the appropriate locally-provided connection or transaction. It takes the same parameters and has the same return values and error behaviour. END_POD print FILE <<"END_POD" if $pkg->can('selectrow_arrayref'); =head2 selectrow_arrayref The "selectrow_arrayref" method is a direct wrapper around the equivalent DBI method, but applied to the appropriate locally-provided connection or transaction. It takes the same parameters and has the same return values and error behaviour. END_POD print FILE <<"END_POD" if $pkg->can('selectrow_hashref'); =head2 selectrow_hashref The "selectrow_hashref" method is a direct wrapper around the equivalent DBI method, but applied to the appropriate locally-provided connection or transaction. It takes the same parameters and has the same return values and error behaviour. END_POD print FILE <<"END_POD" if $pkg->can('prepare'); =head2 prepare The "prepare" method is a direct wrapper around the equivalent DBI method, but applied to the appropriate locally-provided connection or transaction It takes the same parameters and has the same return values and error behaviour. In general though, you should try to avoid the use of your own prepared statements if possible, although this is only a recommendation and by no means prohibited. END_POD print FILE <<"END_POD" if $pkg->can('pragma'); =head2 pragma # Get the user_version for the schema my \$version = Foo::Bar->pragma('user_version'); The "pragma" method provides a convenient method for fetching a pragma for a datase. See the SQLite documentation for more details. END_POD # Add a footer print FILE <<"END_POD"; =head1 SUPPORT $pkg is based on ORLite $ORLite::VERSION. Documentation created by ORLite::Pod $ORLite::Pod::VERSION. For general support, please see the support section of the main project documentation. AUTHOR Adam Kennedy COPYRIGHT Copyright 2009 Adam Kennedy. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of the license can be found in the LICENSE file included with this module. END_POD close FILE; return 1; } ##################################################################### # Generation of Table-Specific Documentation sub write_table { my $self = shift; my $tables = shift; my $table = shift; # Determine the file we're going to be writing to my $root = $self->from; my $pkg = $table->{class}; my $file = File::Spec->catfile( $self->to, split( /::/, $pkg ) ) . '.pod'; # Start writing the file print "Generating $file...\n"; local *FILE; open( FILE, '>', $file ) or die "open: $!"; print FILE <<"END_POD"; =head1 NAME $pkg - $root class for the $table->{name} table SYNOPSIS TO BE COMPLETED DESCRIPTION TO BE COMPLETED METHODS END_POD print FILE <<"END_POD" if $pkg->can('select'); =head2 select # Get all objects in list context my \@list = \$pkg->select; # Get a subset of objects in scalar context my \$array_ref = \$pkg->select( 'where $table->{pk} > ? order by $table->{pk}', 1000, ); The "select" method executes a typical SQL "SELECT" query on the $table->{name} table. It takes an optional argument of a SQL phrase to be added after the "FROM $table-"{name}> section of the query, followed by variables to be used for any placeholders in the conditions. Any SQL that is compatible with SQLite can be used in the parameter. Returns a list of $pkg objects when called in list context, or a reference to an ARRAY of $pkg objects when called in scalar context. Throws an exception on error, typically directly from the DBI layer. END_POD # Add a footer print FILE <<"END_POD"; =head1 SUPPORT $pkg is part of the $root API. See the documentation for $root for more information. AUTHOR Adam Kennedy COPYRIGHT Copyright 2009 Adam Kennedy. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of the license can be found in the LICENSE file included with this module. END_POD close FILE; return 1; } 1; SUPPORT Bugs should be reported via the CPAN bug tracker at For other issues, contact the author. AUTHOR Adam Kennedy COPYRIGHT Copyright 2009 Adam Kennedy. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of the license can be found in the LICENSE file included with this module.