← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/item/create.h

  • Committer: Eric Herman
  • Date: 2008-12-07 12:17:49 UTC
  • mto: (656.1.14 devel)
  • mto: This revision was merged to the branch mainline in revision 670.
  • Revision ID: eric@mysql.com-20081207121749-kv5yp8o1u3fxb0lz
added some essential notes to the README

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/item/create.h
1
 
/* Copyright (C) 2000-2006 MySQL AB
2
 
 
3
 
   This program is free software; you can redistribute it and/or modify
4
 
   it under the terms of the GNU General Public License as published by
5
 
   the Free Software Foundation; version 2 of the License.
6
 
 
7
 
   This program is distributed in the hope that it will be useful,
8
 
   but WITHOUT ANY WARRANTY; without even the implied warranty of
9
 
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10
 
   GNU General Public License for more details.
11
 
 
12
 
   You should have received a copy of the GNU General Public License
13
 
   along with this program; if not, write to the Free Software
14
 
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */
 
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
 */
15
19
 
16
20
/* Functions to create an item. Used by sql/sql_yacc.yy */
17
21
 
18
 
#ifndef ITEM_CREATE_H
19
 
#define ITEM_CREATE_H
 
22
#ifndef DRIZZLE_SERVER_ITEM_CREATE_H
 
23
#define DRIZZLE_SERVER_ITEM_CREATE_H
 
24
 
 
25
#include <drizzled/item/func.h>
 
26
 
 
27
struct udf_func;
20
28
 
21
29
/**
22
30
  Public function builder interface.
37
45
    Given the function name and list or arguments, this method creates
38
46
    an <code>Item</code> that represents the function call.
39
47
    In case or errors, a NULL item is returned, and an error is reported.
40
 
    Note that the <code>thd</code> object may be modified by the builder.
 
48
    Note that the <code>session</code> object may be modified by the builder.
41
49
    In particular, the following members/methods can be set/called,
42
50
    depending on the function called and the function possible side effects.
43
51
    <ul>
44
 
      <li><code>thd->lex->binlog_row_based_if_mixed</code></li>
45
 
      <li><code>thd->lex->current_context()</code></li>
46
 
      <li><code>thd->lex->safe_to_cache_query</code></li>
47
 
      <li><code>thd->lex->uncacheable(UNCACHEABLE_SIDEEFFECT)</code></li>
48
 
      <li><code>thd->lex->uncacheable(UNCACHEABLE_RAND)</code></li>
49
 
      <li><code>thd->lex->add_time_zone_tables_to_query_tables(thd)</code></li>
 
52
      <li><code>session->lex->binlog_row_based_if_mixed</code></li>
 
53
      <li><code>session->lex->current_context()</code></li>
 
54
      <li><code>session->lex->safe_to_cache_query</code></li>
 
55
      <li><code>session->lex->uncacheable(UNCACHEABLE_SIDEEFFECT)</code></li>
 
56
      <li><code>session->lex->uncacheable(UNCACHEABLE_RAND)</code></li>
 
57
      <li><code>session->lex->add_time_zone_tables_to_query_tables(session)</code></li>
50
58
    </ul>
51
 
    @param thd The current thread
 
59
    @param session The current thread
52
60
    @param name The function name
53
61
    @param item_list The list of arguments to the function, can be NULL
54
62
    @return An item representing the parsed function call, or NULL
55
63
  */
56
 
  virtual Item *create(THD *thd, LEX_STRING name, List<Item> *item_list) = 0;
 
64
  virtual Item *create(Session *session, LEX_STRING name, List<Item> *item_list) = 0;
57
65
 
58
66
protected:
59
67
  /** Constructor */
62
70
  virtual ~Create_func() {}
63
71
};
64
72
 
65
 
 
66
73
/**
67
74
  Function builder for qualified functions.
68
75
  This builder is used with functions call using a qualified function name
75
82
  /**
76
83
    The builder create method, for unqualified functions.
77
84
    This builder will use the current database for the database name.
78
 
    @param thd The current thread
 
85
    @param session The current thread
79
86
    @param name The function name
80
87
    @param item_list The list of arguments to the function, can be NULL
81
88
    @return An item representing the parsed function call
82
89
  */
83
 
  virtual Item *create(THD *thd, LEX_STRING name, List<Item> *item_list);
 
90
  virtual Item *create(Session *session, LEX_STRING name, List<Item> *item_list);
84
91
 
85
92
  /**
86
93
    The builder create method, for qualified functions.
87
 
    @param thd The current thread
 
94
    @param session The current thread
88
95
    @param db The database name
89
96
    @param name The function name
90
97
    @param use_explicit_name Should the function be represented as 'db.name'?
91
98
    @param item_list The list of arguments to the function, can be NULL
92
99
    @return An item representing the parsed function call
93
100
  */
94
 
  virtual Item* create(THD *thd, LEX_STRING db, LEX_STRING name,
 
101
  virtual Item* create(Session *session, LEX_STRING db, LEX_STRING name,
95
102
                       bool use_explicit_name, List<Item> *item_list) = 0;
96
103
 
97
104
protected:
104
111
 
105
112
/**
106
113
  Find the native function builder associated with a given function name.
107
 
  @param thd The current thread
 
114
  @param session The current thread
108
115
  @param name The native function name
109
116
  @return The native function builder associated with the name, or NULL
110
117
*/
111
 
extern Create_func * find_native_function_builder(THD *thd, LEX_STRING name);
 
118
extern Create_func * find_native_function_builder(Session *session, LEX_STRING name);
112
119
 
113
120
 
114
121
/**
115
122
  Find the function builder for qualified functions.
116
 
  @param thd The current thread
 
123
  @param session The current thread
117
124
  @return A function builder for qualified functions
118
125
*/
119
 
extern Create_qfunc * find_qualified_function_builder(THD *thd);
 
126
extern Create_qfunc * find_qualified_function_builder(Session *session);
120
127
 
121
128
 
122
129
/**
126
133
class Create_udf_func : public Create_func
127
134
{
128
135
public:
129
 
  virtual Item *create(THD *thd, LEX_STRING name, List<Item> *item_list);
 
136
  virtual Item *create(Session *session, LEX_STRING name, List<Item> *item_list);
130
137
 
131
138
  /**
132
139
    The builder create method, for User Defined Functions.
133
 
    @param thd The current thread
 
140
    @param session The current thread
134
141
    @param fct The User Defined Function metadata
135
142
    @param item_list The list of arguments to the function, can be NULL
136
143
    @return An item representing the parsed function call
137
144
  */
138
 
  Item *create(THD *thd, udf_func *fct, List<Item> *item_list);
 
145
  Item *create(Session *session, udf_func *fct, List<Item> *item_list);
139
146
 
140
147
  /** Singleton. */
141
148
  static Create_udf_func s_singleton;
148
155
};
149
156
 
150
157
Item*
151
 
create_func_char_cast(THD *thd, Item *a, int len, CHARSET_INFO *cs);
 
158
create_func_char_cast(Session *session, Item *a, int len, const CHARSET_INFO * const cs);
152
159
 
153
160
/**
154
161
  Builder for cast expressions.
155
 
  @param thd The current thread
 
162
  @param session The current thread
156
163
  @param a The item to cast
157
164
  @param cast_type the type casted into
158
165
  @param len TODO
160
167
  @param cs The character set
161
168
*/
162
169
Item *
163
 
create_func_cast(THD *thd, Item *a, Cast_target cast_type,
 
170
create_func_cast(Session *session, Item *a, Cast_target cast_type,
164
171
                 const char *len, const char *dec,
165
 
                 CHARSET_INFO *cs);
166
 
#endif
167
 
 
 
172
                 const CHARSET_INFO * const cs);
 
173
 
 
174
int item_create_init();
 
175
void item_create_cleanup();
 
176
 
 
177
#endif /* DRIZZLE_SERVER_ITEM_CREATE_H */