NAME¶
SQL::Translator::Parser - describes how to write a parser
DESCRIPTION¶
Parser modules that get invoked by SQL::Translator need to implement a single
function:
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.
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
parse) by
calling the
schema method:
my $schema = $tr->schema;
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.
AUTHORS¶
Ken Youens-Clark, <kclark@cpan.org<gt>, darren chamberlain
<darren@cpan.org>.
SEE ALSO¶
perl(1), SQL::Translator, SQL::Translator::Schema.