lib/SQL/Translator/Schema/Constants.pm

   1 package SQL::Translator::Schema::Constants;
   2
   3 # ----------------------------------------------------------------------
   4 # $Id: Constants.pm 1440 2009-01-17 16:31:57Z jawnsy $
   5 # ----------------------------------------------------------------------
   6 # Copyright (C) 2002-2009 SQLFairy Authors
   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 the following constants for Schema features;
  39
  40 =over 4
  41
  42 =item CHECK_C
  43
  44 =item FOREIGN_KEY
  45
  46 =item FULL_TEXT
  47
  48 =item NOT_NULL
  49
  50 =item NORMAL
  51
  52 =item NULL
  53
  54 =item PRIMARY_KEY
  55
  56 =item UNIQUE
  57
  58 =back
  59
  60 =cut
  61
  62 use strict;
  63 use base qw( Exporter );
  64 use vars qw( @EXPORT );
  65 require Exporter;
  66
  67 @EXPORT = qw[
  68     CHECK_C
  69     FOREIGN_KEY
  70     FULL_TEXT
  71     SPATIAL
  72     NOT_NULL
  73     NORMAL
  74     NULL
  75     PRIMARY_KEY
  76     UNIQUE
  77 ];
  78
  79 #
  80 # Because "CHECK" is a Perl keyword
  81 #
  82 use constant CHECK_C => 'CHECK';
  83
  84 use constant FOREIGN_KEY => 'FOREIGN KEY';
  85
  86 use constant FULL_TEXT => 'FULLTEXT';
  87
  88 use constant SPATIAL => 'SPATIAL';
  89
  90 use constant NOT_NULL => 'NOT NULL';
  91
  92 use constant NORMAL => 'NORMAL';
  93
  94 use constant NULL => 'NULL';
  95
  96 use constant PRIMARY_KEY => 'PRIMARY KEY';
  97
  98 use constant UNIQUE => 'UNIQUE';
  99
 100 1;
 101
 102 # ----------------------------------------------------------------------
 103
 104 =pod
 105
 106 =head1 AUTHOR
 107
 108 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
 109
 110 =cut