mysql.h
上传用户:jxpjxmjjw
上传日期:2009-12-07
资源大小:5877k
文件大小:15k
源码类别:

模拟服务器

开发平台:

Visual C++

  1. /* Copyright (C) 2000-2003 MySQL AB
  2.    This program is free software; you can redistribute it and/or modify
  3.    it under the terms of the GNU General Public License as published by
  4.    the Free Software Foundation; either version 2 of the License, or
  5.    (at your option) any later version.
  6.    This program is distributed in the hope that it will be useful,
  7.    but WITHOUT ANY WARRANTY; without even the implied warranty of
  8.    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  9.    GNU General Public License for more details.
  10.    You should have received a copy of the GNU General Public License
  11.    along with this program; if not, write to the Free Software
  12.    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */
  13. #ifndef _mysql_h
  14. #define _mysql_h
  15. #ifdef __CYGWIN__     /* CYGWIN implements a UNIX API */
  16. #undef WIN
  17. #undef _WIN
  18. #undef _WIN32
  19. #undef _WIN64
  20. #undef __WIN__
  21. #endif
  22. #ifdef __cplusplus
  23. extern "C" {
  24. #endif
  25. #ifndef _global_h /* If not standard header */
  26. #include <sys/types.h>
  27. #ifdef __LCC__
  28. #include <winsock.h> /* For windows */
  29. #endif
  30. typedef char my_bool;
  31. #if (defined(_WIN32) || defined(_WIN64)) && !defined(__WIN__)
  32. #define __WIN__
  33. #endif
  34. #if !defined(__WIN__)
  35. #define STDCALL
  36. #else
  37. #define STDCALL __stdcall
  38. #endif
  39. typedef char * gptr;
  40. #ifndef my_socket_defined
  41. #ifdef __WIN__
  42. #define my_socket SOCKET
  43. #else
  44. typedef int my_socket;
  45. #endif /* __WIN__ */
  46. #endif /* my_socket_defined */
  47. #endif /* _global_h */
  48. #include "mysql_com.h"
  49. #include "mysql_version.h"
  50. extern unsigned int mysql_port;
  51. extern char *mysql_unix_port;
  52. #define CLIENT_NET_READ_TIMEOUT 365*24*3600 /* Timeout on read */
  53. #define CLIENT_NET_WRITE_TIMEOUT 365*24*3600 /* Timeout on write */
  54. #ifdef __NETWARE__
  55. #pragma pack(push, 8) /* 8 byte alignment */
  56. #endif
  57. #define IS_PRI_KEY(n) ((n) & PRI_KEY_FLAG)
  58. #define IS_NOT_NULL(n) ((n) & NOT_NULL_FLAG)
  59. #define IS_BLOB(n) ((n) & BLOB_FLAG)
  60. #define IS_NUM(t) ((t) <= FIELD_TYPE_INT24 || (t) == FIELD_TYPE_YEAR)
  61. #define IS_NUM_FIELD(f)  ((f)->flags & NUM_FLAG)
  62. #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)
  63. typedef struct st_mysql_field {
  64.   char *name; /* Name of column */
  65.   char *table; /* Table of column if column was a field */
  66.   char *org_table; /* Org table name if table was an alias */
  67.   char *db; /* Database for table */
  68.   char *def; /* Default value (set by mysql_list_fields) */
  69.   unsigned long length; /* Width of column */
  70.   unsigned long max_length; /* Max width of selected set */
  71.   unsigned int flags; /* Div flags */
  72.   unsigned int decimals; /* Number of decimals in field */
  73.   enum enum_field_types type; /* Type of field. Se mysql_com.h for types */
  74. } MYSQL_FIELD;
  75. typedef char **MYSQL_ROW; /* return data as array of strings */
  76. typedef unsigned int MYSQL_FIELD_OFFSET; /* offset to current field */
  77. #if defined(NO_CLIENT_LONG_LONG)
  78. typedef unsigned long my_ulonglong;
  79. #elif defined (__WIN__)
  80. typedef unsigned __int64 my_ulonglong;
  81. #else
  82. typedef unsigned long long my_ulonglong;
  83. #endif
  84. #define MYSQL_COUNT_ERROR (~(my_ulonglong) 0)
  85. typedef struct st_mysql_rows {
  86.   struct st_mysql_rows *next; /* list of rows */
  87.   MYSQL_ROW data;
  88. } MYSQL_ROWS;
  89. typedef MYSQL_ROWS *MYSQL_ROW_OFFSET; /* offset to current row */
  90. #include "my_alloc.h"
  91. typedef struct st_mysql_data {
  92.   my_ulonglong rows;
  93.   unsigned int fields;
  94.   MYSQL_ROWS *data;
  95.   MEM_ROOT alloc;
  96. } MYSQL_DATA;
  97. struct st_mysql_options {
  98.   unsigned int connect_timeout,client_flag;
  99.   unsigned int port;
  100.   char *host,*init_command,*user,*password,*unix_socket,*db;
  101.   char *my_cnf_file,*my_cnf_group, *charset_dir, *charset_name;
  102.   char *ssl_key; /* PEM key file */
  103.   char *ssl_cert; /* PEM cert file */
  104.   char *ssl_ca; /* PEM CA file */
  105.   char *ssl_capath; /* PEM directory of CA-s? */
  106.   char *ssl_cipher; /* cipher to use */
  107.   unsigned long max_allowed_packet;
  108.   my_bool use_ssl; /* if to use SSL or not */
  109.   my_bool compress,named_pipe;
  110.  /*
  111.    On connect, find out the replication role of the server, and
  112.    establish connections to all the peers
  113.  */
  114.   my_bool rpl_probe;
  115.  /*
  116.    Each call to mysql_real_query() will parse it to tell if it is a read
  117.    or a write, and direct it to the slave or the master
  118.  */
  119.   my_bool rpl_parse;
  120.  /*
  121.    If set, never read from a master,only from slave, when doing
  122.    a read that is replication-aware
  123.  */
  124.   my_bool no_master_reads;
  125. };
  126. enum mysql_option { MYSQL_OPT_CONNECT_TIMEOUT, MYSQL_OPT_COMPRESS,
  127.     MYSQL_OPT_NAMED_PIPE, MYSQL_INIT_COMMAND,
  128.     MYSQL_READ_DEFAULT_FILE, MYSQL_READ_DEFAULT_GROUP,
  129.     MYSQL_SET_CHARSET_DIR, MYSQL_SET_CHARSET_NAME,
  130.     MYSQL_OPT_LOCAL_INFILE};
  131. enum mysql_status { MYSQL_STATUS_READY,MYSQL_STATUS_GET_RESULT,
  132.     MYSQL_STATUS_USE_RESULT};
  133. /*
  134.   There are three types of queries - the ones that have to go to
  135.   the master, the ones that go to a slave, and the adminstrative
  136.   type which must happen on the pivot connectioin
  137. */
  138. enum mysql_rpl_type { MYSQL_RPL_MASTER, MYSQL_RPL_SLAVE,
  139.       MYSQL_RPL_ADMIN };
  140. typedef struct st_mysql {
  141.   NET net; /* Communication parameters */
  142.   gptr connector_fd; /* ConnectorFd for SSL */
  143.   char *host,*user,*passwd,*unix_socket,*server_version,*host_info,
  144. *info,*db;
  145.   struct charset_info_st *charset;
  146.   MYSQL_FIELD *fields;
  147.   MEM_ROOT field_alloc;
  148.   my_ulonglong affected_rows;
  149.   my_ulonglong insert_id; /* id if insert on table with NEXTNR */
  150.   my_ulonglong extra_info; /* Used by mysqlshow */
  151.   unsigned long thread_id; /* Id for connection in server */
  152.   unsigned long packet_length;
  153.   unsigned int port,client_flag,server_capabilities;
  154.   unsigned int protocol_version;
  155.   unsigned int field_count;
  156.   unsigned int  server_status;
  157.   unsigned int  server_language;
  158.   struct st_mysql_options options;
  159.   enum mysql_status status;
  160.   my_bool free_me; /* If free in mysql_close */
  161.   my_bool reconnect; /* set to 1 if automatic reconnect */
  162.   char         scramble_buff[9];
  163.  /*
  164.    Set if this is the original connection, not a master or a slave we have
  165.    added though mysql_rpl_probe() or mysql_set_master()/ mysql_add_slave()
  166.  */
  167.   my_bool rpl_pivot;
  168.   /*
  169.     Pointers to the master, and the next slave connections, points to
  170.     itself if lone connection.
  171.   */
  172.   struct st_mysql* master, *next_slave;
  173.   struct st_mysql* last_used_slave; /* needed for round-robin slave pick */
  174.  /* needed for send/read/store/use result to work correctly with replication */
  175.   struct st_mysql* last_used_con;
  176. } MYSQL;
  177. typedef struct st_mysql_res {
  178.   my_ulonglong row_count;
  179.   MYSQL_FIELD *fields;
  180.   MYSQL_DATA *data;
  181.   MYSQL_ROWS *data_cursor;
  182.   unsigned long *lengths; /* column lengths of current row */
  183.   MYSQL *handle; /* for unbuffered reads */
  184.   MEM_ROOT field_alloc;
  185.   unsigned int field_count, current_field;
  186.   MYSQL_ROW row; /* If unbuffered read */
  187.   MYSQL_ROW current_row; /* buffer to current row */
  188.   my_bool eof; /* Used by mysql_fetch_row */
  189. } MYSQL_RES;
  190. #define MAX_MYSQL_MANAGER_ERR 256  
  191. #define MAX_MYSQL_MANAGER_MSG 256
  192. #define MANAGER_OK           200
  193. #define MANAGER_INFO         250
  194. #define MANAGER_ACCESS       401
  195. #define MANAGER_CLIENT_ERR   450
  196. #define MANAGER_INTERNAL_ERR 500
  197. typedef struct st_mysql_manager
  198. {
  199.   NET net;
  200.   char *host,*user,*passwd;
  201.   unsigned int port;
  202.   my_bool free_me;
  203.   my_bool eof;
  204.   int cmd_status;
  205.   int last_errno;
  206.   char* net_buf,*net_buf_pos,*net_data_end;
  207.   int net_buf_size;
  208.   char last_error[MAX_MYSQL_MANAGER_ERR];
  209. } MYSQL_MANAGER;
  210. /*
  211.   Set up and bring down the server; to ensure that applications will
  212.   work when linked against either the standard client library or the
  213.   embedded server library, these functions should be called.
  214. */
  215. int STDCALL mysql_server_init(int argc, char **argv, char **groups);
  216. void STDCALL mysql_server_end(void);
  217. /*
  218.   Set up and bring down a thread; these function should be called
  219.   for each thread in an application which opens at least one MySQL
  220.   connection.  All uses of the connection(s) should be between these
  221.   function calls.
  222. */
  223. my_bool STDCALL mysql_thread_init(void);
  224. void STDCALL mysql_thread_end(void);
  225. /*
  226.   Functions to get information from the MYSQL and MYSQL_RES structures
  227.   Should definitely be used if one uses shared libraries.
  228. */
  229. my_ulonglong STDCALL mysql_num_rows(MYSQL_RES *res);
  230. unsigned int STDCALL mysql_num_fields(MYSQL_RES *res);
  231. my_bool STDCALL mysql_eof(MYSQL_RES *res);
  232. MYSQL_FIELD *STDCALL mysql_fetch_field_direct(MYSQL_RES *res,
  233.       unsigned int fieldnr);
  234. MYSQL_FIELD * STDCALL mysql_fetch_fields(MYSQL_RES *res);
  235. MYSQL_ROW_OFFSET STDCALL mysql_row_tell(MYSQL_RES *res);
  236. MYSQL_FIELD_OFFSET STDCALL mysql_field_tell(MYSQL_RES *res);
  237. unsigned int STDCALL mysql_field_count(MYSQL *mysql);
  238. my_ulonglong STDCALL mysql_affected_rows(MYSQL *mysql);
  239. my_ulonglong STDCALL mysql_insert_id(MYSQL *mysql);
  240. unsigned int STDCALL mysql_errno(MYSQL *mysql);
  241. const char * STDCALL mysql_error(MYSQL *mysql);
  242. const char * STDCALL mysql_info(MYSQL *mysql);
  243. unsigned long STDCALL mysql_thread_id(MYSQL *mysql);
  244. const char * STDCALL mysql_character_set_name(MYSQL *mysql);
  245. MYSQL * STDCALL mysql_init(MYSQL *mysql);
  246. int STDCALL mysql_ssl_set(MYSQL *mysql, const char *key,
  247.       const char *cert, const char *ca,
  248.       const char *capath, const char *cipher);
  249. my_bool STDCALL mysql_change_user(MYSQL *mysql, const char *user, 
  250.   const char *passwd, const char *db);
  251. MYSQL * STDCALL mysql_real_connect(MYSQL *mysql, const char *host,
  252.    const char *user,
  253.    const char *passwd,
  254.    const char *db,
  255.    unsigned int port,
  256.    const char *unix_socket,
  257.    unsigned int clientflag);
  258. void STDCALL mysql_close(MYSQL *sock);
  259. int STDCALL mysql_select_db(MYSQL *mysql, const char *db);
  260. int STDCALL mysql_query(MYSQL *mysql, const char *q);
  261. int STDCALL mysql_send_query(MYSQL *mysql, const char *q,
  262.  unsigned long length);
  263. int STDCALL mysql_read_query_result(MYSQL *mysql);
  264. int STDCALL mysql_real_query(MYSQL *mysql, const char *q,
  265. unsigned long length);
  266. /* perform query on master */
  267. int STDCALL mysql_master_query(MYSQL *mysql, const char *q,
  268. unsigned long length);
  269. int STDCALL mysql_master_send_query(MYSQL *mysql, const char *q,
  270. unsigned long length);
  271. /* perform query on slave */  
  272. int STDCALL mysql_slave_query(MYSQL *mysql, const char *q,
  273. unsigned long length);
  274. int STDCALL mysql_slave_send_query(MYSQL *mysql, const char *q,
  275. unsigned long length);
  276. /*
  277.   enable/disable parsing of all queries to decide if they go on master or
  278.   slave
  279. */
  280. void            STDCALL mysql_enable_rpl_parse(MYSQL* mysql);
  281. void            STDCALL mysql_disable_rpl_parse(MYSQL* mysql);
  282. /* get the value of the parse flag */  
  283. int             STDCALL mysql_rpl_parse_enabled(MYSQL* mysql);
  284. /*  enable/disable reads from master */
  285. void            STDCALL mysql_enable_reads_from_master(MYSQL* mysql);
  286. void            STDCALL mysql_disable_reads_from_master(MYSQL* mysql);
  287. /* get the value of the master read flag */  
  288. int             STDCALL mysql_reads_from_master_enabled(MYSQL* mysql);
  289. enum mysql_rpl_type     STDCALL mysql_rpl_query_type(const char* q, int len);  
  290. /* discover the master and its slaves */  
  291. int             STDCALL mysql_rpl_probe(MYSQL* mysql);
  292. /* set the master, close/free the old one, if it is not a pivot */
  293. int             STDCALL mysql_set_master(MYSQL* mysql, const char* host,
  294.  unsigned int port,
  295.  const char* user,
  296.  const char* passwd);
  297. int             STDCALL mysql_add_slave(MYSQL* mysql, const char* host,
  298. unsigned int port,
  299. const char* user,
  300. const char* passwd);
  301. int STDCALL mysql_shutdown(MYSQL *mysql);
  302. int STDCALL mysql_dump_debug_info(MYSQL *mysql);
  303. int STDCALL mysql_refresh(MYSQL *mysql,
  304.      unsigned int refresh_options);
  305. int STDCALL mysql_kill(MYSQL *mysql,unsigned long pid);
  306. int STDCALL mysql_ping(MYSQL *mysql);
  307. const char * STDCALL mysql_stat(MYSQL *mysql);
  308. const char * STDCALL mysql_get_server_info(MYSQL *mysql);
  309. const char * STDCALL mysql_get_client_info(void);
  310. unsigned long STDCALL mysql_get_client_version(void);
  311. const char * STDCALL mysql_get_host_info(MYSQL *mysql);
  312. unsigned int STDCALL mysql_get_proto_info(MYSQL *mysql);
  313. MYSQL_RES * STDCALL mysql_list_dbs(MYSQL *mysql,const char *wild);
  314. MYSQL_RES * STDCALL mysql_list_tables(MYSQL *mysql,const char *wild);
  315. MYSQL_RES * STDCALL mysql_list_fields(MYSQL *mysql, const char *table,
  316.  const char *wild);
  317. MYSQL_RES * STDCALL mysql_list_processes(MYSQL *mysql);
  318. MYSQL_RES * STDCALL mysql_store_result(MYSQL *mysql);
  319. MYSQL_RES * STDCALL mysql_use_result(MYSQL *mysql);
  320. int STDCALL mysql_options(MYSQL *mysql,enum mysql_option option,
  321.       const char *arg);
  322. void STDCALL mysql_free_result(MYSQL_RES *result);
  323. void STDCALL mysql_data_seek(MYSQL_RES *result,
  324. my_ulonglong offset);
  325. MYSQL_ROW_OFFSET STDCALL mysql_row_seek(MYSQL_RES *result,
  326. MYSQL_ROW_OFFSET offset);
  327. MYSQL_FIELD_OFFSET STDCALL mysql_field_seek(MYSQL_RES *result,
  328.    MYSQL_FIELD_OFFSET offset);
  329. MYSQL_ROW STDCALL mysql_fetch_row(MYSQL_RES *result);
  330. unsigned long * STDCALL mysql_fetch_lengths(MYSQL_RES *result);
  331. MYSQL_FIELD * STDCALL mysql_fetch_field(MYSQL_RES *result);
  332. unsigned long STDCALL mysql_escape_string(char *to,const char *from,
  333.     unsigned long from_length);
  334. unsigned long STDCALL mysql_real_escape_string(MYSQL *mysql,
  335.        char *to,const char *from,
  336.        unsigned long length);
  337. void STDCALL mysql_debug(const char *debug);
  338. char * STDCALL mysql_odbc_escape_string(MYSQL *mysql,
  339.  char *to,
  340.  unsigned long to_length,
  341.  const char *from,
  342.  unsigned long from_length,
  343.  void *param,
  344.  char *
  345.  (*extend_buffer)
  346.  (void *, char *to,
  347.   unsigned long *length));
  348. void  STDCALL myodbc_remove_escape(MYSQL *mysql,char *name);
  349. unsigned int STDCALL mysql_thread_safe(void);
  350. MYSQL_MANAGER*  STDCALL mysql_manager_init(MYSQL_MANAGER* con);  
  351. MYSQL_MANAGER*  STDCALL mysql_manager_connect(MYSQL_MANAGER* con,
  352.       const char* host,
  353.       const char* user,
  354.       const char* passwd,
  355.       unsigned int port);
  356. void            STDCALL mysql_manager_close(MYSQL_MANAGER* con);
  357. int             STDCALL mysql_manager_command(MYSQL_MANAGER* con,
  358. const char* cmd, int cmd_len);
  359. int             STDCALL mysql_manager_fetch_line(MYSQL_MANAGER* con,
  360.   char* res_buf,
  361.  int res_buf_size);
  362. #define mysql_reload(mysql) mysql_refresh((mysql),REFRESH_GRANT)
  363. #ifdef USE_OLD_FUNCTIONS
  364. MYSQL * STDCALL mysql_connect(MYSQL *mysql, const char *host,
  365.       const char *user, const char *passwd);
  366. int STDCALL mysql_create_db(MYSQL *mysql, const char *DB);
  367. int STDCALL mysql_drop_db(MYSQL *mysql, const char *DB);
  368. #define  mysql_reload(mysql) mysql_refresh((mysql),REFRESH_GRANT)
  369. #endif
  370. #define HAVE_MYSQL_REAL_CONNECT
  371. /*
  372.   The following functions are mainly exported because of mysqlbinlog;
  373.   They are not for general usage
  374. */
  375. int simple_command(MYSQL *mysql,enum enum_server_command command,
  376.    const char *arg, unsigned long length, my_bool skipp_check);
  377. unsigned long net_safe_read(MYSQL* mysql);
  378. int mysql_once_init(void);
  379. extern my_bool server_inited;
  380. #ifdef __NETWARE__
  381. #pragma pack(pop) /* restore alignment */
  382. #endif
  383. #ifdef __cplusplus
  384. }
  385. #endif
  386. #endif /* _mysql_h */