mysql.h 23 KB
Newer Older
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
1
/* Copyright (C) 2000-2003 MySQL AB
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
2 3 4 5 6 7 8

   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.

   This program is distributed in the hope that it will be useful,
bk@work.mysql.com's avatar
bk@work.mysql.com committed
9
   but WITHOUT ANY WARRANTY; without even the implied warranty of
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
10 11 12 13 14 15
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   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 */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
16 17 18 19

#ifndef _mysql_h
#define _mysql_h

20 21 22 23 24 25 26 27
#ifdef __CYGWIN__     /* CYGWIN implements a UNIX API */
#undef WIN
#undef _WIN
#undef _WIN32
#undef _WIN64
#undef __WIN__
#endif

bk@work.mysql.com's avatar
bk@work.mysql.com committed
28 29 30
#ifdef	__cplusplus
extern "C" {
#endif
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
31

bk@work.mysql.com's avatar
bk@work.mysql.com committed
32 33
#ifndef _global_h				/* If not standard header */
#include <sys/types.h>
34 35 36
#ifdef __LCC__
#include <winsock.h>				/* For windows */
#endif
bk@work.mysql.com's avatar
bk@work.mysql.com committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
typedef char my_bool;
#if (defined(_WIN32) || defined(_WIN64)) && !defined(__WIN__)
#define __WIN__
#endif
#if !defined(__WIN__)
#define STDCALL
#else
#define STDCALL __stdcall
#endif
typedef char * gptr;

#ifndef my_socket_defined
#ifdef __WIN__
#define my_socket SOCKET
#else
typedef int my_socket;
53 54 55 56
#endif /* __WIN__ */
#endif /* my_socket_defined */
#endif /* _global_h */

bk@work.mysql.com's avatar
bk@work.mysql.com committed
57 58
#include "mysql_com.h"
#include "mysql_version.h"
59
#include "typelib.h"
bk@work.mysql.com's avatar
bk@work.mysql.com committed
60

61 62
#include "my_list.h" /* for LISTs used in 'MYSQL' and 'MYSQL_STMT' */

bk@work.mysql.com's avatar
bk@work.mysql.com committed
63 64 65
extern unsigned int mysql_port;
extern char *mysql_unix_port;

66 67 68
#define CLIENT_NET_READ_TIMEOUT		365*24*3600	/* Timeout on read */
#define CLIENT_NET_WRITE_TIMEOUT	365*24*3600	/* Timeout on write */

monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
69 70 71 72
#ifdef __NETWARE__
#pragma pack(push, 8)		/* 8 byte alignment */
#endif

bk@work.mysql.com's avatar
bk@work.mysql.com committed
73 74 75 76
#define IS_PRI_KEY(n)	((n) & PRI_KEY_FLAG)
#define IS_NOT_NULL(n)	((n) & NOT_NULL_FLAG)
#define IS_BLOB(n)	((n) & BLOB_FLAG)
#define IS_NUM(t)	((t) <= FIELD_TYPE_INT24 || (t) == FIELD_TYPE_YEAR)
77
#define IS_NUM_FIELD(f)	 ((f)->flags & NUM_FLAG)
78
#define INTERNAL_NUM_FIELD(f) (((f)->type <= FIELD_TYPE_INT24 && ((f)->type != FIELD_TYPE_TIMESTAMP || (f)->length == 14 || (f)->length == 8)) || (f)->type == FIELD_TYPE_YEAR)
bk@work.mysql.com's avatar
bk@work.mysql.com committed
79 80

typedef struct st_mysql_field {
81
  char *name;                 /* Name of column */
monty@narttu.mysql.fi's avatar
monty@narttu.mysql.fi committed
82
  char *org_name;             /* Original column name, if an alias */ 
83 84 85
  char *table;                /* Table of column if column was a field */
  char *org_table;            /* Org table name, if table was an alias */
  char *db;                   /* Database for table */
86
  char *catalog;	      /* Catalog for table */
87 88 89
  char *def;                  /* Default value (set by mysql_list_fields) */
  unsigned long length;       /* Width of column */
  unsigned long max_length;   /* Max width of selected set */
90 91 92 93 94
  unsigned int name_length;
  unsigned int org_name_length;
  unsigned int table_length;
  unsigned int org_table_length;
  unsigned int db_length;
95
  unsigned int catalog_length;
96
  unsigned int def_length;
97 98
  unsigned int flags;         /* Div flags */
  unsigned int decimals;      /* Number of decimals in field */
99
  unsigned int charsetnr;     /* Character set */
100
  enum enum_field_types type; /* Type of field. Se mysql_com.h for types */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
101 102 103 104 105
} MYSQL_FIELD;

typedef char **MYSQL_ROW;		/* return data as array of strings */
typedef unsigned int MYSQL_FIELD_OFFSET; /* offset to current field */

hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
106
#ifndef _global_h
bk@work.mysql.com's avatar
bk@work.mysql.com committed
107 108 109 110 111 112 113
#if defined(NO_CLIENT_LONG_LONG)
typedef unsigned long my_ulonglong;
#elif defined (__WIN__)
typedef unsigned __int64 my_ulonglong;
#else
typedef unsigned long long my_ulonglong;
#endif
hf@deer.mysql.r18.ru's avatar
SCRUM  
hf@deer.mysql.r18.ru committed
114
#endif
bk@work.mysql.com's avatar
bk@work.mysql.com committed
115 116 117 118 119 120 121 122 123 124

#define MYSQL_COUNT_ERROR (~(my_ulonglong) 0)

typedef struct st_mysql_rows {
  struct st_mysql_rows *next;		/* list of rows */
  MYSQL_ROW data;
} MYSQL_ROWS;

typedef MYSQL_ROWS *MYSQL_ROW_OFFSET;	/* offset to current row */

125
#include "my_alloc.h"
126

bk@work.mysql.com's avatar
bk@work.mysql.com committed
127 128 129 130 131
typedef struct st_mysql_data {
  my_ulonglong rows;
  unsigned int fields;
  MYSQL_ROWS *data;
  MEM_ROOT alloc;
hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
132
#if !defined(CHECK_EMBEDDED_DIFFERENCES) || defined(EMBEDDED_LIBRARY)
133 134
  MYSQL_ROWS **prev_ptr;
#endif
bk@work.mysql.com's avatar
bk@work.mysql.com committed
135 136
} MYSQL_DATA;

hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
137 138 139 140 141 142 143 144
enum mysql_option 
{
  MYSQL_OPT_CONNECT_TIMEOUT, MYSQL_OPT_COMPRESS, MYSQL_OPT_NAMED_PIPE,
  MYSQL_INIT_COMMAND, MYSQL_READ_DEFAULT_FILE, MYSQL_READ_DEFAULT_GROUP,
  MYSQL_SET_CHARSET_DIR, MYSQL_SET_CHARSET_NAME, MYSQL_OPT_LOCAL_INFILE,
  MYSQL_OPT_PROTOCOL, MYSQL_SHARED_MEMORY_BASE_NAME, MYSQL_OPT_READ_TIMEOUT,
  MYSQL_OPT_WRITE_TIMEOUT, MYSQL_OPT_USE_RESULT,
  MYSQL_OPT_USE_REMOTE_CONNECTION, MYSQL_OPT_USE_EMBEDDED_CONNECTION,
145
  MYSQL_OPT_GUESS_CONNECTION, MYSQL_SET_CLIENT_IP, MYSQL_SECURE_AUTH
hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
146 147
};

bk@work.mysql.com's avatar
bk@work.mysql.com committed
148
struct st_mysql_options {
149 150
  unsigned int connect_timeout, read_timeout, write_timeout;
  unsigned int port, protocol;
151
  unsigned long client_flag;
152 153
  char *host,*user,*password,*unix_socket,*db;
  struct st_dynamic_array *init_commands;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
154 155 156 157 158
  char *my_cnf_file,*my_cnf_group, *charset_dir, *charset_name;
  char *ssl_key;				/* PEM key file */
  char *ssl_cert;				/* PEM cert file */
  char *ssl_ca;					/* PEM CA file */
  char *ssl_capath;				/* PEM directory of CA-s? */
159
  char *ssl_cipher;				/* cipher to use */
160
  char *shared_memory_base_name;
161
  unsigned long max_allowed_packet;
162 163 164
  my_bool use_ssl;				/* if to use SSL or not */
  my_bool compress,named_pipe;
 /*
165
   On connect, find out the replication role of the server, and
166 167 168
   establish connections to all the peers
 */
  my_bool rpl_probe;
169 170 171
 /*
   Each call to mysql_real_query() will parse it to tell if it is a read
   or a write, and direct it to the slave or the master
172 173 174
 */
  my_bool rpl_parse;
 /*
175
   If set, never read from a master,only from slave, when doing
176 177 178
   a read that is replication-aware
 */
  my_bool no_master_reads;
hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
179
#if !defined(CHECK_EMBEDDED_DIFFERENCES) || defined(EMBEDDED_LIBRARY)
180 181
  my_bool separate_thread;
#endif
hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
182
  enum mysql_option methods_to_use;
hf@deer.(none)'s avatar
hf@deer.(none) committed
183
  char *client_ip;
184 185
  /* Refuse client connecting to server if it uses old (pre-4.1.1) protocol */
  my_bool secure_auth;
186
};
bk@work.mysql.com's avatar
bk@work.mysql.com committed
187

188 189 190 191
enum mysql_status 
{
  MYSQL_STATUS_READY,MYSQL_STATUS_GET_RESULT,MYSQL_STATUS_USE_RESULT
};
bk@work.mysql.com's avatar
bk@work.mysql.com committed
192

193 194
enum mysql_protocol_type 
{
195 196
  MYSQL_PROTOCOL_DEFAULT, MYSQL_PROTOCOL_TCP, MYSQL_PROTOCOL_SOCKET,
  MYSQL_PROTOCOL_PIPE, MYSQL_PROTOCOL_MEMORY
197
};
198 199 200 201
/*
  There are three types of queries - the ones that have to go to
  the master, the ones that go to a slave, and the adminstrative
  type which must happen on the pivot connectioin
202
*/
203 204 205 206
enum mysql_rpl_type 
{
  MYSQL_RPL_MASTER, MYSQL_RPL_SLAVE, MYSQL_RPL_ADMIN
};
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
207

hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
208
struct st_mysql_methods;
209

210 211
typedef struct st_mysql
{
bk@work.mysql.com's avatar
bk@work.mysql.com committed
212 213
  NET		net;			/* Communication parameters */
  gptr		connector_fd;		/* ConnectorFd for SSL */
214 215
  char		*host,*user,*passwd,*unix_socket,*server_version,*host_info,*info;
  char          *db;
216 217 218
  struct charset_info_st *charset;
  MYSQL_FIELD	*fields;
  MEM_ROOT	field_alloc;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
219 220 221
  my_ulonglong affected_rows;
  my_ulonglong insert_id;		/* id if insert on table with NEXTNR */
  my_ulonglong extra_info;		/* Used by mysqlshow */
222
  unsigned long thread_id;		/* Id for connection in server */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
223
  unsigned long packet_length;
224 225
  unsigned int	port;
  unsigned long client_flag,server_capabilities;
226 227 228 229
  unsigned int	protocol_version;
  unsigned int	field_count;
  unsigned int 	server_status;
  unsigned int  server_language;
230
  unsigned int	warning_count;
231
  struct st_mysql_options options;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
232 233 234
  enum mysql_status status;
  my_bool	free_me;		/* If free in mysql_close */
  my_bool	reconnect;		/* set to 1 if automatic reconnect */
235

236
  /* session-wide random string */
237
  char	        scramble[SCRAMBLE_LENGTH+1];
238

239 240 241 242 243
 /*
   Set if this is the original connection, not a master or a slave we have
   added though mysql_rpl_probe() or mysql_set_master()/ mysql_add_slave()
 */
  my_bool rpl_pivot;
244 245 246 247
  /*
    Pointers to the master, and the next slave connections, points to
    itself if lone connection.
  */
248
  struct st_mysql* master, *next_slave;
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
249

250
  struct st_mysql* last_used_slave; /* needed for round-robin slave pick */
251 252
 /* needed for send/read/store/use result to work correctly with replication */
  struct st_mysql* last_used_con;
253 254

  LIST  *stmts;                     /* list of all statements */
hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
255
  const struct st_mysql_methods *methods;
256 257
  void *thd;
} MYSQL;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
258

259
typedef struct st_mysql_res {
bk@work.mysql.com's avatar
bk@work.mysql.com committed
260 261 262 263
  my_ulonglong row_count;
  MYSQL_FIELD	*fields;
  MYSQL_DATA	*data;
  MYSQL_ROWS	*data_cursor;
264 265
  unsigned long *lengths;		/* column lengths of current row */
  MYSQL		*handle;		/* for unbuffered reads */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
266
  MEM_ROOT	field_alloc;
267
  unsigned int	field_count, current_field;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
268 269
  MYSQL_ROW	row;			/* If unbuffered read */
  MYSQL_ROW	current_row;		/* buffer to current row */
270
  my_bool	eof;			/* Used by mysql_fetch_row */
271
  const struct st_mysql_methods *methods;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
272 273
} MYSQL_RES;

274 275
#define MAX_MYSQL_MANAGER_ERR 256  
#define MAX_MYSQL_MANAGER_MSG 256
tim@black.box's avatar
tim@black.box committed
276

277 278 279 280 281 282
#define MANAGER_OK           200
#define MANAGER_INFO         250
#define MANAGER_ACCESS       401
#define MANAGER_CLIENT_ERR   450
#define MANAGER_INTERNAL_ERR 500

283
#if !defined(MYSQL_SERVER) && !defined(MYSQL_CLIENT)
hf@deer.(none)'s avatar
hf@deer.(none) committed
284 285 286
#define MYSQL_CLIENT
#endif

287

monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
288

289 290
typedef struct st_mysql_manager
{
291
  NET net;
292 293 294 295 296 297 298 299 300 301
  char *host,*user,*passwd;
  unsigned int port;
  my_bool free_me;
  my_bool eof;
  int cmd_status;
  int last_errno;
  char* net_buf,*net_buf_pos,*net_data_end;
  int net_buf_size;
  char last_error[MAX_MYSQL_MANAGER_ERR];
} MYSQL_MANAGER;
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
302

303 304 305 306 307
/*
  Set up and bring down the server; to ensure that applications will
  work when linked against either the standard client library or the
  embedded server library, these functions should be called.
*/
308 309
int STDCALL mysql_server_init(int argc, char **argv, char **groups);
void STDCALL mysql_server_end(void);
tim@black.box's avatar
tim@black.box committed
310

311 312 313 314 315 316
/*
  Set up and bring down a thread; these function should be called
  for each thread in an application which opens at least one MySQL
  connection.  All uses of the connection(s) should be between these
  function calls.
*/
317 318
my_bool STDCALL mysql_thread_init(void);
void STDCALL mysql_thread_end(void);
tim@black.box's avatar
tim@black.box committed
319

320 321 322 323
/*
  Functions to get information from the MYSQL and MYSQL_RES structures
  Should definitely be used if one uses shared libraries.
*/
bk@work.mysql.com's avatar
bk@work.mysql.com committed
324 325 326 327 328 329 330

my_ulonglong STDCALL mysql_num_rows(MYSQL_RES *res);
unsigned int STDCALL mysql_num_fields(MYSQL_RES *res);
my_bool STDCALL mysql_eof(MYSQL_RES *res);
MYSQL_FIELD *STDCALL mysql_fetch_field_direct(MYSQL_RES *res,
					      unsigned int fieldnr);
MYSQL_FIELD * STDCALL mysql_fetch_fields(MYSQL_RES *res);
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
331 332
MYSQL_ROW_OFFSET STDCALL mysql_row_tell(MYSQL_RES *res);
MYSQL_FIELD_OFFSET STDCALL mysql_field_tell(MYSQL_RES *res);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
333 334 335 336 337

unsigned int STDCALL mysql_field_count(MYSQL *mysql);
my_ulonglong STDCALL mysql_affected_rows(MYSQL *mysql);
my_ulonglong STDCALL mysql_insert_id(MYSQL *mysql);
unsigned int STDCALL mysql_errno(MYSQL *mysql);
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
338
const char * STDCALL mysql_error(MYSQL *mysql);
339
const char *STDCALL mysql_sqlstate(MYSQL *mysql);
340
unsigned int STDCALL mysql_warning_count(MYSQL *mysql);
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
341
const char * STDCALL mysql_info(MYSQL *mysql);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
342 343 344 345
unsigned long STDCALL mysql_thread_id(MYSQL *mysql);
const char * STDCALL mysql_character_set_name(MYSQL *mysql);

MYSQL *		STDCALL mysql_init(MYSQL *mysql);
346
my_bool		STDCALL mysql_ssl_set(MYSQL *mysql, const char *key,
bk@work.mysql.com's avatar
bk@work.mysql.com committed
347
				      const char *cert, const char *ca,
348
				      const char *capath, const char *cipher);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
349 350 351 352 353 354 355 356
my_bool		STDCALL mysql_change_user(MYSQL *mysql, const char *user, 
					  const char *passwd, const char *db);
MYSQL *		STDCALL mysql_real_connect(MYSQL *mysql, const char *host,
					   const char *user,
					   const char *passwd,
					   const char *db,
					   unsigned int port,
					   const char *unix_socket,
357
					   unsigned long clientflag);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
358 359
int		STDCALL mysql_select_db(MYSQL *mysql, const char *db);
int		STDCALL mysql_query(MYSQL *mysql, const char *q);
360
int		STDCALL mysql_send_query(MYSQL *mysql, const char *q,
361
					 unsigned long length);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
362
int		STDCALL mysql_real_query(MYSQL *mysql, const char *q,
363
					unsigned long length);
hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
364
MYSQL_RES *     STDCALL mysql_store_result(MYSQL *mysql);
hf@deer.(none)'s avatar
hf@deer.(none) committed
365
MYSQL_RES *     STDCALL mysql_use_result(MYSQL *mysql);
hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
366

367
/* perform query on master */
368 369 370 371
my_bool		STDCALL mysql_master_query(MYSQL *mysql, const char *q,
					   unsigned long length);
my_bool		STDCALL mysql_master_send_query(MYSQL *mysql, const char *q,
						unsigned long length);
372
/* perform query on slave */  
373 374 375 376
my_bool		STDCALL mysql_slave_query(MYSQL *mysql, const char *q,
					  unsigned long length);
my_bool		STDCALL mysql_slave_send_query(MYSQL *mysql, const char *q,
					       unsigned long length);
377

378 379 380 381
/*
  enable/disable parsing of all queries to decide if they go on master or
  slave
*/
382 383 384 385 386 387 388 389 390
void            STDCALL mysql_enable_rpl_parse(MYSQL* mysql);
void            STDCALL mysql_disable_rpl_parse(MYSQL* mysql);
/* get the value of the parse flag */  
int             STDCALL mysql_rpl_parse_enabled(MYSQL* mysql);

/*  enable/disable reads from master */
void            STDCALL mysql_enable_reads_from_master(MYSQL* mysql);
void            STDCALL mysql_disable_reads_from_master(MYSQL* mysql);
/* get the value of the master read flag */  
391
my_bool		STDCALL mysql_reads_from_master_enabled(MYSQL* mysql);
392

393
enum mysql_rpl_type     STDCALL mysql_rpl_query_type(const char* q, int len);  
394 395

/* discover the master and its slaves */  
396
my_bool		STDCALL mysql_rpl_probe(MYSQL* mysql);
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
397

398 399
/* set the master, close/free the old one, if it is not a pivot */
int             STDCALL mysql_set_master(MYSQL* mysql, const char* host,
400 401 402
					 unsigned int port,
					 const char* user,
					 const char* passwd);
403
int             STDCALL mysql_add_slave(MYSQL* mysql, const char* host,
404 405 406
					unsigned int port,
					const char* user,
					const char* passwd);
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
407

bk@work.mysql.com's avatar
bk@work.mysql.com committed
408 409 410 411 412
int		STDCALL mysql_shutdown(MYSQL *mysql);
int		STDCALL mysql_dump_debug_info(MYSQL *mysql);
int		STDCALL mysql_refresh(MYSQL *mysql,
				     unsigned int refresh_options);
int		STDCALL mysql_kill(MYSQL *mysql,unsigned long pid);
413 414 415
int		STDCALL mysql_set_server_option(MYSQL *mysql,
						enum enum_mysql_set_option
						option);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
416
int		STDCALL mysql_ping(MYSQL *mysql);
417 418 419
const char *	STDCALL mysql_stat(MYSQL *mysql);
const char *	STDCALL mysql_get_server_info(MYSQL *mysql);
const char *	STDCALL mysql_get_client_info(void);
420
unsigned long	STDCALL mysql_get_client_version(void);
421
const char *	STDCALL mysql_get_host_info(MYSQL *mysql);
monty@narttu.mysql.fi's avatar
monty@narttu.mysql.fi committed
422
unsigned long	STDCALL mysql_get_server_version(MYSQL *mysql);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
423 424 425 426 427 428 429 430 431
unsigned int	STDCALL mysql_get_proto_info(MYSQL *mysql);
MYSQL_RES *	STDCALL mysql_list_dbs(MYSQL *mysql,const char *wild);
MYSQL_RES *	STDCALL mysql_list_tables(MYSQL *mysql,const char *wild);
MYSQL_RES *	STDCALL mysql_list_processes(MYSQL *mysql);
int		STDCALL mysql_options(MYSQL *mysql,enum mysql_option option,
				      const char *arg);
void		STDCALL mysql_free_result(MYSQL_RES *result);
void		STDCALL mysql_data_seek(MYSQL_RES *result,
					my_ulonglong offset);
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
432 433
MYSQL_ROW_OFFSET STDCALL mysql_row_seek(MYSQL_RES *result,
						MYSQL_ROW_OFFSET offset);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
434 435 436 437 438
MYSQL_FIELD_OFFSET STDCALL mysql_field_seek(MYSQL_RES *result,
					   MYSQL_FIELD_OFFSET offset);
MYSQL_ROW	STDCALL mysql_fetch_row(MYSQL_RES *result);
unsigned long * STDCALL mysql_fetch_lengths(MYSQL_RES *result);
MYSQL_FIELD *	STDCALL mysql_fetch_field(MYSQL_RES *result);
hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
439 440
MYSQL_RES *     STDCALL mysql_list_fields(MYSQL *mysql, const char *table,
					  const char *wild);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
unsigned long	STDCALL mysql_escape_string(char *to,const char *from,
					    unsigned long from_length);
unsigned long STDCALL mysql_real_escape_string(MYSQL *mysql,
					       char *to,const char *from,
					       unsigned long length);
void		STDCALL mysql_debug(const char *debug);
char *		STDCALL mysql_odbc_escape_string(MYSQL *mysql,
						 char *to,
						 unsigned long to_length,
						 const char *from,
						 unsigned long from_length,
						 void *param,
						 char *
						 (*extend_buffer)
						 (void *, char *to,
						  unsigned long *length));
void 		STDCALL myodbc_remove_escape(MYSQL *mysql,char *name);
unsigned int	STDCALL mysql_thread_safe(void);
459 460 461 462 463 464 465 466 467 468 469 470
MYSQL_MANAGER*  STDCALL mysql_manager_init(MYSQL_MANAGER* con);  
MYSQL_MANAGER*  STDCALL mysql_manager_connect(MYSQL_MANAGER* con,
					      const char* host,
					      const char* user,
					      const char* passwd,
					      unsigned int port);
void            STDCALL mysql_manager_close(MYSQL_MANAGER* con);
int             STDCALL mysql_manager_command(MYSQL_MANAGER* con,
						const char* cmd, int cmd_len);
int             STDCALL mysql_manager_fetch_line(MYSQL_MANAGER* con,
						  char* res_buf,
						 int res_buf_size);
hf@deer.(none)'s avatar
hf@deer.(none) committed
471
my_bool         STDCALL mysql_read_query_result(MYSQL *mysql);
472 473 474


/*
monty@narttu.mysql.fi's avatar
monty@narttu.mysql.fi committed
475
  The following definitions are added for the enhanced 
476 477 478 479
  client-server protocol
*/

/* statement state */
venu@myvenu.com's avatar
venu@myvenu.com committed
480
enum PREP_STMT_STATE { MY_ST_UNKNOWN, MY_ST_PREPARE, MY_ST_EXECUTE };
481

482 483 484 485 486 487 488 489 490 491
/* 
  client TIME structure to handle TIME, DATE and TIMESTAMP directly in 
  binary protocol 
*/
enum mysql_st_timestamp_type { MYSQL_TIMESTAMP_NONE, MYSQL_TIMESTAMP_DATE, 
                               MYSQL_TIMESTAMP_FULL, MYSQL_TIMESTAMP_TIME };

typedef struct mysql_st_time 
{
  unsigned int  year,month,day,hour,minute,second;
492
  unsigned long second_part;  
493 494 495 496 497 498 499
  my_bool       neg;

  enum mysql_st_timestamp_type time_type;
  
} MYSQL_TIME;


500
/* bind structure */
501 502
typedef struct st_mysql_bind
{
503 504 505
  unsigned long	*length;          /* output length pointer */
  my_bool       *is_null;	  /* Pointer to null indicators */
  char		*buffer;	  /* buffer to get/put data */
506
  enum enum_field_types buffer_type;	/* buffer type */
507 508 509 510 511
  unsigned long buffer_length;    /* buffer length, must be set for str/binary */  

  /* Following are for internal use. Set by mysql_bind_param */
  unsigned char *inter_buffer;    /* for the current data position */
  unsigned long offset;           /* offset position for char/binary fetch */
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
512
  unsigned long	internal_length;  /* Used if length is 0 */
513 514 515 516
  unsigned int	param_number;	  /* For null count and error messages */
  my_bool	long_data_used;	  /* If used with mysql_send_long_data */
  my_bool       binary_data;      /* data buffer is binary */
  my_bool       null_field;       /* NULL data cache flag */
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
517
  my_bool	internal_is_null; /* Used if is_null is 0 */
518
  void (*store_param_func)(NET *net, struct st_mysql_bind *param);
venu@myvenu.com's avatar
venu@myvenu.com committed
519
  void (*fetch_result)(struct st_mysql_bind *, unsigned char **row);
520 521 522
} MYSQL_BIND;


523 524 525
/* statement handler */
typedef struct st_mysql_stmt
{
526 527 528 529 530 531 532 533 534 535 536 537 538
  MYSQL		 *mysql;	       /* connection handle */
  MYSQL_BIND	 *params;	       /* input parameters */
  MYSQL_RES	 *result;	       /* resultset */
  MYSQL_BIND	 *bind;	               /* row binding */
  MYSQL_FIELD	 *fields;	       /* prepare meta info */
  LIST           list;                 /* list to keep track of all stmts */
  unsigned char  *current_row;         /* unbuffered row */
  unsigned char  *last_fetched_buffer; /* last fetched column buffer */
  char		 *query;	       /* query buffer */
  MEM_ROOT	 mem_root;	       /* root allocations */
  my_ulonglong   last_fetched_column;  /* last fetched column */
  unsigned long	 stmt_id;	       /* Id for prepared statement */
  unsigned int	 last_errno;	       /* error code */
539 540
  unsigned int   param_count;	       /* parameters count */
  unsigned int   field_count;	       /* fields count */
541 542
  enum PREP_STMT_STATE state;	       /* statement state */
  char		 last_error[MYSQL_ERRMSG_SIZE]; /* error message */
543
  char		 sqlstate[SQLSTATE_LENGTH+1];
544 545 546 547 548
  my_bool        long_alloced;	       /* flag to indicate long alloced */
  my_bool	 send_types_to_server; /* Types sent to server */
  my_bool        param_buffers;        /* param bound buffers */
  my_bool        res_buffers;          /* output bound buffers */
  my_bool        result_buffered;      /* Results buffered */
549 550 551
} MYSQL_STMT;


hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
552 553
typedef struct st_mysql_methods
{
554 555 556 557 558 559 560 561 562 563 564 565 566
  my_bool (*read_query_result)(MYSQL *mysql);
  my_bool (*advanced_command)(MYSQL *mysql,
			      enum enum_server_command command,
			      const char *header,
			      unsigned long header_length,
			      const char *arg,
			      unsigned long arg_length,
			      my_bool skip_check);
  MYSQL_DATA *(*read_rows)(MYSQL *mysql,MYSQL_FIELD *mysql_fields,
			   unsigned int fields);
  MYSQL_RES * (*use_result)(MYSQL *mysql);
  void (*fetch_lengths)(unsigned long *to, 
			MYSQL_ROW column, unsigned int field_count);
hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
567
#if !defined(MYSQL_SERVER) || defined(EMBEDDED_LIBRARY)
568 569 570 571 572 573 574
  MYSQL_FIELD * (*list_fields)(MYSQL *mysql);
  my_bool (*read_prepare_result)(MYSQL *mysql, MYSQL_STMT *stmt);
  int (*stmt_execute)(MYSQL_STMT *stmt);
  MYSQL_DATA *(*read_binary_rows)(MYSQL_STMT *stmt);
  int (*unbuffered_fetch)(MYSQL *mysql, char **row);
  void (*free_embedded_thd)(MYSQL *mysql);
  const char *(*read_statistic)(MYSQL *mysql);
hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
575
#endif
hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
576 577
} MYSQL_METHODS;

578 579
MYSQL_STMT * STDCALL mysql_prepare(MYSQL * mysql, const char *query,
				   unsigned long length);
580
int STDCALL mysql_execute(MYSQL_STMT * stmt);
581
unsigned long STDCALL mysql_param_count(MYSQL_STMT * stmt);
bar@bar.mysql.r18.ru's avatar
bar@bar.mysql.r18.ru committed
582 583
my_bool STDCALL mysql_bind_param(MYSQL_STMT * stmt, MYSQL_BIND * bnd);
my_bool STDCALL mysql_bind_result(MYSQL_STMT * stmt, MYSQL_BIND * bnd);
584
my_bool STDCALL mysql_stmt_close(MYSQL_STMT * stmt);
585
my_bool STDCALL mysql_stmt_reset(MYSQL_STMT * stmt);
586
my_bool STDCALL mysql_stmt_free_result(MYSQL_STMT *stmt);
587
unsigned int STDCALL mysql_stmt_errno(MYSQL_STMT * stmt);
588
const char *STDCALL mysql_stmt_error(MYSQL_STMT * stmt);
589
const char *STDCALL mysql_stmt_sqlstate(MYSQL_STMT * stmt);
590 591 592 593
my_bool STDCALL mysql_commit(MYSQL * mysql);
my_bool STDCALL mysql_rollback(MYSQL * mysql);
my_bool STDCALL mysql_autocommit(MYSQL * mysql, my_bool auto_mode);
int	STDCALL mysql_fetch(MYSQL_STMT *stmt);
594
int STDCALL mysql_fetch_column(MYSQL_STMT *stmt, MYSQL_BIND *bind, 
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
595
                               unsigned int column,
596
                               unsigned long offset);
597
my_bool STDCALL mysql_send_long_data(MYSQL_STMT *stmt, 
598
				     unsigned int param_number,
599
				     const char *data, 
600
				     unsigned long length);
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
601
MYSQL_RES *STDCALL mysql_get_metadata(MYSQL_STMT *stmt);
venu@myvenu.com's avatar
venu@myvenu.com committed
602
MYSQL_RES *STDCALL mysql_param_result(MYSQL_STMT *stmt);
603
my_ulonglong STDCALL mysql_stmt_affected_rows(MYSQL_STMT *stmt);
604
int STDCALL mysql_stmt_store_result(MYSQL_STMT *stmt);
605
my_bool STDCALL mysql_more_results(MYSQL *mysql);
606
int STDCALL mysql_next_result(MYSQL *mysql);
607 608 609 610
MYSQL_ROW_OFFSET STDCALL mysql_stmt_row_seek(MYSQL_STMT *stmt, 
                                             MYSQL_ROW_OFFSET offset);
MYSQL_ROW_OFFSET STDCALL mysql_stmt_row_tell(MYSQL_STMT *stmt);
void STDCALL mysql_stmt_data_seek(MYSQL_STMT *stmt, my_ulonglong offset);
611
my_ulonglong STDCALL mysql_stmt_num_rows(MYSQL_STMT *stmt);
612 613
void STDCALL mysql_close(MYSQL *sock);

614

615
/* status return codes */
616
#define MYSQL_NO_DATA      100
617

bk@work.mysql.com's avatar
bk@work.mysql.com committed
618 619
#define mysql_reload(mysql) mysql_refresh((mysql),REFRESH_GRANT)

tim@black.box's avatar
tim@black.box committed
620
#ifdef USE_OLD_FUNCTIONS
621 622 623 624
MYSQL *		STDCALL mysql_connect(MYSQL *mysql, const char *host,
				      const char *user, const char *passwd);
int		STDCALL mysql_create_db(MYSQL *mysql, const char *DB);
int		STDCALL mysql_drop_db(MYSQL *mysql, const char *DB);
625
#define	 mysql_reload(mysql) mysql_refresh((mysql),REFRESH_GRANT)
626
#endif
627
#define HAVE_MYSQL_REAL_CONNECT
628

629 630 631 632 633
/*
  The following functions are mainly exported because of mysqlbinlog;
  They are not for general usage
*/

hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
634 635 636
#define simple_command(mysql, command, arg, length, skip_check) \
  (*(mysql)->methods->advanced_command)(mysql, command,         \
					NullS, 0, arg, length, skip_check)
637
unsigned long net_safe_read(MYSQL* mysql);
638

monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
639 640 641
#ifdef __NETWARE__
#pragma pack(pop)		/* restore alignment */
#endif
bk@work.mysql.com's avatar
bk@work.mysql.com committed
642 643 644 645 646

#ifdef	__cplusplus
}
#endif

647
#endif /* _mysql_h */