← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/cursor.h

  • Committer: Monty Taylor
  • Date: 2011-02-13 17:26:39 UTC
  • mfrom: (2157.2.2 give-in-to-pkg-config)
  • mto: This revision was merged to the branch mainline in revision 2166.
  • Revision ID: mordred@inaugust.com-20110213172639-nhy7i72sfhoq13ms
Merged in pkg-config fixes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/cursor.h
1
1
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2
2
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
3
3
 *
4
 
 *  Copyright (C) 2008 Sun Microsystems
 
4
 *  Copyright (C) 2008 Sun Microsystems, Inc.
5
5
 *
6
6
 *  This program is free software; you can redistribute it and/or modify
7
7
 *  it under the terms of the GNU General Public License as published by
23
23
#include <drizzled/xid.h>
24
24
#include <drizzled/discrete_interval.h>
25
25
#include <drizzled/identifier.h>
 
26
#include <drizzled/definitions.h>
 
27
#include <drizzled/key_map.h>
 
28
#include <drizzled/error_t.h>
26
29
 
27
30
/* Definitions for parameters to do with Cursor-routines */
28
31
 
29
32
#include <drizzled/thr_lock.h>
30
 
#include <drizzled/sql_string.h>
31
33
#include <drizzled/sql_list.h>
32
 
#include <drizzled/plugin/storage_engine.h>
33
34
#include <drizzled/handler_structs.h>
34
35
#include <drizzled/ha_statistics.h>
35
36
#include <drizzled/atomics.h>
36
37
 
37
 
#include <drizzled/message/table.pb.h>
38
 
 
39
 
/* Bits to show what an alter table will do */
40
 
#include <drizzled/sql_bitmap.h>
 
38
#include <drizzled/message/table.h>
41
39
 
42
40
#include <bitset>
43
41
#include <algorithm>
44
42
 
 
43
#include "drizzled/visibility.h"
 
44
 
45
45
namespace drizzled
46
46
{
47
47
 
49
49
 
50
50
typedef std::bitset<HA_MAX_ALTER_FLAGS> HA_ALTER_FLAGS;
51
51
 
52
 
extern uint64_t refresh_version;  /* Increments on each reload */
53
 
 
54
 
class Table;
55
 
class TableList;
56
 
class TableShare;
57
 
class Select_Lex_Unit;
 
52
class AlterInfo;
 
53
class CreateField;
58
54
class ForeignKeyInfo;
59
 
struct order_st;
60
 
 
61
55
class Item;
62
 
 
 
56
class Item_ident;
63
57
class LEX;
64
58
class Select_Lex;
65
 
class AlterInfo;
 
59
class Select_Lex_Unit;
 
60
class String;
 
61
class Table;
 
62
class TableList;
 
63
class TableShare;
66
64
class select_result;
67
 
class CreateField;
68
65
class sys_var_str;
69
 
class Item_ident;
 
66
struct Order;
70
67
 
71
68
typedef List<Item> List_item;
72
69
extern KEY_CREATE_INFO default_key_create_info;
76
73
 
77
74
typedef struct system_status_var system_status_var;
78
75
 
79
 
namespace optimizer
80
 
{
81
 
  class CostVector;
82
 
}
 
76
namespace optimizer { class CostVector; }
 
77
namespace plugin { class StorageEngine; }
83
78
 
84
79
/*
85
80
  bitmap with first N+1 bits set
144
139
  If a blob column has NULL value, then its length and blob data pointer
145
140
  must be set to 0.
146
141
*/
147
 
class Cursor
 
142
class DRIZZLED_API Cursor
148
143
{
 
144
  friend class SEAPITesterCursor;
 
145
  Table &table;               /* The current open table */
 
146
  plugin::StorageEngine &engine;      /* storage engine of this Cursor */
 
147
 
149
148
protected:
150
 
  TableShare *table_share;   /* The table definition */
151
 
  Table *table;               /* The current open table */
152
 
 
153
149
  ha_rows estimation_rows_to_insert;
154
 
  plugin::StorageEngine *engine;      /* storage engine of this Cursor */
 
150
 
155
151
public:
156
152
  inline plugin::StorageEngine *getEngine() const       /* table_type for handler */
157
153
  {
158
 
    return engine;
 
154
    return &engine;
159
155
  }
160
156
  unsigned char *ref;                           /* Pointer to current row */
161
157
  unsigned char *dup_ref;                       /* Pointer to duplicate row */
162
158
 
163
 
  TableShare *getShare() const
 
159
  TableShare *getShare();
 
160
 
 
161
  Table *getTable() const
164
162
  {
165
 
    return table_share;
 
163
    return &table;
166
164
  }
167
165
 
168
166
  ha_statistics stats;
211
209
  }
212
210
 
213
211
  /**
 
212
    Used by SHOW TABLE STATUS to get the current auto_inc from the engine
 
213
  */
 
214
  uint64_t getAutoIncrement()
 
215
  {
 
216
    return stats.auto_increment_value;
 
217
  }
 
218
 
 
219
  /**
214
220
    insert id for the current row (*autogenerated*; if not
215
221
    autogenerated, it's 0).
216
222
    At first successful insertion, this variable is stored into
223
229
  */
224
230
  Discrete_interval auto_inc_interval_for_cur_row;
225
231
 
226
 
  Cursor(plugin::StorageEngine &engine_arg, TableShare &share_arg);
 
232
  Cursor(plugin::StorageEngine &engine_arg, Table &share_arg);
227
233
  virtual ~Cursor(void);
228
234
  virtual Cursor *clone(memory::Root *mem_root);
229
235
 
230
236
  /* ha_ methods: pubilc wrappers for private virtual API */
231
237
 
232
 
  int ha_open(const TableIdentifier &identifier, Table *table, int mode, int test_if_locked);
233
 
  int startIndexScan(uint32_t idx, bool sorted);
 
238
  int ha_open(const identifier::Table &identifier, int mode, int test_if_locked);
 
239
  int startIndexScan(uint32_t idx, bool sorted) __attribute__ ((warn_unused_result));
234
240
  int endIndexScan();
235
 
  int startTableScan(bool scan);
 
241
  int startTableScan(bool scan) __attribute__ ((warn_unused_result));
236
242
  int endTableScan();
237
243
  int ha_reset();
238
244
 
246
252
    and doDeleteRecord() below.
247
253
  */
248
254
  int ha_external_lock(Session *session, int lock_type);
249
 
  int insertRecord(unsigned char * buf);
250
 
  int updateRecord(const unsigned char * old_data, unsigned char * new_data);
251
 
  int deleteRecord(const unsigned char * buf);
 
255
  int insertRecord(unsigned char * buf) __attribute__ ((warn_unused_result));
 
256
  int updateRecord(const unsigned char * old_data, unsigned char * new_data) __attribute__ ((warn_unused_result));
 
257
  int deleteRecord(const unsigned char * buf) __attribute__ ((warn_unused_result));
252
258
  void ha_release_auto_increment();
253
259
 
254
260
  /** to be actually called to get 'check()' functionality*/
267
273
 
268
274
  void adjust_next_insert_id_after_explicit_value(uint64_t nr);
269
275
  int update_auto_increment();
270
 
  virtual void change_table_ptr(Table *table_arg, TableShare *share);
271
276
 
272
277
  /* Estimates calculation */
273
278
  virtual double scan_time(void)
349
354
                                 const unsigned char * key,
350
355
                                 key_part_map keypart_map,
351
356
                                 enum ha_rkey_function find_flag);
352
 
  virtual int index_next(unsigned char *)
 
357
  virtual int index_next(unsigned char *) __attribute__ ((warn_unused_result))
353
358
   { return  HA_ERR_WRONG_COMMAND; }
354
359
  virtual int index_prev(unsigned char *)
355
360
   { return  HA_ERR_WRONG_COMMAND; }
475
480
    or partitioned.
476
481
 
477
482
    @note that one can NOT rely on table->in_use in store_lock().  It may
478
 
    refer to a different thread if called from mysql_lock_abort_for_thread().
 
483
    refer to a different thread if called from abortLockForThread().
479
484
 
480
485
    @note If the table is MERGE, store_lock() can return less locks
481
486
    than lock_count() claimed. This can happen when the MERGE children
522
527
    the corresponding 'ha_*' method above.
523
528
  */
524
529
 
525
 
  virtual int open(const char *, int , uint32_t ) { assert(0); return -1; };
526
 
  virtual int doOpen(const TableIdentifier &identifier, int mode, uint32_t test_if_locked);
 
530
  virtual int open(const char *, int , uint32_t ) { assert(0); return -1; }
 
531
  virtual int doOpen(const identifier::Table &identifier, int mode, uint32_t test_if_locked);
527
532
  virtual int doStartIndexScan(uint32_t idx, bool)
528
533
  { active_index= idx; return 0; }
529
534
  virtual int doEndIndexScan() { active_index= MAX_KEY; return 0; }
534
539
    if rnd_init allocates the cursor, second call should position it
535
540
    to the start of the table, no need to deallocate and allocate it again
536
541
  */
537
 
  virtual int doStartTableScan(bool scan)= 0;
 
542
  virtual int doStartTableScan(bool scan) __attribute__ ((warn_unused_result)) = 0;
538
543
  virtual int doEndTableScan() { return 0; }
539
544
  virtual int doInsertRecord(unsigned char *)
540
545
  {
583
588
  {
584
589
    return 0;
585
590
  }
586
 
  virtual void release_auto_increment(void) { return; };
 
591
  virtual void release_auto_increment(void) { return; }
587
592
  /** admin commands - called from mysql_admin_table */
588
593
  virtual int check(Session *)
589
594
  { return HA_ADMIN_NOT_IMPLEMENTED; }
640
645
void ha_init_errors(void);
641
646
 
642
647
class SortField;
643
 
SortField *make_unireg_sortorder(order_st *order, uint32_t *length,
 
648
SortField *make_unireg_sortorder(Order *order, uint32_t *length,
644
649
                                 SortField *sortorder);
645
650
int setup_order(Session *session, Item **ref_pointer_array, TableList *tables,
646
 
                List<Item> &fields, List <Item> &all_fields, order_st *order);
 
651
                List<Item> &fields, List <Item> &all_fields, Order *order);
647
652
int setup_group(Session *session, Item **ref_pointer_array, TableList *tables,
648
 
                List<Item> &fields, List<Item> &all_fields, order_st *order,
 
653
                List<Item> &fields, List<Item> &all_fields, Order *order,
649
654
                bool *hidden_group_fields);
650
655
bool fix_inner_refs(Session *session, List<Item> &all_fields, Select_Lex *select,
651
656
                    Item **ref_pointer_array);
654
659
                   uint64_t setup_tables_done_option);
655
660
void free_underlaid_joins(Session *session, Select_Lex *select);
656
661
 
657
 
bool mysql_handle_derived(LEX *lex, bool (*processor)(Session *session,
 
662
bool handle_derived(LEX *lex, bool (*processor)(Session *session,
658
663
                                                      LEX *lex,
659
664
                                                      TableList *table));
660
 
bool mysql_derived_prepare(Session *session, LEX *lex, TableList *t);
661
 
bool mysql_derived_filling(Session *session, LEX *lex, TableList *t);
 
665
bool derived_prepare(Session *session, LEX *lex, TableList *t);
 
666
bool derived_filling(Session *session, LEX *lex, TableList *t);
662
667
int prepare_create_field(CreateField *sql_field,
663
668
                         uint32_t *blob_columns,
664
669
                         int *timestamps, int *timestamps_with_niladic);
665
670
 
666
 
bool mysql_create_table(Session *session,
667
 
                        TableIdentifier &identifier,
668
 
                        HA_CREATE_INFO *create_info,
669
 
                        message::Table &table_proto,
670
 
                        AlterInfo *alter_info,
671
 
                        bool tmp_table, uint32_t select_field_count,
672
 
                        bool is_if_not_exists);
673
 
 
674
 
bool mysql_create_table_no_lock(Session *session,
675
 
                                TableIdentifier &identifier,
676
 
                                HA_CREATE_INFO *create_info,
677
 
                                message::Table &table_proto,
678
 
                                AlterInfo *alter_info,
679
 
                                bool tmp_table, uint32_t select_field_count,
680
 
                                bool is_if_not_exists);
681
 
 
682
 
bool mysql_create_like_table(Session* session,
683
 
                             TableIdentifier &destination_identifier,
684
 
                             TableList* table, TableList* src_table,
685
 
                             message::Table &create_table_proto,
686
 
                             bool is_if_not_exists,
687
 
                             bool is_engine_set);
688
 
 
689
 
bool mysql_rename_table(Session &session,
 
671
bool create_table(Session *session,
 
672
                  const identifier::Table &identifier,
 
673
                  HA_CREATE_INFO *create_info,
 
674
                  message::Table &table_proto,
 
675
                  AlterInfo *alter_info,
 
676
                  bool tmp_table, uint32_t select_field_count,
 
677
                  bool is_if_not_exists);
 
678
 
 
679
bool create_table_no_lock(Session *session,
 
680
                          const identifier::Table &identifier,
 
681
                          HA_CREATE_INFO *create_info,
 
682
                          message::Table &table_proto,
 
683
                          AlterInfo *alter_info,
 
684
                          bool tmp_table, uint32_t select_field_count,
 
685
                          bool is_if_not_exists);
 
686
 
 
687
bool create_like_table(Session* session,
 
688
                       identifier::Table::const_reference destination_identifier,
 
689
                       identifier::Table::const_reference source_identifier,
 
690
                       message::Table &create_table_proto,
 
691
                       bool is_if_not_exists,
 
692
                       bool is_engine_set);
 
693
 
 
694
bool rename_table(Session &session,
690
695
                        plugin::StorageEngine *base,
691
 
                        TableIdentifier &old_identifier,
692
 
                        TableIdentifier &new_identifier);
 
696
                        const identifier::Table &old_identifier,
 
697
                        const identifier::Table &new_identifier);
693
698
 
694
 
bool mysql_prepare_update(Session *session, TableList *table_list,
695
 
                          Item **conds, uint32_t order_num, order_st *order);
696
 
int mysql_update(Session *session,TableList *tables,List<Item> &fields,
 
699
bool prepare_update(Session *session, TableList *table_list,
 
700
                          Item **conds, uint32_t order_num, Order *order);
 
701
int update_query(Session *session,TableList *tables,List<Item> &fields,
697
702
                 List<Item> &values,COND *conds,
698
 
                 uint32_t order_num, order_st *order, ha_rows limit,
 
703
                 uint32_t order_num, Order *order, ha_rows limit,
699
704
                 enum enum_duplicates handle_duplicates, bool ignore);
700
 
bool mysql_prepare_insert(Session *session, TableList *table_list, Table *table,
 
705
bool prepare_insert(Session *session, TableList *table_list, Table *table,
701
706
                          List<Item> &fields, List_item *values,
702
707
                          List<Item> &update_fields,
703
708
                          List<Item> &update_values, enum_duplicates duplic,
704
709
                          COND **where, bool select_insert,
705
710
                          bool check_fields, bool abort_on_warning);
706
 
bool mysql_insert(Session *session,TableList *table,List<Item> &fields,
 
711
bool insert_query(Session *session,TableList *table,List<Item> &fields,
707
712
                  List<List_item> &values, List<Item> &update_fields,
708
713
                  List<Item> &update_values, enum_duplicates flag,
709
714
                  bool ignore);
710
715
int check_that_all_fields_are_given_values(Session *session, Table *entry,
711
716
                                           TableList *table_list);
712
 
int mysql_prepare_delete(Session *session, TableList *table_list, Item **conds);
713
 
bool mysql_delete(Session *session, TableList *table_list, COND *conds,
 
717
int prepare_delete(Session *session, TableList *table_list, Item **conds);
 
718
bool delete_query(Session *session, TableList *table_list, COND *conds,
714
719
                  SQL_LIST *order, ha_rows rows, uint64_t options,
715
720
                  bool reset_auto_increment);
716
 
bool mysql_truncate(Session& session, TableList *table_list);
 
721
bool truncate(Session& session, TableList *table_list);
717
722
TableShare *get_table_share(Session *session, TableList *table_list, char *key,
718
723
                             uint32_t key_length, uint32_t db_flags, int *error);
719
724
TableShare *get_cached_table_share(const char *db, const char *table_name);
722
727
void close_handle_and_leave_table_as_lock(Table *table);
723
728
bool wait_for_tables(Session *session);
724
729
bool table_is_used(Table *table, bool wait_for_name_lock);
725
 
Table *drop_locked_tables(Session *session, const drizzled::TableIdentifier &identifier);
726
 
void abort_locked_tables(Session *session, const drizzled::TableIdentifier &identifier);
 
730
Table *drop_locked_tables(Session *session, const drizzled::identifier::Table &identifier);
 
731
void abort_locked_tables(Session *session, const drizzled::identifier::Table &identifier);
727
732
extern Field *not_found_field;
728
733
extern Field *view_ref_found;
729
734