mysql.h 22.8 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"
venu@myvenu.com's avatar
venu@myvenu.com committed
60 61 62
#ifndef DBUG_OFF
#define CHECK_EXTRA_ARGUMENTS
#endif
bk@work.mysql.com's avatar
bk@work.mysql.com committed
63

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

bk@work.mysql.com's avatar
bk@work.mysql.com committed
66 67 68
extern unsigned int mysql_port;
extern char *mysql_unix_port;

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 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,
  MYSQL_OPT_GUESS_CONNECTION
};

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;
183
};
bk@work.mysql.com's avatar
bk@work.mysql.com committed
184

185 186 187 188
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
189

190 191
enum mysql_protocol_type 
{
192 193
  MYSQL_PROTOCOL_DEFAULT, MYSQL_PROTOCOL_TCP, MYSQL_PROTOCOL_SOCKET,
  MYSQL_PROTOCOL_PIPE, MYSQL_PROTOCOL_MEMORY
194
};
195 196 197 198
/*
  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
199
*/
200 201 202 203
enum mysql_rpl_type 
{
  MYSQL_RPL_MASTER, MYSQL_RPL_SLAVE, MYSQL_RPL_ADMIN
};
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
204

hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
205
struct st_mysql_methods;
206

hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
207
#if !defined(CHECK_EMBEDDED_DIFFERENCES) || !defined(EMBEDDED_LIBRARY)
208

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

236 237 238 239 240
 /*
   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;
241 242 243 244
  /*
    Pointers to the master, and the next slave connections, points to
    itself if lone connection.
  */
245
  struct st_mysql* master, *next_slave;
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
246

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

  LIST  *stmts;                     /* list of all statements */
hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
252
  const struct st_mysql_methods *methods;
hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
253 254 255 256 257
#if !defined(CHECK_EMBEDDED_DIFFERENCES)
  struct st_mysql_res *result;
  void *thd;
  unsigned int last_errno;
  char *last_error;
hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
258
  char sqlstate[SQLSTATE_LENGTH+1];	/* Used by embedded server */
hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
259
#endif
bk@work.mysql.com's avatar
bk@work.mysql.com committed
260 261
} MYSQL;

262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
#else

struct st_mysql_res;

typedef struct st_mysql
{
  struct st_mysql_res *result;
  void *thd;
  struct charset_info_st *charset;
  unsigned int  server_language;
  MYSQL_FIELD	*fields;
  MEM_ROOT	field_alloc;
  my_ulonglong affected_rows;
  unsigned int	field_count;
  struct st_mysql_options options;
  enum mysql_status status;
  my_bool	free_me;		/* If free in mysql_close */
  my_ulonglong insert_id;		/* id if insert on table with NEXTNR */
  unsigned int last_errno;
281 282
  char *last_error;			/* Used by embedded server */
  char sqlstate[SQLSTATE_LENGTH+1];	/* Used by embedded server */
283
} MYSQL;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
284

285
#endif
286 287

typedef struct st_mysql_res {
bk@work.mysql.com's avatar
bk@work.mysql.com committed
288 289 290 291
  my_ulonglong row_count;
  MYSQL_FIELD	*fields;
  MYSQL_DATA	*data;
  MYSQL_ROWS	*data_cursor;
292 293
  unsigned long *lengths;		/* column lengths of current row */
  MYSQL		*handle;		/* for unbuffered reads */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
294
  MEM_ROOT	field_alloc;
295
  unsigned int	field_count, current_field;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
296 297
  MYSQL_ROW	row;			/* If unbuffered read */
  MYSQL_ROW	current_row;		/* buffer to current row */
298
  my_bool	eof;			/* Used by mysql_fetch_row */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
299 300
} MYSQL_RES;

301 302
#define MAX_MYSQL_MANAGER_ERR 256  
#define MAX_MYSQL_MANAGER_MSG 256
tim@black.box's avatar
tim@black.box committed
303

304 305 306 307 308 309
#define MANAGER_OK           200
#define MANAGER_INFO         250
#define MANAGER_ACCESS       401
#define MANAGER_CLIENT_ERR   450
#define MANAGER_INTERNAL_ERR 500

hf@deer.(none)'s avatar
hf@deer.(none) committed
310 311 312 313
#ifndef MYSQL_SERVER
#define MYSQL_CLIENT
#endif

314

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

316 317
typedef struct st_mysql_manager
{
318
  NET net;
319 320 321 322 323 324 325 326 327 328
  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
329

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 339 340 341 342 343
/*
  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.
*/
344 345
my_bool STDCALL mysql_thread_init(void);
void STDCALL mysql_thread_end(void);
tim@black.box's avatar
tim@black.box committed
346

347 348 349 350
/*
  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
351 352 353 354 355 356 357

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
358 359
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
360 361 362 363 364

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
365
const char * STDCALL mysql_error(MYSQL *mysql);
366
const char *STDCALL mysql_sqlstate(MYSQL *mysql);
367
unsigned int STDCALL mysql_warning_count(MYSQL *mysql);
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
368
const char * STDCALL mysql_info(MYSQL *mysql);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
369 370 371 372
unsigned long STDCALL mysql_thread_id(MYSQL *mysql);
const char * STDCALL mysql_character_set_name(MYSQL *mysql);

MYSQL *		STDCALL mysql_init(MYSQL *mysql);
373
my_bool		STDCALL mysql_ssl_set(MYSQL *mysql, const char *key,
bk@work.mysql.com's avatar
bk@work.mysql.com committed
374
				      const char *cert, const char *ca,
375
				      const char *capath, const char *cipher);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
376 377 378 379 380 381 382 383
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,
384
					   unsigned long clientflag);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
385 386
int		STDCALL mysql_select_db(MYSQL *mysql, const char *db);
int		STDCALL mysql_query(MYSQL *mysql, const char *q);
387
int		STDCALL mysql_send_query(MYSQL *mysql, const char *q,
388
					 unsigned long length);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
389
int		STDCALL mysql_real_query(MYSQL *mysql, const char *q,
390
					unsigned long length);
391
/* perform query on master */
392 393 394 395
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);
396
/* perform query on slave */  
397 398 399 400
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);
401

402 403 404 405
/*
  enable/disable parsing of all queries to decide if they go on master or
  slave
*/
406 407 408 409 410 411 412 413 414
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 */  
415
my_bool		STDCALL mysql_reads_from_master_enabled(MYSQL* mysql);
416

417
enum mysql_rpl_type     STDCALL mysql_rpl_query_type(const char* q, int len);  
418 419

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

422 423
/* set the master, close/free the old one, if it is not a pivot */
int             STDCALL mysql_set_master(MYSQL* mysql, const char* host,
424 425 426
					 unsigned int port,
					 const char* user,
					 const char* passwd);
427
int             STDCALL mysql_add_slave(MYSQL* mysql, const char* host,
428 429 430
					unsigned int port,
					const char* user,
					const char* passwd);
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
431

bk@work.mysql.com's avatar
bk@work.mysql.com committed
432 433 434 435 436 437
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);
int		STDCALL mysql_ping(MYSQL *mysql);
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
438 439
const char *		STDCALL mysql_stat(MYSQL *mysql);
const char *		STDCALL mysql_get_server_info(MYSQL *mysql);
440
unsigned long		STDCALL mysql_get_server_version(MYSQL *mysql);
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
441 442
const char *		STDCALL mysql_get_client_info(void);
const char *		STDCALL mysql_get_host_info(MYSQL *mysql);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
443 444 445 446 447 448 449 450 451 452 453
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_fields(MYSQL *mysql, const char *table,
					 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
454 455
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
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
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);
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);
479 480 481 482 483 484 485 486 487 488 489 490
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);
491 492 493


/*
monty@narttu.mysql.fi's avatar
monty@narttu.mysql.fi committed
494
  The following definitions are added for the enhanced 
495 496 497 498
  client-server protocol
*/

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

501 502 503 504 505 506 507 508 509 510
/* 
  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;
511
  unsigned long second_part;  
512 513 514 515 516 517 518
  my_bool       neg;

  enum mysql_st_timestamp_type time_type;
  
} MYSQL_TIME;


519
/* bind structure */
520 521
typedef struct st_mysql_bind
{
522 523 524
  unsigned long	*length;          /* output length pointer */
  my_bool       *is_null;	  /* Pointer to null indicators */
  char		*buffer;	  /* buffer to get/put data */
525
  enum enum_field_types buffer_type;	/* buffer type */
526 527 528 529 530 531 532 533 534
  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 */
  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 */
535
  void (*store_param_func)(NET *net, struct st_mysql_bind *param);
venu@myvenu.com's avatar
venu@myvenu.com committed
536
  void (*fetch_result)(struct st_mysql_bind *, unsigned char **row);
537 538 539
} MYSQL_BIND;


540 541 542
/* statement handler */
typedef struct st_mysql_stmt
{
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559
  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  param_count;	       /* parameters count */
  unsigned long  field_count;	       /* fields count */
  unsigned long	 stmt_id;	       /* Id for prepared statement */
  unsigned int	 last_errno;	       /* error code */
  enum PREP_STMT_STATE state;	       /* statement state */
  char		 last_error[MYSQL_ERRMSG_SIZE]; /* error message */
560
  char		 sqlstate[SQLSTATE_LENGTH+1];
561 562 563 564 565
  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 */
566 567 568
} MYSQL_STMT;


hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
#define mysql_close(sock) (*(sock)->methods->close)(sock)
#define mysql_read_query_result(mysql) (*(mysql)->methods->read_query_result)(mysql)
#define mysql_store_result(mysql) (*(mysql)->methods->store_result)(mysql)
#define mysql_use_result(mysql) (*(mysql)->methods->use_result)(mysql)

typedef struct st_mysql_methods
{
  void    STDCALL (*close)(MYSQL *sock);
  my_bool STDCALL (*read_query_result)(MYSQL *mysql);
  my_bool STDCALL (*advanced_command)(MYSQL *mysql, 
				      enum enum_server_command command,
				      const char *header, 
				      ulong header_length,
				      const char *arg, 
				      ulong arg_length, my_bool skip_check);
  MYSQL_RES *	STDCALL (*store_result)(MYSQL *mysql);
  MYSQL_RES *	STDCALL (*use_result)(MYSQL *mysql);
} MYSQL_METHODS;

588 589
MYSQL_STMT * STDCALL mysql_prepare(MYSQL * mysql, const char *query,
				   unsigned long length);
590
int STDCALL mysql_execute(MYSQL_STMT * stmt);
591
unsigned long STDCALL mysql_param_count(MYSQL_STMT * stmt);
bar@bar.mysql.r18.ru's avatar
bar@bar.mysql.r18.ru committed
592 593
my_bool STDCALL mysql_bind_param(MYSQL_STMT * stmt, MYSQL_BIND * bnd);
my_bool STDCALL mysql_bind_result(MYSQL_STMT * stmt, MYSQL_BIND * bnd);
594
my_bool STDCALL mysql_stmt_close(MYSQL_STMT * stmt);
595
my_bool STDCALL mysql_stmt_free_result(MYSQL_STMT *stmt);
596
unsigned int STDCALL mysql_stmt_errno(MYSQL_STMT * stmt);
597
const char *STDCALL mysql_stmt_error(MYSQL_STMT * stmt);
598
const char *STDCALL mysql_stmt_sqlstate(MYSQL_STMT * stmt);
599 600 601 602
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);
603 604 605
int STDCALL mysql_fetch_column(MYSQL_STMT *stmt, MYSQL_BIND *bind, 
                               my_ulonglong column, 
                               unsigned long offset);
606
my_bool STDCALL mysql_send_long_data(MYSQL_STMT *stmt, 
607
				     unsigned int param_number,
608
				     const char *data, 
609
				     unsigned long length);
610
MYSQL_RES *STDCALL mysql_prepare_result(MYSQL_STMT *stmt);
venu@myvenu.com's avatar
venu@myvenu.com committed
611
MYSQL_RES *STDCALL mysql_param_result(MYSQL_STMT *stmt);
612
my_ulonglong STDCALL mysql_stmt_affected_rows(MYSQL_STMT *stmt);
613
int STDCALL mysql_stmt_store_result(MYSQL_STMT *stmt);
614 615
my_bool STDCALL mysql_more_results(MYSQL *mysql);
my_bool STDCALL mysql_next_result(MYSQL *mysql);
616 617 618 619
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);
620
my_ulonglong STDCALL mysql_stmt_num_rows(MYSQL_STMT *stmt);
621

622
/* status return codes */
623
#define MYSQL_NO_DATA      100
624

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

tim@black.box's avatar
tim@black.box committed
627
#ifdef USE_OLD_FUNCTIONS
628 629 630 631
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);
632
#define	 mysql_reload(mysql) mysql_refresh((mysql),REFRESH_GRANT)
633
#endif
634
#define HAVE_MYSQL_REAL_CONNECT
635

636 637 638 639 640
/*
  The following functions are mainly exported because of mysqlbinlog;
  They are not for general usage
*/

641 642
my_bool
simple_command(MYSQL *mysql,enum enum_server_command command, const char *arg,
643
	       unsigned long length, my_bool skip_check);
644
unsigned long net_safe_read(MYSQL* mysql);
645
void mysql_once_init(void);
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
646 647 648 649

#ifdef __NETWARE__
#pragma pack(pop)		/* restore alignment */
#endif
bk@work.mysql.com's avatar
bk@work.mysql.com committed
650 651 652 653 654

#ifdef	__cplusplus
}
#endif

655
#endif /* _mysql_h */