MySQL 5.6.14 Source Code Document
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ha_prototypes.h
Go to the documentation of this file.
1 /*****************************************************************************
2 
3 Copyright (c) 2006, 2013, Oracle and/or its affiliates. All Rights Reserved.
4 
5 This program is free software; you can redistribute it and/or modify it under
6 the terms of the GNU General Public License as published by the Free Software
7 Foundation; version 2 of the License.
8 
9 This program is distributed in the hope that it will be useful, but WITHOUT
10 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
12 
13 You should have received a copy of the GNU General Public License along with
14 this program; if not, write to the Free Software Foundation, Inc.,
15 51 Franklin Street, Suite 500, Boston, MA 02110-1335 USA
16 
17 *****************************************************************************/
18 
19 /*******************************************************************/
27 #ifndef HA_INNODB_PROTOTYPES_H
28 #define HA_INNODB_PROTOTYPES_H
29 
30 #include "my_dbug.h"
31 #include "mysqld_error.h"
32 #include "my_compare.h"
33 #include "my_sys.h"
34 #include "m_string.h"
35 #include "debug_sync.h"
36 
37 #include "trx0types.h"
38 #include "m_ctype.h" /* CHARSET_INFO */
39 
40 // Forward declarations
41 class Field;
42 struct fts_string_t;
43 
44 /*********************************************************************/
47 UNIV_INTERN
48 ulint
49 innobase_convert_string(
50 /*====================*/
51  void* to,
52  ulint to_length,
54  CHARSET_INFO* to_cs,
55  const void* from,
56  ulint from_length,
57  CHARSET_INFO* from_cs,
59  uint* errors);
62 /*******************************************************************/
71 UNIV_INTERN
72 ulint
73 innobase_raw_format(
74 /*================*/
75  const char* data,
76  ulint data_len,
78  ulint charset_coll,
79  char* buf,
80  ulint buf_size);
83 /*****************************************************************/
85 UNIV_INTERN
86 void
87 innobase_invalidate_query_cache(
88 /*============================*/
89  trx_t* trx,
91  const char* full_name,
96  ulint full_name_len);
99 /*****************************************************************/
103 UNIV_INTERN
104 char*
105 innobase_convert_name(
106 /*==================*/
107  char* buf,
108  ulint buflen,
109  const char* id,
110  ulint idlen,
111  THD* thd,
112  ibool table_id);
115 /******************************************************************/
122 UNIV_INTERN
123 ibool
124 thd_is_replication_slave_thread(
125 /*============================*/
126  THD* thd);
128 /******************************************************************/
133 UNIV_INTERN
134 enum durability_properties
135 thd_requested_durability(
136 /*=====================*/
137  const THD* thd)
138  __attribute__((nonnull, warn_unused_result));
139 
140 /******************************************************************/
146 UNIV_INTERN
147 ibool
148 thd_has_edited_nontrans_tables(
149 /*===========================*/
150  THD* thd);
152 /*************************************************************/
154 UNIV_INTERN
155 void
156 innobase_mysql_print_thd(
157 /*=====================*/
158  FILE* f,
159  THD* thd,
160  uint max_query_len);
163 /*************************************************************/
167 UNIV_INTERN
168 int
169 innobase_mysql_cmp(
170 /*===============*/
171  int mysql_type,
172  uint charset_number,
173  const unsigned char* a,
174  unsigned int a_length,
176  const unsigned char* b,
177  unsigned int b_length)
179  __attribute__((nonnull, warn_unused_result));
180 /**************************************************************/
185 UNIV_INTERN
186 ulint
187 get_innobase_type_from_mysql_type(
188 /*==============================*/
189  ulint* unsigned_flag,
194  const void* field)
195  __attribute__((nonnull));
196 
197 /******************************************************************/
199 UNIV_INTERN
200 void
201 innobase_get_cset_width(
202 /*====================*/
203  ulint cset,
204  ulint* mbminlen,
205  ulint* mbmaxlen);
207 /******************************************************************/
210 UNIV_INTERN
211 int
212 innobase_strcasecmp(
213 /*================*/
214  const char* a,
215  const char* b);
217 /******************************************************************/
221 UNIV_INTERN
222 int
223 innobase_wildcasecmp(
224 /*=================*/
225  const char* a,
226  const char* b);
228 /******************************************************************/
231 UNIV_INTERN
232 const char*
233 innobase_basename(
234 /*==============*/
235  const char* path_name);
237 /******************************************************************/
240 UNIV_INTERN
241 ibool
242 thd_is_select(
243 /*==========*/
244  const THD* thd);
246 /******************************************************************/
248 UNIV_INTERN
249 void
250 innobase_convert_from_table_id(
251 /*===========================*/
252  struct charset_info_st* cs,
253  char* to,
254  const char* from,
255  ulint len);
257 /******************************************************************/
259 UNIV_INTERN
260 void
261 innobase_convert_from_id(
262 /*=====================*/
263  struct charset_info_st* cs,
264  char* to,
265  const char* from,
266  ulint len);
268 /******************************************************************/
270 UNIV_INTERN
271 void
272 innobase_casedn_str(
273 /*================*/
274  char* a);
276 /**********************************************************************/
279 UNIV_INTERN
280 struct charset_info_st*
281 innobase_get_charset(
282 /*=================*/
283  THD* thd);
284 /**********************************************************************/
287 UNIV_INTERN
288 const char*
289 innobase_get_stmt(
290 /*==============*/
291  THD* thd,
292  size_t* length)
293  __attribute__((nonnull));
294 /******************************************************************/
300 UNIV_INTERN
301 ulint
302 innobase_get_at_most_n_mbchars(
303 /*===========================*/
304  ulint charset_id,
305  ulint prefix_len,
308  ulint data_len,
309  const char* str);
311 /*************************************************************/
314 UNIV_INTERN
315 enum icp_result
316 innobase_index_cond(
317 /*================*/
318  void* file)
319  __attribute__((nonnull, warn_unused_result));
320 /******************************************************************/
324 UNIV_INTERN
325 ibool
326 thd_supports_xa(
327 /*============*/
328  THD* thd);
331 /******************************************************************/
334 UNIV_INTERN
335 ulong
336 thd_lock_wait_timeout(
337 /*==================*/
338  THD* thd);
340 /******************************************************************/
342 UNIV_INTERN
343 void
344 thd_set_lock_wait_time(
345 /*===================*/
346  THD* thd,
347  ulint value);
349 /**********************************************************************/
354 UNIV_INTERN
355 ulint
356 innobase_get_table_cache_size(void);
357 /*===============================*/
358 
359 /**********************************************************************/
365 UNIV_INTERN
366 ulint
367 innobase_get_lower_case_table_names(void);
368 /*=====================================*/
369 
370 /*****************************************************************/
373 UNIV_INTERN
374 int
375 innobase_close_thd(
376 /*===============*/
377  THD* thd);
379 /*************************************************************/
381 UNIV_INTERN
382 ulint
383 innobase_mysql_fts_get_token(
384 /*=========================*/
385  CHARSET_INFO* charset,
386  const byte* start,
387  const byte* end,
389  fts_string_t* token,
390  ulint* offset);
394 /******************************************************************/
396 UNIV_INTERN
397 int
398 innobase_fts_text_case_cmp(
399 /*=======================*/
400  const void* cs,
401  const void* p1,
402  const void* p2);
404 /******************************************************************/
406 UNIV_INTERN
407 int
408 innobase_fts_string_cmp(
409 /*====================*/
410  const void* cs,
411  const void* p1,
412  const void* p2);
414 /****************************************************************/
417 UNIV_INTERN
418 CHARSET_INFO*
419 innobase_get_fts_charset(
420 /*=====================*/
421  int mysql_type,
422  uint charset_number);
423 /******************************************************************/
426 UNIV_INTERN
427 ibool
428 thd_trx_is_read_only(
429 /*=================*/
430  THD* thd);
432 /******************************************************************/
436 UNIV_INTERN
437 ibool
438 thd_trx_is_auto_commit(
439 /*===================*/
440  THD* thd);
442 /*****************************************************************/
446 UNIV_INTERN
447 void
448 innobase_format_name(
449 /*==================*/
450  char* buf,
452  ulint buflen,
453  const char* name,
455  ibool is_index_name)
456  __attribute__((nonnull));
457 
459 enum ib_log_level_t {
460  IB_LOG_LEVEL_INFO,
461  IB_LOG_LEVEL_WARN,
462  IB_LOG_LEVEL_ERROR,
463  IB_LOG_LEVEL_FATAL
464 };
465 
466 /******************************************************************/
477 UNIV_INTERN
478 void
479 ib_errf(
480 /*====*/
481  THD* thd,
482  ib_log_level_t level,
483  ib_uint32_t code,
484  const char* format,
485  ...)
486  __attribute__((format(printf, 4, 5)));
487 
488 /******************************************************************/
498 UNIV_INTERN
499 void
500 ib_senderrf(
501 /*========*/
502  THD* thd,
503  ib_log_level_t level,
504  ib_uint32_t code,
505  ...);
507 /******************************************************************/
510 UNIV_INTERN
511 void
512 ib_logf(
513 /*====*/
514  ib_log_level_t level,
515  const char* format,
516  ...)
517  __attribute__((format(printf, 2, 3)));
518 
519 /******************************************************************/
522 UNIV_INTERN
523 const char*
524 server_get_hostname();
525 /*=================*/
526 
527 /******************************************************************/
530 UNIV_INTERN
531 const char*
532 innobase_get_err_msg(
533 /*=================*/
534  int error_code);
536 /*********************************************************************/
554 UNIV_INTERN
555 ulonglong
556 innobase_next_autoinc(
557 /*==================*/
558  ulonglong current,
559  ulonglong need,
560  ulonglong step,
561  ulonglong offset,
562  ulonglong max_value)
563  __attribute__((pure, warn_unused_result));
564 
565 /********************************************************************/
568 UNIV_INTERN
569 ulonglong
570 innobase_get_int_col_max_value(
571 /*===========================*/
572  const Field* field)
573  __attribute__((nonnull, pure, warn_unused_result));
574 
575 /**********************************************************************
576 Check if the length of the identifier exceeds the maximum allowed.
577 The input to this function is an identifier in charset my_charset_filename.
578 return true when length of identifier is too long. */
579 UNIV_INTERN
580 my_bool
581 innobase_check_identifier_length(
582 /*=============================*/
583  const char* id); /* in: identifier to check. it must belong
584  to charset my_charset_filename */
585 
586 /**********************************************************************
587 Converts an identifier from my_charset_filename to UTF-8 charset. */
588 uint
589 innobase_convert_to_system_charset(
590 /*===============================*/
591  char* to, /* out: converted identifier */
592  const char* from, /* in: identifier to convert */
593  ulint len, /* in: length of 'to', in bytes */
594  uint* errors); /* out: error return */
595 
596 /**********************************************************************
597 Converts an identifier from my_charset_filename to UTF-8 charset. */
598 uint
599 innobase_convert_to_filename_charset(
600 /*=================================*/
601  char* to, /* out: converted identifier */
602  const char* from, /* in: identifier to convert */
603  ulint len); /* in: length of 'to', in bytes */
604 
605 
606 #endif /* HA_INNODB_PROTOTYPES_H */