mysql.h 27.2 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

bk@work.mysql.com's avatar
bk@work.mysql.com committed
81
typedef struct st_mysql_field {
82
  char *name;                 /* Name of column */
monty@narttu.mysql.fi's avatar
monty@narttu.mysql.fi committed
83
  char *org_name;             /* Original column name, if an alias */ 
84 85 86
  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 */
87
  char *catalog;	      /* Catalog for table */
88
  char *def;                  /* Default value (set by mysql_list_fields) */
89 90
  unsigned long length;       /* Width of column (create length) */
  unsigned long max_length;   /* Max width for selected set */
91 92 93 94 95
  unsigned int name_length;
  unsigned int org_name_length;
  unsigned int table_length;
  unsigned int org_table_length;
  unsigned int db_length;
96
  unsigned int catalog_length;
97
  unsigned int def_length;
98 99
  unsigned int flags;         /* Div flags */
  unsigned int decimals;      /* Number of decimals in field */
100
  unsigned int charsetnr;     /* Character set */
101
  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
102 103 104 105 106
} 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
107
#ifndef _global_h
bk@work.mysql.com's avatar
bk@work.mysql.com committed
108 109 110 111 112 113 114
#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
115
#endif
bk@work.mysql.com's avatar
bk@work.mysql.com committed
116 117 118 119 120 121

#define MYSQL_COUNT_ERROR (~(my_ulonglong) 0)

typedef struct st_mysql_rows {
  struct st_mysql_rows *next;		/* list of rows */
  MYSQL_ROW data;
serg@serg.mylan's avatar
serg@serg.mylan committed
122
  unsigned long length;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
123 124 125 126
} MYSQL_ROWS;

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

127
#include "my_alloc.h"
128

bk@work.mysql.com's avatar
bk@work.mysql.com committed
129 130 131 132 133
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
134
#if !defined(CHECK_EMBEDDED_DIFFERENCES) || defined(EMBEDDED_LIBRARY)
135 136
  MYSQL_ROWS **prev_ptr;
#endif
bk@work.mysql.com's avatar
bk@work.mysql.com committed
137 138
} MYSQL_DATA;

hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
139 140 141 142 143 144 145 146
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,
147
  MYSQL_OPT_GUESS_CONNECTION, MYSQL_SET_CLIENT_IP, MYSQL_SECURE_AUTH
hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
148 149
};

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

  /* function pointers for local infile support */
190
  int (*local_infile_init)(void **, const char *, void *);
monty@mysql.com's avatar
monty@mysql.com committed
191
  int (*local_infile_read)(void *, char *, unsigned int);
monty@mysql.com's avatar
monty@mysql.com committed
192
  void (*local_infile_end)(void *);
monty@mysql.com's avatar
monty@mysql.com committed
193
  int (*local_infile_error)(void *, char *, unsigned int);
194
  void *local_infile_userdata;
195
};
bk@work.mysql.com's avatar
bk@work.mysql.com committed
196

197 198 199 200
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
201

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

hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
217
struct st_mysql_methods;
218

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

245
  /* session-wide random string */
246
  char	        scramble[SCRAMBLE_LENGTH+1];
247

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

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

  LIST  *stmts;                     /* list of all statements */
hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
264
  const struct st_mysql_methods *methods;
265
  void *thd;
266 267 268 269 270
  /*
    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;
271
} MYSQL;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
272

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

290 291
#define MAX_MYSQL_MANAGER_ERR 256  
#define MAX_MYSQL_MANAGER_MSG 256
tim@black.box's avatar
tim@black.box committed
292

293 294 295 296 297 298
#define MANAGER_OK           200
#define MANAGER_INFO         250
#define MANAGER_ACCESS       401
#define MANAGER_CLIENT_ERR   450
#define MANAGER_INTERNAL_ERR 500

299
#if !defined(MYSQL_SERVER) && !defined(MYSQL_CLIENT)
hf@deer.(none)'s avatar
hf@deer.(none) committed
300 301 302
#define MYSQL_CLIENT
#endif

303

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

305 306
typedef struct st_mysql_manager
{
307
  NET net;
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;
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
318

319 320 321 322 323 324 325 326 327 328 329
typedef struct st_mysql_parameters
{
  unsigned long *p_max_allowed_packet;
  unsigned long *p_net_buffer_length;
} MYSQL_PARAMETERS;

#if !defined(MYSQL_CLIENT) && !defined(MYSQL_SERVER) && !defined(EMBEDDED_LIBRARY)
#define max_allowed_packet (*mysql_get_parameters()->p_max_allowed_packet)
#define net_buffer_length (*mysql_get_parameters()->p_net_buffer_length)
#endif

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);
tim@black.box's avatar
tim@black.box committed
337

338
MYSQL_PARAMETERS *STDCALL mysql_get_parameters(void);
339

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);
tim@black.box's avatar
tim@black.box committed
348

349 350 351 352
/*
  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
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);
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
360 361
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
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);
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi 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);
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
370
const char * STDCALL mysql_info(MYSQL *mysql);
bk@work.mysql.com's avatar
bk@work.mysql.com 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,
bk@work.mysql.com's avatar
bk@work.mysql.com committed
376
				      const char *cert, const char *ca,
377
				      const char *capath, const char *cipher);
bk@work.mysql.com's avatar
bk@work.mysql.com 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);
bk@work.mysql.com's avatar
bk@work.mysql.com 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,
390
					 unsigned long length);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
391
int		STDCALL mysql_real_query(MYSQL *mysql, const char *q,
392
					unsigned long length);
hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
393
MYSQL_RES *     STDCALL mysql_store_result(MYSQL *mysql);
hf@deer.(none)'s avatar
hf@deer.(none) committed
394
MYSQL_RES *     STDCALL mysql_use_result(MYSQL *mysql);
hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) 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

monty@mysql.com's avatar
monty@mysql.com committed
411
void
412
mysql_set_local_infile_handler(MYSQL *mysql,
413 414
                               int (*local_infile_init)(void **, const char *,
                            void *),
monty@mysql.com's avatar
monty@mysql.com committed
415 416
                               int (*local_infile_read)(void *, char *,
							unsigned int),
monty@mysql.com's avatar
monty@mysql.com committed
417
                               void (*local_infile_end)(void *),
monty@mysql.com's avatar
monty@mysql.com 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);
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi 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);
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
455

456 457 458
int		STDCALL mysql_shutdown(MYSQL *mysql,
                                       enum enum_shutdown_level
                                       shutdown_level);
bk@work.mysql.com's avatar
bk@work.mysql.com 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);
bk@work.mysql.com's avatar
bk@work.mysql.com 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);
monty@narttu.mysql.fi's avatar
monty@narttu.mysql.fi committed
472
unsigned long	STDCALL mysql_get_server_version(MYSQL *mysql);
bk@work.mysql.com's avatar
bk@work.mysql.com 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);
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
482 483
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
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);
hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
489 490
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
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);
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);
hf@deer.(none)'s avatar
hf@deer.(none) committed
521
my_bool         STDCALL mysql_read_query_result(MYSQL *mysql);
522 523 524


/*
monty@narttu.mysql.fi's avatar
monty@narttu.mysql.fi 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

536 537 538 539 540 541 542 543 544 545
/* 
  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;
546
  unsigned long second_part;  
547 548 549 550 551 552 553
  my_bool       neg;

  enum mysql_st_timestamp_type time_type;
  
} MYSQL_TIME;


554
/* bind structure */
555 556
typedef struct st_mysql_bind
{
557 558 559
  unsigned long	*length;          /* output length pointer */
  my_bool       *is_null;	  /* Pointer to null indicators */
  char		*buffer;	  /* buffer to get/put data */
560
  enum enum_field_types buffer_type;	/* buffer type */
561 562
  unsigned long buffer_length;    /* buffer length, must be set for str/binary */  

563
  /* Following are for internal use. Set by mysql_stmt_bind_param */
564 565
  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
566
  unsigned long	internal_length;  /* Used if length is 0 */
567
  unsigned int	param_number;	  /* For null count and error messages */
568
  unsigned int  pack_length;	  /* Internal length for packed data */
569
  my_bool       is_unsigned;      /* set if integer type is unsigned */
570
  my_bool	long_data_used;	  /* If used with mysql_send_long_data */
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
571
  my_bool	internal_is_null; /* Used if is_null is 0 */
572
  void (*store_param_func)(NET *net, struct st_mysql_bind *param);
venu@myvenu.com's avatar
venu@myvenu.com committed
573
  void (*fetch_result)(struct st_mysql_bind *, unsigned char **row);
574 575
  void (*skip_result)(struct st_mysql_bind *, MYSQL_FIELD *,
		      unsigned char **row);
576 577 578
} MYSQL_BIND;


579 580 581
/* statement handler */
typedef struct st_mysql_stmt
{
582
  MEM_ROOT       mem_root;             /* root allocations */
583
  LIST           list;                 /* list to keep track of all stmts */
584 585 586 587
  MYSQL          *mysql;               /* connection handle */
  MYSQL_BIND     *params;              /* input parameters */
  MYSQL_BIND     *bind;                /* output parameters */
  MYSQL_FIELD    *fields;              /* result set metadata */
588 589
  MYSQL_DATA     result;               /* cached result set */
  MYSQL_ROWS     *data_cursor;         /* current row in cached result */
590 591
  /* copy of mysql->affected_rows after statement execution */
  my_ulonglong   affected_rows;
592
  my_ulonglong   insert_id;            /* copy of mysql->insert_id */
593 594 595 596 597 598
  /*
    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);
599 600
  unsigned long	 stmt_id;	       /* Id for prepared statement */
  unsigned int	 last_errno;	       /* error code */
601 602 603
  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 */
604
  char		 last_error[MYSQL_ERRMSG_SIZE]; /* error message */
605
  char		 sqlstate[SQLSTATE_LENGTH+1];
606 607 608 609 610 611
  /* 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;  
612 613 614 615 616
  /*
    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;     
617 618
} MYSQL_STMT;

619 620 621 622 623 624 625 626 627 628 629 630
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
};

631

hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
632 633
typedef struct st_mysql_methods
{
634 635 636 637 638 639 640 641 642 643 644 645 646
  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
647
#if !defined(MYSQL_SERVER) || defined(EMBEDDED_LIBRARY)
648 649 650
  MYSQL_FIELD * (*list_fields)(MYSQL *mysql);
  my_bool (*read_prepare_result)(MYSQL *mysql, MYSQL_STMT *stmt);
  int (*stmt_execute)(MYSQL_STMT *stmt);
651
  int (*read_binary_rows)(MYSQL_STMT *stmt);
652 653
  int (*unbuffered_fetch)(MYSQL *mysql, char **row);
  void (*free_embedded_thd)(MYSQL *mysql);
konstantin@oak.local's avatar
konstantin@oak.local committed
654
  const char *(*read_statistics)(MYSQL *mysql);
monty@mysql.com's avatar
monty@mysql.com committed
655
  my_bool (*next_result)(MYSQL *mysql);
656
  int (*read_change_user_result)(MYSQL *mysql, char *buff, const char *passwd);
hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
657
#endif
hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
658 659
} MYSQL_METHODS;

660 661 662 663
#ifdef HAVE_DEPRECATED_411_API
/* Deprecated calls (since MySQL 4.1.2) */

/* Use mysql_stmt_init + mysql_stmt_prepare instead */
664 665
MYSQL_STMT * STDCALL mysql_prepare(MYSQL * mysql, const char *query,
				   unsigned long length);
666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
#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);
688 689 690 691 692 693
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);
694 695
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);
696
my_bool STDCALL mysql_stmt_close(MYSQL_STMT * stmt);
697
my_bool STDCALL mysql_stmt_reset(MYSQL_STMT * stmt);
698
my_bool STDCALL mysql_stmt_free_result(MYSQL_STMT *stmt);
699 700 701 702 703 704
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);
705
unsigned int STDCALL mysql_stmt_errno(MYSQL_STMT * stmt);
706
const char *STDCALL mysql_stmt_error(MYSQL_STMT * stmt);
707
const char *STDCALL mysql_stmt_sqlstate(MYSQL_STMT * stmt);
708 709 710 711
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);
712
my_ulonglong STDCALL mysql_stmt_num_rows(MYSQL_STMT *stmt);
713
my_ulonglong STDCALL mysql_stmt_affected_rows(MYSQL_STMT *stmt);
714
my_ulonglong STDCALL mysql_stmt_insert_id(MYSQL_STMT *stmt);
715
unsigned int STDCALL mysql_stmt_field_count(MYSQL_STMT *stmt);
716 717 718 719 720 721

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);
722 723
void STDCALL mysql_close(MYSQL *sock);

724

725
/* status return codes */
726
#define MYSQL_NO_DATA      100
727

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

tim@black.box's avatar
tim@black.box committed
730
#ifdef USE_OLD_FUNCTIONS
731 732 733 734
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);
735
#define	 mysql_reload(mysql) mysql_refresh((mysql),REFRESH_GRANT)
736
#endif
737
#define HAVE_MYSQL_REAL_CONNECT
738

739 740 741 742 743
/*
  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
744 745 746
#define simple_command(mysql, command, arg, length, skip_check) \
  (*(mysql)->methods->advanced_command)(mysql, command,         \
					NullS, 0, arg, length, skip_check)
747
unsigned long net_safe_read(MYSQL* mysql);
748

monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
749 750 751
#ifdef __NETWARE__
#pragma pack(pop)		/* restore alignment */
#endif
bk@work.mysql.com's avatar
bk@work.mysql.com committed
752 753 754 755 756

#ifdef	__cplusplus
}
#endif

757
#endif /* _mysql_h */