Drizzled Public API Documentation

cursor.h
1 /* - mode: c; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
3  *
4  * Copyright (C) 2009 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; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
21 #pragma once
22 
23 #include <drizzled/cursor.h>
24 
25 #include <plugin/function_engine/function.h>
26 #include <drizzled/base.h>
27 
29 {
32  size_t row_cache_position;
33  std::vector<unsigned char> row_cache;
34  drizzled::ha_rows estimate_of_rows;
35  drizzled::ha_rows rows_returned;
36 
37  void wipeCache();
38 
39  std::vector <unsigned char> record_buffer; // for pack_row
40  uint32_t max_row_length();
41  unsigned int pack_row(const unsigned char *record);
42 
43 public:
45  drizzled::Table &table_arg);
46  ~FunctionCursor() {}
47 
48  int open(const char *name, int mode, uint32_t test_if_locked);
49 
50  int close(void);
51 
52  int reset()
53  {
54  return extra(drizzled::HA_EXTRA_RESET_STATE);
55  }
56 
57  int doStartTableScan(bool scan);
58 
59  /* get the next row and copy it into buf */
60  int rnd_next(unsigned char *buf);
61 
62  /* locate row pointed to by pos, copy it into buf */
63  int rnd_pos(unsigned char *buf, unsigned char *pos);
64 
65  int doEndTableScan();
66 
67  int extra(enum drizzled::ha_extra_function);
68 
69  /* record position of a record for reordering */
70  void position(const unsigned char *record);
71 
72  int info(uint32_t flag);
73 
77  drizzled::ha_rows estimate_rows_upper_bound()
78  {
79  return estimate_of_rows;
80  }
81 
82  void get_auto_increment(uint64_t, uint64_t,
83  uint64_t,
84  uint64_t *,
85  uint64_t *)
86  {}
87 };
88 
int reset()
Definition: cursor.h:52
int doStartTableScan(bool scan)
Definition: cursor.cc:70
drizzled::ha_rows estimate_rows_upper_bound()
Definition: cursor.h:77