structs.h 7.36 KB
Newer Older
unknown's avatar
unknown committed
1
/* Copyright (C) 2000 MySQL AB & MySQL Finland AB & TCX DataKonsult AB
unknown's avatar
unknown committed
2

unknown's avatar
unknown committed
3 4 5 6
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
unknown's avatar
unknown committed
7

unknown's avatar
unknown committed
8 9 10 11
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
unknown's avatar
unknown committed
12

unknown's avatar
unknown committed
13 14 15 16 17 18 19 20 21 22
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */


/* The old structures from unireg */

struct st_table;
class Field;

unknown's avatar
unknown committed
23 24
typedef struct st_lex_string
{
25 26 27 28
  char *str;
  uint length;
} LEX_STRING;

unknown's avatar
unknown committed
29 30 31 32 33 34 35 36 37
typedef struct st_lex_string_with_init :public st_lex_string
{
  st_lex_string_with_init(const char *str_arg, uint length_arg)
  {
    str= (char*) str_arg;
    length= length_arg;
  }
} LEX_STRING_WITH_INIT;

38 39 40 41 42 43 44

typedef struct st_date_time_format {
  uchar positions[8];
  char  time_separator;			/* Separator between hour and minute */
  uint flag;				/* For future */
  LEX_STRING format;
} DATE_TIME_FORMAT;
unknown's avatar
unknown committed
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71


typedef struct st_keyfile_info {	/* used with ha_info() */
  byte ref[MAX_REFLENGTH];		/* Pointer to current row */
  byte dupp_ref[MAX_REFLENGTH];		/* Pointer to dupp row */
  uint ref_length;			/* Length of ref (1-8) */
  uint block_size;			/* index block size */
  File filenr;				/* (uniq) filenr for table */
  ha_rows records;			/* Records i datafilen */
  ha_rows deleted;			/* Deleted records */
  ulonglong data_file_length;		/* Length off data file */
  ulonglong max_data_file_length;	/* Length off data file */
  ulonglong index_file_length;
  ulonglong max_index_file_length;
  ulonglong delete_length;		/* Free bytes */
  ulonglong auto_increment_value;
  int errkey,sortkey;			/* Last errorkey and sorted by */
  time_t create_time;			/* When table was created */
  time_t check_time;
  time_t update_time;
  ulong mean_rec_length;		/* physical reclength */
} KEYFILE_INFO;


typedef struct st_key_part_info {	/* Info about a key part */
  Field *field;
  uint	offset;				/* offset in record (from 0) */
unknown's avatar
unknown committed
72
  uint	null_offset;			/* Offset to null_bit in record */
unknown's avatar
unknown committed
73 74 75 76 77 78
  uint16 length;			/* Length of key_part */
  uint16 store_length;
  uint16 key_type;
  uint16 fieldnr;			/* Fieldnum in UNIREG */
  uint8 key_part_flag;			/* 0 or HA_REVERSE_SORT */
  uint8 type;
unknown's avatar
unknown committed
79
  uint8 null_bit;			/* Position to null_bit */
unknown's avatar
unknown committed
80 81 82 83 84 85 86 87 88
} KEY_PART_INFO ;


typedef struct st_key {
  uint	key_length;			/* Tot length of key */
  uint	flags;				/* dupp key and pack flags */
  uint	key_parts;			/* How many key_parts */
  uint  extra_length;
  uint	usable_key_parts;		/* Should normally be = key_parts */
89
  enum  ha_key_alg algorithm;
unknown's avatar
unknown committed
90 91
  KEY_PART_INFO *key_part;
  char	*name;				/* Name of key */
92 93 94 95 96 97
  /*
    Array of AVG(#records with the same field value) for 1st ... Nth key part.
    0 means 'not known'.
    For temporary heap tables this member is NULL.
  */
  ulong *rec_per_key;
98
  union {
99
    int  bdb_return_if_eq;
100
  } handler;
unknown's avatar
unknown committed
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
} KEY;


struct st_join_table;

typedef struct st_reginfo {		/* Extra info about reg */
  struct st_join_table *join_tab;	/* Used by SELECT() */
  enum thr_lock_type lock_type;		/* How database is used */
  bool not_exists_optimize;
  bool impossible_range;
} REGINFO;


struct st_read_record;				/* For referense later */
class SQL_SELECT;
class THD;
class handler;

typedef struct st_read_record {			/* Parameter to read_record */
  struct st_table *table;			/* Head-form */
  handler *file;
  struct st_table **forms;			/* head and ref forms */
  int (*read_record)(struct st_read_record *);
  THD *thd;
  SQL_SELECT *select;
  uint cache_records;
  uint ref_length,struct_length,reclength,rec_cache_size,error_offset;
  uint index;
  byte *ref_pos;				/* pointer to form->refpos */
  byte *record;
unknown's avatar
unknown committed
131
  byte *rec_buf;                /* to read field values  after filesort */
unknown's avatar
unknown committed
132 133
  byte	*cache,*cache_pos,*cache_end,*read_positions;
  IO_CACHE *io_cache;
134
  bool print_error, ignore_not_found_rows;
unknown's avatar
unknown committed
135 136
} READ_RECORD;

137

138 139 140 141 142 143 144 145
/*
  Originally MySQL used TIME structure inside server only, but since
  4.1 it's exported to user in the new client API. Define aliases for
  new names to keep existing code simple.
*/

typedef struct st_mysql_time TIME;
typedef enum enum_mysql_timestamp_type timestamp_type;
unknown's avatar
unknown committed
146

147

unknown's avatar
unknown committed
148
typedef struct {
149 150
  ulong year,month,day,hour;
  ulonglong minute,second,second_part;
unknown's avatar
unknown committed
151 152 153 154
  bool neg;
} INTERVAL;


155 156 157 158 159 160 161 162
typedef struct st_known_date_time_format {
  const char *format_name;
  const char *date_format;
  const char *datetime_format;
  const char *time_format;
} KNOWN_DATE_TIME_FORMAT;


unknown's avatar
unknown committed
163 164 165
enum SHOW_TYPE
{
  SHOW_UNDEF,
166 167
  SHOW_LONG, SHOW_LONGLONG, SHOW_INT, SHOW_CHAR, SHOW_CHAR_PTR, SHOW_DOUBLE,
  SHOW_BOOL, SHOW_MY_BOOL, SHOW_OPENTABLES, SHOW_STARTTIME, SHOW_QUESTION,
168
  SHOW_LONG_CONST, SHOW_INT_CONST, SHOW_HAVE, SHOW_SYS, SHOW_HA_ROWS,
169
  SHOW_VARS,
unknown's avatar
unknown committed
170
#ifdef HAVE_OPENSSL
unknown's avatar
unknown committed
171 172 173 174 175 176 177 178 179 180 181 182
  SHOW_SSL_CTX_SESS_ACCEPT, 	SHOW_SSL_CTX_SESS_ACCEPT_GOOD,
  SHOW_SSL_GET_VERSION, 	SHOW_SSL_CTX_GET_SESSION_CACHE_MODE,
  SHOW_SSL_CTX_SESS_CB_HITS, 	SHOW_SSL_CTX_SESS_ACCEPT_RENEGOTIATE,
  SHOW_SSL_CTX_SESS_NUMBER, 	SHOW_SSL_SESSION_REUSED,
  SHOW_SSL_CTX_SESS_GET_CACHE_SIZE, SHOW_SSL_GET_CIPHER,
  SHOW_SSL_GET_DEFAULT_TIMEOUT,	SHOW_SSL_GET_VERIFY_MODE,
  SHOW_SSL_CTX_GET_VERIFY_MODE, SHOW_SSL_GET_VERIFY_DEPTH,
  SHOW_SSL_CTX_GET_VERIFY_DEPTH, SHOW_SSL_CTX_SESS_CONNECT,
  SHOW_SSL_CTX_SESS_CONNECT_RENEGOTIATE, SHOW_SSL_CTX_SESS_CONNECT_GOOD,
  SHOW_SSL_CTX_SESS_HITS, SHOW_SSL_CTX_SESS_MISSES,
  SHOW_SSL_CTX_SESS_TIMEOUTS, SHOW_SSL_CTX_SESS_CACHE_FULL,
  SHOW_SSL_GET_CIPHER_LIST,
unknown's avatar
unknown committed
183
#endif /* HAVE_OPENSSL */
184
  SHOW_RPL_STATUS, SHOW_SLAVE_RUNNING,
185 186
  SHOW_KEY_CACHE_LONG, SHOW_KEY_CACHE_CONST_LONG,
  SHOW_LONG_STATUS, SHOW_LONG_CONST_STATUS
unknown's avatar
unknown committed
187
};
188 189

enum SHOW_COMP_OPTION { SHOW_OPTION_YES, SHOW_OPTION_NO, SHOW_OPTION_DISABLED};
190 191 192

extern const char *show_comp_option_name[];

unknown's avatar
unknown committed
193
typedef int *(*update_var)(THD *, struct show_var_st *);
unknown's avatar
unknown committed
194

195

unknown's avatar
unknown committed
196
typedef struct show_var_st {
unknown's avatar
unknown committed
197 198 199
  const char *name;
  char *value;
  SHOW_TYPE type;
unknown's avatar
unknown committed
200
} SHOW_VAR;
unknown's avatar
unknown committed
201

unknown's avatar
unknown committed
202

unknown's avatar
unknown committed
203 204 205 206
typedef struct	st_lex_user {
  LEX_STRING user, host, password;
} LEX_USER;

207

208
typedef struct user_resources {
209
  uint questions, updates, connections, bits;
210 211
} USER_RESOURCES;

212
typedef struct  user_conn {
213 214 215
  char *user, *host;
  uint len, connections, conn_per_hour, updates, questions, user_len;
  USER_RESOURCES user_resources;
216
  time_t intime;
217
} USER_CONN;
unknown's avatar
unknown committed
218 219 220 221 222
	/* Bits in form->update */
#define REG_MAKE_DUPP		1	/* Make a copy of record when read */
#define REG_NEW_RECORD		2	/* Write a new record if not found */
#define REG_UPDATE		4	/* Uppdate record */
#define REG_DELETE		8	/* Delete found record */
unknown's avatar
unknown committed
223
#define REG_PROG		16	/* User is updating database */
unknown's avatar
unknown committed
224 225 226 227
#define REG_CLEAR_AFTER_WRITE	32
#define REG_MAY_BE_UPDATED	64
#define REG_AUTO_UPDATE		64	/* Used in D-forms for scroll-tables */
#define REG_OVERWRITE		128
unknown's avatar
unknown committed
228
#define REG_SKIP_DUP		256
unknown's avatar
unknown committed
229 230 231 232

	/* Bits in form->status */
#define STATUS_NO_RECORD	(1+2)	/* Record isn't usably */
#define STATUS_GARBAGE		1
233
#define STATUS_NOT_FOUND	2	/* No record in database when needed */
unknown's avatar
unknown committed
234 235 236
#define STATUS_NO_PARENT	4	/* Parent record wasn't found */
#define STATUS_NOT_READ		8	/* Record isn't read */
#define STATUS_UPDATED		16	/* Record is updated by formula */
237
#define STATUS_NULL_ROW		32	/* table->null_row is set */
unknown's avatar
unknown committed
238
#define STATUS_DELETED		64