lib/SQL/Translator/Schema/Constants.pm

   1 package SQL::Translator::Schema::Constants;
   2
   3 # ----------------------------------------------------------------------
   4 # $Id: Constants.pm,v 1.6 2003-10-08 16:03:01 kycl4rk Exp $
   5 # ----------------------------------------------------------------------
   6 # Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>
   7 #
   8 # This program is free software; you can redistribute it and/or
   9 # modify it under the terms of the GNU General Public License as
  10 # published by the Free Software Foundation; version 2.
  11 #
  12 # This program is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 # General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with this program; if not, write to the Free Software
  19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  20 # 02111-1307  USA
  21 # -------------------------------------------------------------------
  22
  23 =head1 NAME
  24
  25 SQL::Translator::Schema::Constants - constants module
  26
  27 =head1 SYNOPSIS
  28
  29   use SQL::Translator::Schema::Constants;
  30
  31   $table->add_constraint(
  32       name => 'foo',
  33       type => PRIMARY_KEY,
  34   );
  35
  36 =head1 DESCRIPTION
  37
  38 This module exports a several constants to like "primary key," etc.
  39
  40 =cut
  41
  42 use strict;
  43 use base qw( Exporter );
  44 use vars qw( @EXPORT $VERSION );
  45 require Exporter;
  46 $VERSION = sprintf "%d.%02d", q$Revision: 1.6 $ =~ /(\d+)\.(\d+)/;
  47
  48 @EXPORT = qw[
  49     CHECK_C
  50     FOREIGN_KEY
  51     FULL_TEXT
  52     NOT_NULL
  53     NORMAL
  54     NULL
  55     PRIMARY_KEY
  56     UNIQUE
  57 ];
  58
  59 #
  60 # Because "CHECK" is a Perl keyword
  61 #
  62 use constant CHECK_C => 'CHECK';
  63
  64 use constant FOREIGN_KEY => 'FOREIGN KEY';
  65
  66 use constant FULL_TEXT => 'FULLTEXT';
  67
  68 use constant NOT_NULL => 'NOT NULL';
  69
  70 use constant NORMAL => 'NORMAL';
  71
  72 use constant NULL => 'NULL';
  73
  74 use constant PRIMARY_KEY => 'PRIMARY KEY';
  75
  76 use constant UNIQUE => 'UNIQUE';
  77
  78 1;
  79
  80 =pod
  81
  82 =head1 AUTHOR
  83
  84 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>
  85
  86 =head1 COPYRIGHT
  87
  88 Copyright (c) 2003
  89
  90 This library is free software;  you can redistribute it and/or modify
  91 it under the same terms as Perl itself.
  92
  93 =cut