← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/key.h

  • Committer: Brian Aker
  • Date: 2009-05-11 17:50:22 UTC
  • Revision ID: brian@gaz-20090511175022-y35q9ky6uh9ldcjt
Replacing Sun employee copyright headers (aka... anything done by a Sun
employee is copyright by Sun).

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/key.h
 
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_KEY_H
 
22
#define DRIZZLED_KEY_H
 
23
 
 
24
 
 
25
#include <drizzled/sql_alloc.h>
 
26
#include <drizzled/key_part_spec.h>
 
27
#include <drizzled/sql_list.h>
 
28
#include <drizzled/lex_string.h>
 
29
#include <drizzled/handler_structs.h>
 
30
 
 
31
class Item;
 
32
typedef struct st_mem_root MEM_ROOT;
 
33
 
 
34
class Key :public Sql_alloc {
 
35
public:
 
36
  enum Keytype { PRIMARY, UNIQUE, MULTIPLE, FOREIGN_KEY};
 
37
  enum Keytype type;
 
38
  KEY_CREATE_INFO key_create_info;
 
39
  List<Key_part_spec> columns;
 
40
  LEX_STRING name;
 
41
  bool generated;
 
42
 
 
43
  Key(enum Keytype type_par, const LEX_STRING &name_arg,
 
44
      KEY_CREATE_INFO *key_info_arg,
 
45
      bool generated_arg, List<Key_part_spec> &cols)
 
46
    :type(type_par), key_create_info(*key_info_arg), columns(cols),
 
47
    name(name_arg), generated(generated_arg)
 
48
  {}
 
49
  Key(enum Keytype type_par, const char *name_arg, size_t name_len_arg,
 
50
      KEY_CREATE_INFO *key_info_arg, bool generated_arg,
 
51
      List<Key_part_spec> &cols)
 
52
    :type(type_par), key_create_info(*key_info_arg), columns(cols),
 
53
    generated(generated_arg)
 
54
  {
 
55
    name.str= (char *)name_arg;
 
56
    name.length= name_len_arg;
 
57
  }
 
58
 
 
59
  /**
 
60
   * Construct an (almost) deep copy of this key. Only those
 
61
   * elements that are known to never change are not copied.
 
62
   * If out of memory, a partial copy is returned and an error is set
 
63
   * in Session.
 
64
   */
 
65
  Key(const Key &rhs, MEM_ROOT *mem_root);
 
66
  virtual ~Key() {}
 
67
  /* Equality comparison of keys (ignoring name) */
 
68
  friend bool foreign_key_prefix(Key *a, Key *b);
 
69
  /**
 
70
    Used to make a clone of this object for ALTER/CREATE TABLE
 
71
    @sa comment for Key_part_spec::clone
 
72
  */
 
73
  virtual Key *clone(MEM_ROOT *mem_root) const
 
74
    { return new (mem_root) Key(*this, mem_root); }
 
75
};
 
76
 
 
77
 
 
78
int find_ref_key(KEY *key, uint32_t key_count, unsigned char *record, Field *field,
 
79
                 uint32_t *key_length, uint32_t *keypart);
 
80
/**
 
81
  Copy part of a record that forms a key or key prefix to a buffer.
 
82
 
 
83
    The function takes a complete table record (as e.g. retrieved by
 
84
    handler::index_read()), and a description of an index on the same table,
 
85
    and extracts the first key_length bytes of the record which are part of a
 
86
    key into to_key. If length == 0 then copy all bytes from the record that
 
87
    form a key.
 
88
 
 
89
  @param to_key      buffer that will be used as a key
 
90
  @param from_record full record to be copied from
 
91
  @param key_info    descriptor of the index
 
92
  @param key_length  specifies length of all keyparts that will be copied
 
93
*/
 
94
 
 
95
void key_copy(unsigned char *to_key, unsigned char *from_record, KEY *key_info, uint32_t key_length);
 
96
void key_copy(std::basic_string<unsigned char> &to_key,
 
97
              unsigned char *from_record, KEY *key_info, uint32_t key_length);
 
98
void key_restore(unsigned char *to_record, unsigned char *from_key, KEY *key_info,
 
99
                 uint16_t key_length);
 
100
void key_zero_nulls(unsigned char *tuple, KEY *key_info);
 
101
bool key_cmp_if_same(Table *form,const unsigned char *key,uint32_t index,uint32_t key_length);
 
102
void key_unpack(String *to,Table *form,uint32_t index);
 
103
bool is_key_used(Table *table, uint32_t idx, const MY_BITMAP *fields);
 
104
int key_cmp(KEY_PART_INFO *key_part, const unsigned char *key, uint32_t key_length);
 
105
extern "C" int key_rec_cmp(void *key_info, unsigned char *a, unsigned char *b);
 
106
#endif /* DRIZZLED_KEY_H */