home *** CD-ROM | disk | FTP | other *** search
/ Chip 2001 January / Chip_2001-01_cd1.bin / tema / mysql / mysql-3.23.28g-win-source.exe / include / mysql.h < prev    next >
C/C++ Source or Header  |  2000-09-12  |  10KB  |  298 lines
  1. /* Copyright (C) 2000 MySQL AB & MySQL Finland AB & TCX DataKonsult AB
  2.    
  3.    This library is free software; you can redistribute it and/or
  4.    modify it under the terms of the GNU Library General Public
  5.    License as published by the Free Software Foundation; either
  6.    version 2 of the License, or (at your option) any later version.
  7.    
  8.    This library is distributed in the hope that it will be useful,
  9.    but WITHOUT ANY WARRANTY; without even the implied warranty of
  10.    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11.    Library General Public License for more details.
  12.    
  13.    You should have received a copy of the GNU Library General Public
  14.    License along with this library; if not, write to the Free
  15.    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  16.    MA 02111-1307, USA */
  17.  
  18. /* defines for the libmysql library */
  19.  
  20. #ifndef _mysql_h
  21. #define _mysql_h
  22.  
  23. #ifndef MYSQL_SERVER
  24. #ifdef    __cplusplus
  25. extern "C" {
  26. #endif
  27. #endif
  28.   
  29. #ifndef _global_h                /* If not standard header */
  30. #include <sys/types.h>
  31. typedef char my_bool;
  32. #if (defined(_WIN32) || defined(_WIN64)) && !defined(__WIN__)
  33. #define __WIN__
  34. #endif
  35. #if !defined(__WIN__)
  36. #define STDCALL
  37. #else
  38. #define STDCALL __stdcall
  39. #endif
  40. typedef char * gptr;
  41.  
  42. #ifndef ST_USED_MEM_DEFINED
  43. #define ST_USED_MEM_DEFINED
  44. typedef struct st_used_mem {            /* struct for once_alloc */
  45.   struct st_used_mem *next;            /* Next block in use */
  46.   unsigned int    left;                /* memory left in block  */
  47.   unsigned int    size;                /* size of block */
  48. } USED_MEM;
  49. typedef struct st_mem_root {
  50.   USED_MEM *free;
  51.   USED_MEM *used;
  52.   USED_MEM *pre_alloc;
  53.   unsigned int    min_malloc;
  54.   unsigned int    block_size;
  55.  
  56.   void (*error_handler)(void);
  57. } MEM_ROOT;
  58. #endif
  59.  
  60. #ifndef my_socket_defined
  61. #ifdef __WIN__
  62. #define my_socket SOCKET
  63. #else
  64. typedef int my_socket;
  65. #endif
  66. #endif
  67. #endif
  68. #include "mysql_com.h"
  69. #include "mysql_version.h"
  70.  
  71. extern unsigned int mysql_port;
  72. extern char *mysql_unix_port;
  73.  
  74. #define IS_PRI_KEY(n)    ((n) & PRI_KEY_FLAG)
  75. #define IS_NOT_NULL(n)    ((n) & NOT_NULL_FLAG)
  76. #define IS_BLOB(n)    ((n) & BLOB_FLAG)
  77. #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)
  80.  
  81. typedef struct st_mysql_field {
  82.   char *name;            /* Name of column */
  83.   char *table;            /* Table of column if column was a field */
  84.   char *def;            /* Default value (set by mysql_list_fields) */
  85.   enum enum_field_types type;    /* Type of field. Se mysql_com.h for types */
  86.   unsigned int length;        /* Width of column */
  87.   unsigned int max_length;    /* Max width of selected set */
  88.   unsigned int flags;        /* Div flags */
  89.   unsigned int decimals;    /* Number of decimals in field */
  90. } MYSQL_FIELD;
  91.  
  92. typedef char **MYSQL_ROW;        /* return data as array of strings */
  93. typedef unsigned int MYSQL_FIELD_OFFSET; /* offset to current field */
  94.  
  95. #if defined(NO_CLIENT_LONG_LONG)
  96. typedef unsigned long my_ulonglong;
  97. #elif defined (__WIN__)
  98. typedef unsigned __int64 my_ulonglong;
  99. #else
  100. typedef unsigned long long my_ulonglong;
  101. #endif
  102.  
  103. #define MYSQL_COUNT_ERROR (~(my_ulonglong) 0)
  104.  
  105. typedef struct st_mysql_rows {
  106.   struct st_mysql_rows *next;        /* list of rows */
  107.   MYSQL_ROW data;
  108. } MYSQL_ROWS;
  109.  
  110. typedef MYSQL_ROWS *MYSQL_ROW_OFFSET;    /* offset to current row */
  111.  
  112. typedef struct st_mysql_data {
  113.   my_ulonglong rows;
  114.   unsigned int fields;
  115.   MYSQL_ROWS *data;
  116.   MEM_ROOT alloc;
  117. } MYSQL_DATA;
  118.  
  119. struct st_mysql_options {
  120.   unsigned int connect_timeout,client_flag;
  121.   my_bool compress,named_pipe;
  122.   unsigned int port;
  123.   char *host,*init_command,*user,*password,*unix_socket,*db;
  124.   char *my_cnf_file,*my_cnf_group, *charset_dir, *charset_name;
  125.   my_bool use_ssl;                /* if to use SSL or not */
  126.   char *ssl_key;                /* PEM key file */
  127.   char *ssl_cert;                /* PEM cert file */
  128.   char *ssl_ca;                    /* PEM CA file */
  129.   char *ssl_capath;                /* PEM directory of CA-s? */
  130. };
  131.  
  132. enum mysql_option { MYSQL_OPT_CONNECT_TIMEOUT, MYSQL_OPT_COMPRESS,
  133.             MYSQL_OPT_NAMED_PIPE, MYSQL_INIT_COMMAND,
  134.             MYSQL_READ_DEFAULT_FILE, MYSQL_READ_DEFAULT_GROUP,
  135.             MYSQL_SET_CHARSET_DIR, MYSQL_SET_CHARSET_NAME};
  136.  
  137. enum mysql_status { MYSQL_STATUS_READY,MYSQL_STATUS_GET_RESULT,
  138.             MYSQL_STATUS_USE_RESULT};
  139.  
  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.   unsigned int    port,client_flag,server_capabilities;
  146.   unsigned int    protocol_version;
  147.   unsigned int    field_count;
  148.   unsigned int     server_status;
  149.   unsigned long thread_id;        /* Id for connection in server */
  150.   my_ulonglong affected_rows;
  151.   my_ulonglong insert_id;        /* id if insert on table with NEXTNR */
  152.   my_ulonglong extra_info;        /* Used by mysqlshow */
  153.   unsigned long packet_length;
  154.   enum mysql_status status;
  155.   MYSQL_FIELD    *fields;
  156.   MEM_ROOT    field_alloc;
  157.   my_bool    free_me;        /* If free in mysql_close */
  158.   my_bool    reconnect;        /* set to 1 if automatic reconnect */
  159.   struct st_mysql_options options;
  160.   char            scramble_buff[9];
  161.   struct charset_info_st *charset;
  162.   unsigned int  server_language;
  163. } MYSQL;
  164.  
  165.  
  166. typedef struct st_mysql_res {
  167.   my_ulonglong row_count;
  168.   unsigned int    field_count, current_field;
  169.   MYSQL_FIELD    *fields;
  170.   MYSQL_DATA    *data;
  171.   MYSQL_ROWS    *data_cursor;
  172.   MEM_ROOT    field_alloc;
  173.   MYSQL_ROW    row;            /* If unbuffered read */
  174.   MYSQL_ROW    current_row;        /* buffer to current row */
  175.   unsigned long *lengths;        /* column lengths of current row */
  176.   MYSQL        *handle;        /* for unbuffered reads */
  177.   my_bool    eof;            /* Used my mysql_fetch_row */
  178. } MYSQL_RES;
  179.  
  180. /* Functions to get information from the MYSQL and MYSQL_RES structures */
  181. /* Should definitely be used if one uses shared libraries */
  182.  
  183. my_ulonglong STDCALL mysql_num_rows(MYSQL_RES *res);
  184. unsigned int STDCALL mysql_num_fields(MYSQL_RES *res);
  185. my_bool STDCALL mysql_eof(MYSQL_RES *res);
  186. MYSQL_FIELD *STDCALL mysql_fetch_field_direct(MYSQL_RES *res,
  187.                           unsigned int fieldnr);
  188. MYSQL_FIELD * STDCALL mysql_fetch_fields(MYSQL_RES *res);
  189. MYSQL_ROWS * STDCALL mysql_row_tell(MYSQL_RES *res);
  190. unsigned int STDCALL mysql_field_tell(MYSQL_RES *res);
  191.  
  192. unsigned int STDCALL mysql_field_count(MYSQL *mysql);
  193. my_ulonglong STDCALL mysql_affected_rows(MYSQL *mysql);
  194. my_ulonglong STDCALL mysql_insert_id(MYSQL *mysql);
  195. unsigned int STDCALL mysql_errno(MYSQL *mysql);
  196. char * STDCALL mysql_error(MYSQL *mysql);
  197. char * STDCALL mysql_info(MYSQL *mysql);
  198. unsigned long STDCALL mysql_thread_id(MYSQL *mysql);
  199. const char * STDCALL mysql_character_set_name(MYSQL *mysql);
  200.  
  201. MYSQL *        STDCALL mysql_init(MYSQL *mysql);
  202. #ifdef HAVE_OPENSSL
  203. int        STDCALL mysql_ssl_set(MYSQL *mysql, const char *key,
  204.                       const char *cert, const char *ca,
  205.                       const char *capath);
  206. char *        STDCALL mysql_ssl_cipher(MYSQL *mysql);
  207. int        STDCALL mysql_ssl_clear(MYSQL *mysql);
  208. #endif /* HAVE_OPENSSL */
  209. MYSQL *        STDCALL mysql_connect(MYSQL *mysql, const char *host,
  210.                       const char *user, const char *passwd);
  211. my_bool        STDCALL mysql_change_user(MYSQL *mysql, const char *user, 
  212.                       const char *passwd, const char *db);
  213. #if MYSQL_VERSION_ID >= 32200
  214. MYSQL *        STDCALL mysql_real_connect(MYSQL *mysql, const char *host,
  215.                        const char *user,
  216.                        const char *passwd,
  217.                        const char *db,
  218.                        unsigned int port,
  219.                        const char *unix_socket,
  220.                        unsigned int clientflag);
  221. #else
  222. MYSQL *        STDCALL mysql_real_connect(MYSQL *mysql, const char *host,
  223.                        const char *user,
  224.                        const char *passwd,
  225.                        unsigned int port,
  226.                        const char *unix_socket,
  227.                        unsigned int clientflag);
  228. #endif
  229. void        STDCALL mysql_close(MYSQL *sock);
  230. int        STDCALL mysql_select_db(MYSQL *mysql, const char *db);
  231. int        STDCALL mysql_query(MYSQL *mysql, const char *q);
  232. int        STDCALL mysql_real_query(MYSQL *mysql, const char *q,
  233.                     unsigned int length);
  234. int        STDCALL mysql_create_db(MYSQL *mysql, const char *DB);
  235. int        STDCALL mysql_drop_db(MYSQL *mysql, const char *DB);
  236. int        STDCALL mysql_shutdown(MYSQL *mysql);
  237. int        STDCALL mysql_dump_debug_info(MYSQL *mysql);
  238. int        STDCALL mysql_refresh(MYSQL *mysql,
  239.                      unsigned int refresh_options);
  240. int        STDCALL mysql_kill(MYSQL *mysql,unsigned long pid);
  241. int        STDCALL mysql_ping(MYSQL *mysql);
  242. char *        STDCALL mysql_stat(MYSQL *mysql);
  243. char *        STDCALL mysql_get_server_info(MYSQL *mysql);
  244. char *        STDCALL mysql_get_client_info(void);
  245. char *        STDCALL mysql_get_host_info(MYSQL *mysql);
  246. unsigned int    STDCALL mysql_get_proto_info(MYSQL *mysql);
  247. MYSQL_RES *    STDCALL mysql_list_dbs(MYSQL *mysql,const char *wild);
  248. MYSQL_RES *    STDCALL mysql_list_tables(MYSQL *mysql,const char *wild);
  249. MYSQL_RES *    STDCALL mysql_list_fields(MYSQL *mysql, const char *table,
  250.                      const char *wild);
  251. MYSQL_RES *    STDCALL mysql_list_processes(MYSQL *mysql);
  252. MYSQL_RES *    STDCALL mysql_store_result(MYSQL *mysql);
  253. MYSQL_RES *    STDCALL mysql_use_result(MYSQL *mysql);
  254. int        STDCALL mysql_options(MYSQL *mysql,enum mysql_option option,
  255.                       const char *arg);
  256. void        STDCALL mysql_free_result(MYSQL_RES *result);
  257. void        STDCALL mysql_data_seek(MYSQL_RES *result,
  258.                     my_ulonglong offset);
  259. MYSQL_ROW_OFFSET STDCALL mysql_row_seek(MYSQL_RES *result, MYSQL_ROW_OFFSET);
  260. MYSQL_FIELD_OFFSET STDCALL mysql_field_seek(MYSQL_RES *result,
  261.                        MYSQL_FIELD_OFFSET offset);
  262. MYSQL_ROW    STDCALL mysql_fetch_row(MYSQL_RES *result);
  263. unsigned long * STDCALL mysql_fetch_lengths(MYSQL_RES *result);
  264. MYSQL_FIELD *    STDCALL mysql_fetch_field(MYSQL_RES *result);
  265. unsigned long    STDCALL mysql_escape_string(char *to,const char *from,
  266.                         unsigned long from_length);
  267. unsigned long STDCALL mysql_real_escape_string(MYSQL *mysql,
  268.                            char *to,const char *from,
  269.                            unsigned long length);
  270. void        STDCALL mysql_debug(const char *debug);
  271. char *        STDCALL mysql_odbc_escape_string(MYSQL *mysql,
  272.                          char *to,
  273.                          unsigned long to_length,
  274.                          const char *from,
  275.                          unsigned long from_length,
  276.                          void *param,
  277.                          char *
  278.                          (*extend_buffer)
  279.                          (void *, char *to,
  280.                           unsigned long *length));
  281. void         STDCALL myodbc_remove_escape(MYSQL *mysql,char *name);
  282. unsigned int    STDCALL mysql_thread_safe(void);
  283.  
  284.   
  285. #define mysql_reload(mysql) mysql_refresh((mysql),REFRESH_GRANT)
  286.  
  287. /* new api functions */
  288.  
  289. #define HAVE_MYSQL_REAL_CONNECT
  290.  
  291. #ifndef MYSQL_SERVER  
  292. #ifdef    __cplusplus
  293. }
  294. #endif
  295. #endif
  296.  
  297. #endif
  298.