SQLT::Parser::PostgreSQL parses table def with default values

[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Parser.pm

diff --git a/lib/SQL/Translator/Parser.pm b/lib/SQL/Translator/Parser.pm
index 29e7a2d..cb99418 100644 (file)
--- a/lib/SQL/Translator/Parser.pm
+++ b/lib/SQL/Translator/Parser.pm
@@ -1,66 +1,52 @@
 package SQL::Translator::Parser;
 
-#-----------------------------------------------------
-# $Id: Parser.pm,v 1.1.1.1 2002-03-01 02:26:25 kycl4rk Exp $
-#
-# File       : SQL/Translator/Parser.pm
-# Programmer : Ken Y. Clark, kclark@logsoft.com
-# Created    : 2002/02/27
-# Purpose    : base object for parsers
-#-----------------------------------------------------
-
 use strict;
-use vars qw( $VERSION );
-$VERSION = (qw$Revision: 1.1.1.1 $)[-1];
-
-use Parse::RecDescent;
-use SQL::Translator;
-use base qw[ SQL::Translator ];
-
-sub parse {
-#
-# Override this method if you intend not to use Parse::RecDescent
-#
-    my $self = shift;
-    return $self->parser->file( shift() );
-}
-
-sub parser {
-    my $self   = shift;
-    unless ( $self->{'parser'} ) {
-        $self->{'parser'} = Parse::RecDescent->new( $self->grammar );
-    }
-    return $self->{'parser'};
-}
+use warnings;
+our $VERSION = '1.60';
+
+sub parse { "" }
 
 1;
 
-#-----------------------------------------------------
+# ----------------------------------------------------------------------
 # Enough! or Too much.
 # William Blake
-#-----------------------------------------------------
+# ----------------------------------------------------------------------
+
+=pod
 
 =head1 NAME
 
-SQL::Translator::Parser - base object for parsers
+SQL::Translator::Parser - describes how to write a parser
 
-=head1 SYNOPSIS
+=head1 DESCRIPTION
 
-  package SQL::Translator::Parser::Foo;
-  use SQL::Translator::Parser;
-  use base( 'SQL::Translator::Parser' );
-  1;
+Parser modules that get invoked by SQL::Translator need to implement a
+single function: B<parse>.  This function will be called by the
+SQL::Translator instance as $class::parse($tr, $data_as_string), where
+$tr is a SQL::Translator instance.  Other than that, the classes are
+free to define any helper functions, or use any design pattern
+internally that make the most sense.
 
-=head1 DESCRIPTION
+When the parser has determined what exists, it will communicate the
+structure to the producer through the SQL::Translator::Schema object.
+This object can be retrieved from the translator (the first argument
+pass to B<parse>) by calling the B<schema> method:
+
+  my $schema = $tr->schema;
 
-Blah blah blah.
+The Schema object has methods for adding tables, fields, indices, etc.
+For more information, consult the docs for SQL::Translator::Schema and
+its related modules.  For examples of how this works, examine the
+source code for existing SQL::Translator::Parser::* modules.
 
-=head1 AUTHOR
+=head1 AUTHORS
 
-Ken Y. Clark, kclark@logsoft.com
+Ken Youens-Clark, E<lt>kclark@cpan.org<gt>,
+darren chamberlain E<lt>darren@cpan.orgE<gt>.
 
 =head1 SEE ALSO
 
-perl(1).
+perl(1), SQL::Translator, SQL::Translator::Schema.
 
 =cut