mysql.h 26.8 KB
Newer Older
unknown's avatar
unknown committed
1
/* Copyright (C) 2000-2003 MySQL AB
unknown's avatar
unknown 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,
unknown's avatar
unknown committed
9
   but WITHOUT ANY WARRANTY; without even the implied warranty of
unknown's avatar
unknown 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 */
unknown's avatar
unknown 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

unknown's avatar
unknown committed
28 29 30
#ifdef	__cplusplus
extern "C" {
#endif
unknown's avatar
unknown committed
31

unknown's avatar
unknown committed
32 33
#ifndef _global_h				/* If not standard header */
#include <sys/types.h>
unknown's avatar
unknown committed
34 35 36
#ifdef __LCC__
#include <winsock.h>				/* For windows */
#endif
unknown's avatar
unknown 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 */

unknown's avatar
unknown committed
57
#include "mysql_com.h"
58
#include "mysql_time.h"
unknown's avatar
unknown committed
59
#include "mysql_version.h"
60
#include "typelib.h"
unknown's avatar
unknown committed
61

unknown's avatar
unknown committed
62 63
#include "my_list.h" /* for LISTs used in 'MYSQL' and 'MYSQL_STMT' */

unknown's avatar
unknown committed
64 65 66
extern unsigned int mysql_port;
extern char *mysql_unix_port;

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

unknown's avatar
unknown committed
70 71 72 73
#ifdef __NETWARE__
#pragma pack(push, 8)		/* 8 byte alignment */
#endif

unknown's avatar
unknown committed
74 75 76 77
#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)
78
#define IS_NUM_FIELD(f)	 ((f)->flags & NUM_FLAG)
79
#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)
unknown's avatar
unknown committed
80

81

unknown's avatar
unknown committed
82
typedef struct st_mysql_field {
83
  char *name;                 /* Name of column */
unknown's avatar
unknown committed
84
  char *org_name;             /* Original column name, if an alias */ 
85 86 87
  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 */
88
  char *catalog;	      /* Catalog for table */
89
  char *def;                  /* Default value (set by mysql_list_fields) */
90 91
  unsigned long length;       /* Width of column (create length) */
  unsigned long max_length;   /* Max width for selected set */
92 93 94 95 96
  unsigned int name_length;
  unsigned int org_name_length;
  unsigned int table_length;
  unsigned int org_table_length;
  unsigned int db_length;
97
  unsigned int catalog_length;
98
  unsigned int def_length;
99 100
  unsigned int flags;         /* Div flags */
  unsigned int decimals;      /* Number of decimals in field */
101
  unsigned int charsetnr;     /* Character set */
102
  enum enum_field_types type; /* Type of field. Se mysql_com.h for types */
unknown's avatar
unknown committed
103 104 105 106 107
} MYSQL_FIELD;

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

unknown's avatar
SCRUM  
unknown committed
108
#ifndef _global_h
unknown's avatar
unknown committed
109 110 111 112 113 114 115
#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
unknown's avatar
SCRUM  
unknown committed
116
#endif
unknown's avatar
unknown committed
117 118 119 120 121 122

#define MYSQL_COUNT_ERROR (~(my_ulonglong) 0)

typedef struct st_mysql_rows {
  struct st_mysql_rows *next;		/* list of rows */
  MYSQL_ROW data;
unknown's avatar
unknown committed
123
  unsigned long length;
unknown's avatar
unknown committed
124 125 126 127
} MYSQL_ROWS;

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

128
#include "my_alloc.h"
129

unknown's avatar
unknown committed
130 131 132 133 134
typedef struct st_mysql_data {
  my_ulonglong rows;
  unsigned int fields;
  MYSQL_ROWS *data;
  MEM_ROOT alloc;
unknown's avatar
SCRUM  
unknown committed
135
#if !defined(CHECK_EMBEDDED_DIFFERENCES) || defined(EMBEDDED_LIBRARY)
136 137
  MYSQL_ROWS **prev_ptr;
#endif
unknown's avatar
unknown committed
138 139
} MYSQL_DATA;

unknown's avatar
SCRUM  
unknown committed
140 141 142 143 144 145 146 147
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,
unknown's avatar
unknown committed
148
  MYSQL_OPT_GUESS_CONNECTION, MYSQL_SET_CLIENT_IP, MYSQL_SECURE_AUTH
unknown's avatar
SCRUM  
unknown committed
149 150
};

unknown's avatar
unknown committed
151
struct st_mysql_options {
152 153
  unsigned int connect_timeout, read_timeout, write_timeout;
  unsigned int port, protocol;
154
  unsigned long client_flag;
unknown's avatar
unknown committed
155 156
  char *host,*user,*password,*unix_socket,*db;
  struct st_dynamic_array *init_commands;
unknown's avatar
unknown committed
157 158 159 160 161
  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? */
162
  char *ssl_cipher;				/* cipher to use */
163
  char *shared_memory_base_name;
164
  unsigned long max_allowed_packet;
165 166 167
  my_bool use_ssl;				/* if to use SSL or not */
  my_bool compress,named_pipe;
 /*
unknown's avatar
unknown committed
168
   On connect, find out the replication role of the server, and
169 170 171
   establish connections to all the peers
 */
  my_bool rpl_probe;
unknown's avatar
unknown committed
172 173 174
 /*
   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
175 176 177
 */
  my_bool rpl_parse;
 /*
unknown's avatar
unknown committed
178
   If set, never read from a master,only from slave, when doing
179 180 181
   a read that is replication-aware
 */
  my_bool no_master_reads;
unknown's avatar
SCRUM  
unknown committed
182
#if !defined(CHECK_EMBEDDED_DIFFERENCES) || defined(EMBEDDED_LIBRARY)
183 184
  my_bool separate_thread;
#endif
unknown's avatar
SCRUM  
unknown committed
185
  enum mysql_option methods_to_use;
unknown's avatar
unknown committed
186
  char *client_ip;
unknown's avatar
unknown committed
187 188
  /* Refuse client connecting to server if it uses old (pre-4.1.1) protocol */
  my_bool secure_auth;
189 190

  /* function pointers for local infile support */
191
  int (*local_infile_init)(void **, const char *, void *);
unknown's avatar
unknown committed
192
  int (*local_infile_read)(void *, char *, unsigned int);
unknown's avatar
unknown committed
193
  void (*local_infile_end)(void *);
unknown's avatar
unknown committed
194
  int (*local_infile_error)(void *, char *, unsigned int);
195
  void *local_infile_userdata;
196
};
unknown's avatar
unknown committed
197

198 199 200 201
enum mysql_status 
{
  MYSQL_STATUS_READY,MYSQL_STATUS_GET_RESULT,MYSQL_STATUS_USE_RESULT
};
unknown's avatar
unknown committed
202

203 204
enum mysql_protocol_type 
{
205 206
  MYSQL_PROTOCOL_DEFAULT, MYSQL_PROTOCOL_TCP, MYSQL_PROTOCOL_SOCKET,
  MYSQL_PROTOCOL_PIPE, MYSQL_PROTOCOL_MEMORY
207
};
208 209 210 211
/*
  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
212
*/
213 214 215 216
enum mysql_rpl_type 
{
  MYSQL_RPL_MASTER, MYSQL_RPL_SLAVE, MYSQL_RPL_ADMIN
};
unknown's avatar
unknown committed
217

unknown's avatar
SCRUM  
unknown committed
218
struct st_mysql_methods;
219

220 221
typedef struct st_mysql
{
unknown's avatar
unknown committed
222 223
  NET		net;			/* Communication parameters */
  gptr		connector_fd;		/* ConnectorFd for SSL */
224 225
  char		*host,*user,*passwd,*unix_socket,*server_version,*host_info,*info;
  char          *db;
unknown's avatar
unknown committed
226 227 228
  struct charset_info_st *charset;
  MYSQL_FIELD	*fields;
  MEM_ROOT	field_alloc;
unknown's avatar
unknown committed
229 230 231
  my_ulonglong affected_rows;
  my_ulonglong insert_id;		/* id if insert on table with NEXTNR */
  my_ulonglong extra_info;		/* Used by mysqlshow */
unknown's avatar
unknown committed
232
  unsigned long thread_id;		/* Id for connection in server */
unknown's avatar
unknown committed
233
  unsigned long packet_length;
234 235
  unsigned int	port;
  unsigned long client_flag,server_capabilities;
unknown's avatar
unknown committed
236 237 238 239
  unsigned int	protocol_version;
  unsigned int	field_count;
  unsigned int 	server_status;
  unsigned int  server_language;
240
  unsigned int	warning_count;
unknown's avatar
unknown committed
241
  struct st_mysql_options options;
unknown's avatar
unknown committed
242 243 244
  enum mysql_status status;
  my_bool	free_me;		/* If free in mysql_close */
  my_bool	reconnect;		/* set to 1 if automatic reconnect */
245

246
  /* session-wide random string */
unknown's avatar
unknown committed
247
  char	        scramble[SCRAMBLE_LENGTH+1];
248

unknown's avatar
unknown committed
249 250 251 252 253
 /*
   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;
unknown's avatar
unknown committed
254 255 256 257
  /*
    Pointers to the master, and the next slave connections, points to
    itself if lone connection.
  */
258
  struct st_mysql* master, *next_slave;
unknown's avatar
unknown committed
259

260
  struct st_mysql* last_used_slave; /* needed for round-robin slave pick */
261 262
 /* needed for send/read/store/use result to work correctly with replication */
  struct st_mysql* last_used_con;
unknown's avatar
unknown committed
263 264

  LIST  *stmts;                     /* list of all statements */
unknown's avatar
SCRUM  
unknown committed
265
  const struct st_mysql_methods *methods;
266
  void *thd;
267 268 269 270 271
  /*
    Points to boolean flag in MYSQL_RES  or MYSQL_STMT. We set this flag 
    from mysql_stmt_close if close had to cancel result set of this object.
  */
  my_bool *unbuffered_fetch_owner;
272
} MYSQL;
unknown's avatar
unknown committed
273

274
typedef struct st_mysql_res {
unknown's avatar
unknown committed
275 276 277 278
  my_ulonglong row_count;
  MYSQL_FIELD	*fields;
  MYSQL_DATA	*data;
  MYSQL_ROWS	*data_cursor;
unknown's avatar
unknown committed
279 280
  unsigned long *lengths;		/* column lengths of current row */
  MYSQL		*handle;		/* for unbuffered reads */
unknown's avatar
unknown committed
281
  MEM_ROOT	field_alloc;
unknown's avatar
unknown committed
282
  unsigned int	field_count, current_field;
unknown's avatar
unknown committed
283 284
  MYSQL_ROW	row;			/* If unbuffered read */
  MYSQL_ROW	current_row;		/* buffer to current row */
unknown's avatar
unknown committed
285
  my_bool	eof;			/* Used by mysql_fetch_row */
286 287
  /* mysql_stmt_close() had to cancel this result */
  my_bool       unbuffered_fetch_cancelled;  
288
  const struct st_mysql_methods *methods;
unknown's avatar
unknown committed
289 290
} MYSQL_RES;

unknown's avatar
unknown committed
291 292
#define MAX_MYSQL_MANAGER_ERR 256  
#define MAX_MYSQL_MANAGER_MSG 256
unknown's avatar
unknown committed
293

unknown's avatar
unknown committed
294 295 296 297 298 299
#define MANAGER_OK           200
#define MANAGER_INFO         250
#define MANAGER_ACCESS       401
#define MANAGER_CLIENT_ERR   450
#define MANAGER_INTERNAL_ERR 500

300
#if !defined(MYSQL_SERVER) && !defined(MYSQL_CLIENT)
unknown's avatar
unknown committed
301 302 303
#define MYSQL_CLIENT
#endif

unknown's avatar
unknown committed
304 305 306

typedef struct st_mysql_manager
{
unknown's avatar
unknown committed
307
  NET net;
unknown's avatar
unknown committed
308 309 310 311 312 313 314 315 316 317
  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;
unknown's avatar
unknown committed
318

319 320 321 322 323 324
typedef struct st_mysql_parameters
{
  unsigned long *p_max_allowed_packet;
  unsigned long *p_net_buffer_length;
} MYSQL_PARAMETERS;

325
#if !defined(MYSQL_SERVER) && !defined(EMBEDDED_LIBRARY)
326 327 328 329
#define max_allowed_packet (*mysql_get_parameters()->p_max_allowed_packet)
#define net_buffer_length (*mysql_get_parameters()->p_net_buffer_length)
#endif

unknown's avatar
unknown committed
330 331 332 333 334
/*
  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.
*/
335 336
int STDCALL mysql_server_init(int argc, char **argv, char **groups);
void STDCALL mysql_server_end(void);
unknown's avatar
unknown committed
337

338
MYSQL_PARAMETERS *STDCALL mysql_get_parameters(void);
339

unknown's avatar
unknown committed
340 341 342 343 344 345
/*
  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.
*/
346 347
my_bool STDCALL mysql_thread_init(void);
void STDCALL mysql_thread_end(void);
unknown's avatar
unknown committed
348

unknown's avatar
unknown committed
349 350 351 352
/*
  Functions to get information from the MYSQL and MYSQL_RES structures
  Should definitely be used if one uses shared libraries.
*/
unknown's avatar
unknown committed
353 354 355 356 357 358 359

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);
unknown's avatar
unknown committed
360 361
MYSQL_ROW_OFFSET STDCALL mysql_row_tell(MYSQL_RES *res);
MYSQL_FIELD_OFFSET STDCALL mysql_field_tell(MYSQL_RES *res);
unknown's avatar
unknown committed
362 363 364 365 366

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);
unknown's avatar
unknown committed
367
const char * STDCALL mysql_error(MYSQL *mysql);
368
const char *STDCALL mysql_sqlstate(MYSQL *mysql);
369
unsigned int STDCALL mysql_warning_count(MYSQL *mysql);
unknown's avatar
unknown committed
370
const char * STDCALL mysql_info(MYSQL *mysql);
unknown's avatar
unknown committed
371 372 373 374
unsigned long STDCALL mysql_thread_id(MYSQL *mysql);
const char * STDCALL mysql_character_set_name(MYSQL *mysql);

MYSQL *		STDCALL mysql_init(MYSQL *mysql);
375
my_bool		STDCALL mysql_ssl_set(MYSQL *mysql, const char *key,
unknown's avatar
unknown committed
376
				      const char *cert, const char *ca,
377
				      const char *capath, const char *cipher);
unknown's avatar
unknown committed
378 379 380 381 382 383 384 385
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,
386
					   unsigned long clientflag);
unknown's avatar
unknown committed
387 388
int		STDCALL mysql_select_db(MYSQL *mysql, const char *db);
int		STDCALL mysql_query(MYSQL *mysql, const char *q);
389
int		STDCALL mysql_send_query(MYSQL *mysql, const char *q,
unknown's avatar
unknown committed
390
					 unsigned long length);
unknown's avatar
unknown committed
391
int		STDCALL mysql_real_query(MYSQL *mysql, const char *q,
unknown's avatar
unknown committed
392
					unsigned long length);
unknown's avatar
SCRUM  
unknown committed
393
MYSQL_RES *     STDCALL mysql_store_result(MYSQL *mysql);
unknown's avatar
unknown committed
394
MYSQL_RES *     STDCALL mysql_use_result(MYSQL *mysql);
unknown's avatar
SCRUM  
unknown committed
395

396
/* perform query on master */
397 398 399 400
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);
401
/* perform query on slave */  
402 403 404 405
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);
406

407 408 409 410
/* local infile support */

#define LOCAL_INFILE_ERROR_LEN 512

unknown's avatar
unknown committed
411
void
412
mysql_set_local_infile_handler(MYSQL *mysql,
413 414
                               int (*local_infile_init)(void **, const char *,
                            void *),
unknown's avatar
unknown committed
415 416
                               int (*local_infile_read)(void *, char *,
							unsigned int),
unknown's avatar
unknown committed
417
                               void (*local_infile_end)(void *),
unknown's avatar
unknown committed
418
                               int (*local_infile_error)(void *, char*,
419 420
							 unsigned int),
                               void *);
421 422 423 424 425

void
mysql_set_local_infile_default(MYSQL *mysql);


426 427 428 429
/*
  enable/disable parsing of all queries to decide if they go on master or
  slave
*/
430 431 432 433 434 435 436 437 438
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 */  
439
my_bool		STDCALL mysql_reads_from_master_enabled(MYSQL* mysql);
440

441
enum mysql_rpl_type     STDCALL mysql_rpl_query_type(const char* q, int len);  
442 443

/* discover the master and its slaves */  
444
my_bool		STDCALL mysql_rpl_probe(MYSQL* mysql);
unknown's avatar
unknown committed
445

446 447
/* set the master, close/free the old one, if it is not a pivot */
int             STDCALL mysql_set_master(MYSQL* mysql, const char* host,
448 449 450
					 unsigned int port,
					 const char* user,
					 const char* passwd);
451
int             STDCALL mysql_add_slave(MYSQL* mysql, const char* host,
452 453 454
					unsigned int port,
					const char* user,
					const char* passwd);
unknown's avatar
unknown committed
455

456 457 458
int		STDCALL mysql_shutdown(MYSQL *mysql,
                                       enum enum_shutdown_level
                                       shutdown_level);
unknown's avatar
unknown committed
459 460 461 462
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);
463 464 465
int		STDCALL mysql_set_server_option(MYSQL *mysql,
						enum enum_mysql_set_option
						option);
unknown's avatar
unknown committed
466
int		STDCALL mysql_ping(MYSQL *mysql);
467 468 469
const char *	STDCALL mysql_stat(MYSQL *mysql);
const char *	STDCALL mysql_get_server_info(MYSQL *mysql);
const char *	STDCALL mysql_get_client_info(void);
470
unsigned long	STDCALL mysql_get_client_version(void);
471
const char *	STDCALL mysql_get_host_info(MYSQL *mysql);
unknown's avatar
unknown committed
472
unsigned long	STDCALL mysql_get_server_version(MYSQL *mysql);
unknown's avatar
unknown committed
473 474 475 476 477 478 479 480 481
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);
unknown's avatar
unknown committed
482 483
MYSQL_ROW_OFFSET STDCALL mysql_row_seek(MYSQL_RES *result,
						MYSQL_ROW_OFFSET offset);
unknown's avatar
unknown committed
484 485 486 487 488
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);
unknown's avatar
SCRUM  
unknown committed
489 490
MYSQL_RES *     STDCALL mysql_list_fields(MYSQL *mysql, const char *table,
					  const char *wild);
unknown's avatar
unknown committed
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
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);
unknown's avatar
unknown committed
509 510 511 512 513 514 515 516 517 518 519 520
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);
unknown's avatar
unknown committed
521
my_bool         STDCALL mysql_read_query_result(MYSQL *mysql);
522 523 524


/*
unknown's avatar
unknown committed
525
  The following definitions are added for the enhanced 
526 527 528 529
  client-server protocol
*/

/* statement state */
530 531 532 533 534
enum enum_mysql_stmt_state
{
  MYSQL_STMT_INIT_DONE= 1, MYSQL_STMT_PREPARE_DONE, MYSQL_STMT_EXECUTE_DONE,
  MYSQL_STMT_FETCH_DONE
};
535

unknown's avatar
unknown committed
536

537
/* bind structure */
538 539
typedef struct st_mysql_bind
{
unknown's avatar
unknown committed
540 541
  unsigned long	*length;          /* output length pointer */
  my_bool       *is_null;	  /* Pointer to null indicators */
542
  void		*buffer;	  /* buffer to get/put data */
543
  enum enum_field_types buffer_type;	/* buffer type */
unknown's avatar
unknown committed
544 545
  unsigned long buffer_length;    /* buffer length, must be set for str/binary */  

546
  /* Following are for internal use. Set by mysql_stmt_bind_param */
unknown's avatar
unknown committed
547 548
  unsigned char *inter_buffer;    /* for the current data position */
  unsigned long offset;           /* offset position for char/binary fetch */
unknown's avatar
unknown committed
549
  unsigned long	internal_length;  /* Used if length is 0 */
unknown's avatar
unknown committed
550
  unsigned int	param_number;	  /* For null count and error messages */
551
  unsigned int  pack_length;	  /* Internal length for packed data */
552
  my_bool       is_unsigned;      /* set if integer type is unsigned */
unknown's avatar
unknown committed
553
  my_bool	long_data_used;	  /* If used with mysql_send_long_data */
unknown's avatar
unknown committed
554
  my_bool	internal_is_null; /* Used if is_null is 0 */
555
  void (*store_param_func)(NET *net, struct st_mysql_bind *param);
unknown's avatar
unknown committed
556
  void (*fetch_result)(struct st_mysql_bind *, unsigned char **row);
557 558
  void (*skip_result)(struct st_mysql_bind *, MYSQL_FIELD *,
		      unsigned char **row);
559 560 561
} MYSQL_BIND;


562 563 564
/* statement handler */
typedef struct st_mysql_stmt
{
565
  MEM_ROOT       mem_root;             /* root allocations */
unknown's avatar
unknown committed
566
  LIST           list;                 /* list to keep track of all stmts */
567 568 569 570
  MYSQL          *mysql;               /* connection handle */
  MYSQL_BIND     *params;              /* input parameters */
  MYSQL_BIND     *bind;                /* output parameters */
  MYSQL_FIELD    *fields;              /* result set metadata */
571 572
  MYSQL_DATA     result;               /* cached result set */
  MYSQL_ROWS     *data_cursor;         /* current row in cached result */
573 574
  /* copy of mysql->affected_rows after statement execution */
  my_ulonglong   affected_rows;
575
  my_ulonglong   insert_id;            /* copy of mysql->insert_id */
576 577 578 579 580 581
  /*
    mysql_stmt_fetch() calls this function to fetch one row (it's different
    for buffered, unbuffered and cursor fetch).
  */
  int            (*read_row_func)(struct st_mysql_stmt *stmt, 
                                  unsigned char **row);
unknown's avatar
unknown committed
582 583
  unsigned long	 stmt_id;	       /* Id for prepared statement */
  unsigned int	 last_errno;	       /* error code */
584 585 586
  unsigned int   param_count;          /* inpute parameters count */
  unsigned int   field_count;          /* number of columns in result set */
  enum enum_mysql_stmt_state state;    /* statement state */
unknown's avatar
unknown committed
587
  char		 last_error[MYSQL_ERRMSG_SIZE]; /* error message */
588
  char		 sqlstate[SQLSTATE_LENGTH+1];
589 590 591 592 593 594
  /* Types of input parameters should be sent to server */
  my_bool        send_types_to_server;
  my_bool        bind_param_done;      /* input buffers were supplied */
  my_bool        bind_result_done;     /* output buffers were supplied */
  /* mysql_stmt_close() had to cancel this result */
  my_bool       unbuffered_fetch_cancelled;  
595 596 597 598 599
  /*
    Is set to true if we need to calculate field->max_length for 
    metadata fields when doing mysql_stmt_store_result.
  */
  my_bool       update_max_length;     
600 601
} MYSQL_STMT;

602 603 604 605 606 607 608 609 610 611 612 613
enum enum_stmt_attr_type
{
  /*
    When doing mysql_stmt_store_result calculate max_length attribute
    of statement metadata. This is to be consistent with the old API, 
    where this was done automatically.
    In the new API we do that only by request because it slows down
    mysql_stmt_store_result sufficiently.
  */
  STMT_ATTR_UPDATE_MAX_LENGTH
};

614

unknown's avatar
SCRUM  
unknown committed
615 616
typedef struct st_mysql_methods
{
unknown's avatar
unknown committed
617 618 619 620 621 622 623 624 625 626 627 628 629
  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);
630
  void (*flush_use_result)(MYSQL *mysql);
unknown's avatar
SCRUM  
unknown committed
631
#if !defined(MYSQL_SERVER) || defined(EMBEDDED_LIBRARY)
unknown's avatar
unknown committed
632 633 634
  MYSQL_FIELD * (*list_fields)(MYSQL *mysql);
  my_bool (*read_prepare_result)(MYSQL *mysql, MYSQL_STMT *stmt);
  int (*stmt_execute)(MYSQL_STMT *stmt);
635
  int (*read_binary_rows)(MYSQL_STMT *stmt);
unknown's avatar
unknown committed
636 637
  int (*unbuffered_fetch)(MYSQL *mysql, char **row);
  void (*free_embedded_thd)(MYSQL *mysql);
unknown's avatar
unknown committed
638
  const char *(*read_statistics)(MYSQL *mysql);
unknown's avatar
unknown committed
639
  my_bool (*next_result)(MYSQL *mysql);
640
  int (*read_change_user_result)(MYSQL *mysql, char *buff, const char *passwd);
unknown's avatar
SCRUM  
unknown committed
641
#endif
unknown's avatar
SCRUM  
unknown committed
642 643
} MYSQL_METHODS;

644 645 646 647
#ifdef HAVE_DEPRECATED_411_API
/* Deprecated calls (since MySQL 4.1.2) */

/* Use mysql_stmt_init + mysql_stmt_prepare instead */
648 649
MYSQL_STMT * STDCALL mysql_prepare(MYSQL * mysql, const char *query,
				   unsigned long length);
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671
#define mysql_execute mysql_stmt_execute
#define mysql_fetch mysql_stmt_fetch
#define mysql_fetch_column mysql_stmt_fetch_column
#define mysql_bind_param mysql_stmt_bind_param
#define mysql_bind_result mysql_stmt_bind_result
#define mysql_param_count mysql_stmt_param_count
#define mysql_param_result mysql_stmt_param_metadata
#define mysql_get_metadata mysql_stmt_result_metadata
#define mysql_send_long_data mysql_stmt_send_long_data

#endif /* HAVE_DEPRECATED_411_API */

MYSQL_STMT * STDCALL mysql_stmt_init(MYSQL *mysql);
int STDCALL mysql_stmt_prepare(MYSQL_STMT *stmt, const char *query,
                               unsigned long length);
int STDCALL mysql_stmt_execute(MYSQL_STMT *stmt);
int STDCALL mysql_stmt_fetch(MYSQL_STMT *stmt);
int STDCALL mysql_stmt_fetch_column(MYSQL_STMT *stmt, MYSQL_BIND *bind, 
                                    unsigned int column,
                                    unsigned long offset);
int STDCALL mysql_stmt_store_result(MYSQL_STMT *stmt);
unsigned long STDCALL mysql_stmt_param_count(MYSQL_STMT * stmt);
672 673 674 675 676 677
my_bool STDCALL mysql_stmt_attr_set(MYSQL_STMT *stmt,
                                    enum enum_stmt_attr_type attr_type,
                                    const void *attr);
my_bool STDCALL mysql_stmt_attr_get(MYSQL_STMT *stmt,
                                    enum enum_stmt_attr_type attr_type,
                                    void *attr);
678 679
my_bool STDCALL mysql_stmt_bind_param(MYSQL_STMT * stmt, MYSQL_BIND * bnd);
my_bool STDCALL mysql_stmt_bind_result(MYSQL_STMT * stmt, MYSQL_BIND * bnd);
680
my_bool STDCALL mysql_stmt_close(MYSQL_STMT * stmt);
681
my_bool STDCALL mysql_stmt_reset(MYSQL_STMT * stmt);
682
my_bool STDCALL mysql_stmt_free_result(MYSQL_STMT *stmt);
683 684 685 686 687 688
my_bool STDCALL mysql_stmt_send_long_data(MYSQL_STMT *stmt, 
                                          unsigned int param_number,
                                          const char *data, 
                                          unsigned long length);
MYSQL_RES *STDCALL mysql_stmt_result_metadata(MYSQL_STMT *stmt);
MYSQL_RES *STDCALL mysql_stmt_param_metadata(MYSQL_STMT *stmt);
689
unsigned int STDCALL mysql_stmt_errno(MYSQL_STMT * stmt);
690
const char *STDCALL mysql_stmt_error(MYSQL_STMT * stmt);
691
const char *STDCALL mysql_stmt_sqlstate(MYSQL_STMT * stmt);
692 693 694 695
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);
696
my_ulonglong STDCALL mysql_stmt_num_rows(MYSQL_STMT *stmt);
697
my_ulonglong STDCALL mysql_stmt_affected_rows(MYSQL_STMT *stmt);
698
my_ulonglong STDCALL mysql_stmt_insert_id(MYSQL_STMT *stmt);
unknown's avatar
unknown committed
699
unsigned int STDCALL mysql_stmt_field_count(MYSQL_STMT *stmt);
700 701 702 703 704 705

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);
my_bool STDCALL mysql_more_results(MYSQL *mysql);
int STDCALL mysql_next_result(MYSQL *mysql);
706 707
void STDCALL mysql_close(MYSQL *sock);

708

709
/* status return codes */
710
#define MYSQL_NO_DATA      100
711

unknown's avatar
unknown committed
712 713
#define mysql_reload(mysql) mysql_refresh((mysql),REFRESH_GRANT)

unknown's avatar
unknown committed
714
#ifdef USE_OLD_FUNCTIONS
715 716 717 718
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);
unknown's avatar
unknown committed
719
#define	 mysql_reload(mysql) mysql_refresh((mysql),REFRESH_GRANT)
720
#endif
721
#define HAVE_MYSQL_REAL_CONNECT
722

unknown's avatar
unknown committed
723 724 725 726 727
/*
  The following functions are mainly exported because of mysqlbinlog;
  They are not for general usage
*/

unknown's avatar
SCRUM  
unknown committed
728 729 730
#define simple_command(mysql, command, arg, length, skip_check) \
  (*(mysql)->methods->advanced_command)(mysql, command,         \
					NullS, 0, arg, length, skip_check)
unknown's avatar
unknown committed
731
unsigned long net_safe_read(MYSQL* mysql);
unknown's avatar
unknown committed
732

unknown's avatar
unknown committed
733 734 735
#ifdef __NETWARE__
#pragma pack(pop)		/* restore alignment */
#endif
unknown's avatar
unknown committed
736 737 738 739 740

#ifdef	__cplusplus
}
#endif

unknown's avatar
unknown committed
741
#endif /* _mysql_h */