~drizzle-trunk/drizzle/development

584.1.15 by Monty Taylor
The mega-patch from hell. Renamed sql_class to session (since that's what it is) and removed it and field and table from common_includes.
1
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
3
 *
4
 *  Copyright (C) 2008 Sun Microsystems
5
 *
6
 *  This program is free software; you can redistribute it and/or modify
7
 *  it under the terms of the GNU General Public License as published by
8
 *  the Free Software Foundation; version 2 of the License.
9
 *
10
 *  This program is distributed in the hope that it will be useful,
11
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
 *  GNU General Public License for more details.
14
 *
15
 *  You should have received a copy of the GNU General Public License
16
 *  along with this program; if not, write to the Free Software
17
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
18
 */
19
20
21
#ifndef DRIZZLED_FOREIGN_KEY_H
22
#define DRIZZLED_FOREIGN_KEY_H
23
24
#include <drizzled/sql_alloc.h>
25
#include <drizzled/key.h>
26
#include <drizzled/sql_list.h>
27
28
class Item;
934.2.20 by Jay Pipes
Move Foreign_key implementation into its own implementation file and out of session.cc
29
class Table_ident;
30
584.1.15 by Monty Taylor
The mega-patch from hell. Renamed sql_class to session (since that's what it is) and removed it and field and table from common_includes.
31
typedef struct st_mem_root MEM_ROOT;
32
33
class Foreign_key: public Key {
34
public:
934.2.20 by Jay Pipes
Move Foreign_key implementation into its own implementation file and out of session.cc
35
  enum fk_match_opt 
36
  {
37
    FK_MATCH_UNDEF
38
  , FK_MATCH_FULL
39
  , FK_MATCH_PARTIAL
40
  , FK_MATCH_SIMPLE
41
  };
42
  enum fk_option 
43
  {
44
    FK_OPTION_UNDEF
45
  , FK_OPTION_RESTRICT
46
  , FK_OPTION_CASCADE
47
  , FK_OPTION_SET_NULL
48
  , FK_OPTION_NO_ACTION
49
  , FK_OPTION_DEFAULT
50
  };
584.1.15 by Monty Taylor
The mega-patch from hell. Renamed sql_class to session (since that's what it is) and removed it and field and table from common_includes.
51
52
  Table_ident *ref_table;
53
  List<Key_part_spec> ref_columns;
54
  uint32_t delete_opt, update_opt, match_opt;
934.2.20 by Jay Pipes
Move Foreign_key implementation into its own implementation file and out of session.cc
55
  Foreign_key(const LEX_STRING &name_arg
56
            , List<Key_part_spec> &cols
57
            , Table_ident *table
58
            , List<Key_part_spec> &ref_cols
59
            , uint32_t delete_opt_arg
60
            , uint32_t update_opt_arg
61
            , uint32_t match_opt_arg)
62
  :Key(FOREIGN_KEY
63
     , name_arg
64
     , &default_key_create_info
65
     , 0
66
     , cols)
67
   , ref_table(table)
68
   , ref_columns(ref_cols)
69
   , delete_opt(delete_opt_arg)
70
   , update_opt(update_opt_arg)
71
   , match_opt(match_opt_arg)
72
  {}
73
  /**
74
   * Constructs an (almost) deep copy of this foreign key. Only those
75
   * elements that are known to never change are not copied.
76
   * If out of memory, a partial copy is returned and an error is set
77
   * in Session.
78
   */
584.1.15 by Monty Taylor
The mega-patch from hell. Renamed sql_class to session (since that's what it is) and removed it and field and table from common_includes.
79
  Foreign_key(const Foreign_key &rhs, MEM_ROOT *mem_root);
80
  /**
934.2.20 by Jay Pipes
Move Foreign_key implementation into its own implementation file and out of session.cc
81
   * Used to make a clone of this object for ALTER/CREATE TABLE
82
   * 
83
   * @see comment for Key_part_spec::clone
84
   */
584.1.15 by Monty Taylor
The mega-patch from hell. Renamed sql_class to session (since that's what it is) and removed it and field and table from common_includes.
85
  virtual Key *clone(MEM_ROOT *mem_root) const
934.2.20 by Jay Pipes
Move Foreign_key implementation into its own implementation file and out of session.cc
86
  {
87
    return new (mem_root) Foreign_key(*this, mem_root);
88
  }
584.1.15 by Monty Taylor
The mega-patch from hell. Renamed sql_class to session (since that's what it is) and removed it and field and table from common_includes.
89
  /* Used to validate foreign key options */
90
  bool validate(List<Create_field> &table_fields);
91
};
92
93
#endif /* DRIZZLED_FOREIGN_KEY_H */