Drizzled Public API Documentation

handler_structs.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, Inc.
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 #pragma once
21 
22 #if TIME_WITH_SYS_TIME
23 # include <sys/time.h>
24 # include <time.h>
25 #else
26 # if HAVE_SYS_TIME_H
27 # include <sys/time.h>
28 # else
29 # include <time.h>
30 # endif
31 #endif
32 
33 #include <drizzled/base.h>
34 #include <drizzled/definitions.h>
35 #include <drizzled/structs.h>
36 #include <drizzled/util/data_ref.h>
37 
38 namespace drizzled {
39 
41 {
42  const charset_info_st *table_charset, *default_table_charset;
43  const char *alias;
44  uint64_t auto_increment_value;
45  uint32_t table_options;
46  uint32_t used_fields;
47  plugin::StorageEngine *db_type;
48  bool table_existed; /* 1 in create if table existed */
49 
51  table_charset(0),
52  default_table_charset(0),
53  alias(0),
54  auto_increment_value(0),
55  table_options(0),
56  used_fields(0),
57  db_type(0),
58  table_existed(0)
59  { }
61 
63 {
64  KeyInfo *key_info_buffer;
65  uint32_t key_count;
66  uint32_t index_drop_count;
67  uint32_t *index_drop_buffer;
68  uint32_t index_add_count;
69  uint32_t *index_add_buffer;
70  void *data;
71 
73  key_info_buffer(0),
74  key_count(0),
75  index_drop_count(0),
76  index_drop_buffer(0),
77  index_add_count(0),
78  index_add_buffer(0),
79  data(0)
80  { }
81 
83 
84 
86 {
87  KEY_CREATE_INFO() :
88  algorithm(HA_KEY_ALG_UNDEF),
89  block_size(0)
90  {
91  }
92 
93  ha_key_alg algorithm;
94  uint32_t block_size;
95  str_ref comment;
96 };
97 
98 
99 typedef struct st_range_seq_if
100 {
101  /*
102  Initialize the traversal of range sequence
103 
104  SYNOPSIS
105  init()
106  init_params The seq_init_param parameter
107  n_ranges The number of ranges obtained
108  flags A combination of HA_MRR_SINGLE_POINT, HA_MRR_FIXED_KEY
109 
110  RETURN
111  An opaque value to be used as RANGE_SEQ_IF::next() parameter
112  */
113  range_seq_t (*init)(void *init_params, uint32_t n_ranges, uint32_t flags);
114 
115 
116  /*
117  Get the next range in the range sequence
118 
119  SYNOPSIS
120  next()
121  seq The value returned by RANGE_SEQ_IF::init()
122  range OUT Information about the next range
123 
124  RETURN
125  0 - Ok, the range structure filled with info about the next range
126  1 - No more ranges
127  */
128  uint32_t (*next) (range_seq_t seq, KEY_MULTI_RANGE *range);
129 } RANGE_SEQ_IF;
130 
131 } /* namespace drizzled */
132