FreeTDS API: include/freetds/odbc.h Source File

FreeTDS API

odbc.h
1 /* FreeTDS - Library of routines accessing Sybase and Microsoft databases
2 * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Brian Bruns
3 * Copyright (C) 2004-2010 Frediano Ziglio
4 *
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
9 *
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
14 *
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
19 */
20
21 #ifndef _sql_h_
22 #define _sql_h_
23
24 #define TDS_DONT_DEFINE_DEFAULT_FUNCTIONS
25 #include <freetds/tds.h>
26 #include <freetds/thread.h>
27 #include <freetds/data.h>
28
29 #if defined(UNIXODBC) || defined(_WIN32) || defined(TDS_NO_DM)
30 #include <sql.h>
31 #include <sqlext.h>
32 #if defined(UNIXODBC) || defined(_WIN32)
33 #include <odbcinst.h>
34 #endif
35 #else /* IODBC */
36 #include <isql.h>
37 #include <isqlext.h>
38 #ifdef HAVE_IODBCINST_H
39 #include <iodbcinst.h>
40 #endif /* HAVE_IODBCINST_H */
41 #endif
42
43 #ifdef HAVE_WCHAR_H
44 #include <wchar.h>
45 #endif
46
47 #ifndef HAVE_SQLLEN
48 #ifndef SQLULEN
49 #define SQLULEN SQLUINTEGER
50 #endif
51 #ifndef SQLLEN
52 #define SQLLEN SQLINTEGER
53 #endif
54 #endif
55
56 #ifndef HAVE_SQLSETPOSIROW
57 #define SQLSETPOSIROW SQLUSMALLINT
58 #endif
59
60 #ifndef HAVE_SQLROWOFFSET
61 #define SQLROWOFFSET SQLLEN
62 #endif
63
64 #ifndef HAVE_SQLROWSETSIZE
65 #define SQLROWSETSIZE SQLULEN
66 #endif
67
68 #ifdef __cplusplus
69 extern "C"
70 {
71 #if 0
72 }
73 #endif
74 #endif
75
76 #include <freetds/pushvis.h>
77 #if defined(__GNUC__) && __GNUC__ >= 4 && !defined(__MINGW32__)
78 #define ODBC_API SQL_API __attribute__((externally_visible))
79 #else
80 #define ODBC_API SQL_API
81 #endif
82
83 #if (defined(_WIN32) || defined(__CYGWIN__)) && defined(__GNUC__)
84 # define ODBC_PUBLIC __attribute__((dllexport))
85 #else
86 # define ODBC_PUBLIC
87 #endif
88
89 #define ODBC_MAX(a,b) ( (a) > (b) ? (a) : (b) )
90 #define ODBC_MIN(a,b) ( (a) < (b) ? (a) : (b) )
91
92 struct _sql_error
93 {
94 const char *msg;
95 char state2[6];
96 char state3[6];
97 TDS_UINT native;
98 char *server;
99 int linenum;
100 int msgstate;
101 int row;
102 };
103
104 struct _sql_errors
105 {
106 struct _sql_error *errs;
107 int num_errors;
108 SQLRETURN lastrc;
109 char ranked;
110 };
111
112 typedef struct _sql_errors TDS_ERRS;
113
114 #if ENABLE_EXTRA_CHECKS
115 void odbc_check_struct_extra(void *p);
116 #else
117 static inline void odbc_check_struct_extra(void *p) {}
118 #endif
119
120 #define ODBC_RETURN(handle, rc) \
121 do { odbc_check_struct_extra(handle); \
122 return handle->errs.lastrc = (rc); } while(0)
123 #define ODBC_RETURN_(handle) \
124 do { odbc_check_struct_extra(handle); \
125 return handle->errs.lastrc; } while(0)
126
127 #define ODBC_EXIT(handle, rc) \
128 do { SQLRETURN _odbc_rc = handle->errs.lastrc = (rc); \
129 odbc_check_struct_extra(handle); \
130 tds_mutex_unlock(&handle->mtx); \
131 return _odbc_rc; } while(0)
132 #define ODBC_EXIT_(handle) \
133 do { SQLRETURN _odbc_rc = handle->errs.lastrc; \
134 odbc_check_struct_extra(handle); \
135 tds_mutex_unlock(&handle->mtx); \
136 return _odbc_rc; } while(0)
137
138
140 void odbc_errs_reset(struct _sql_errors *errs);
141
143 void odbc_errs_add(struct _sql_errors *errs, const char *sqlstate, const char *msg);
144
146 void odbc_errs_add_rdbms(struct _sql_errors *errs, TDS_UINT native, const char *sqlstate, const char *msg, int linenum,
147 int msgstate, const char *server, int row);
148
149 struct _dheader
150 {
151 SQLSMALLINT sql_desc_alloc_type;
152 SQLINTEGER sql_desc_bind_type;
153 SQLULEN sql_desc_array_size;
154 /* TODO SQLLEN ?? see http://support.microsoft.com/default.aspx?scid=kb;en-us;298678 */
155 SQLSMALLINT sql_desc_count;
156 SQLUSMALLINT *sql_desc_array_status_ptr;
157 SQLULEN *sql_desc_rows_processed_ptr;
158 SQLLEN *sql_desc_bind_offset_ptr;
159 };
160
161 struct _drecord
162 {
163 SQLUINTEGER sql_desc_auto_unique_value;
164 DSTR sql_desc_base_column_name;
165 DSTR sql_desc_base_table_name;
166 SQLINTEGER sql_desc_case_sensitive;
167 DSTR sql_desc_catalog_name;
168 SQLSMALLINT sql_desc_concise_type;
169 SQLPOINTER sql_desc_data_ptr;
170 SQLSMALLINT sql_desc_datetime_interval_code;
171 SQLINTEGER sql_desc_datetime_interval_precision;
172 SQLLEN sql_desc_display_size;
173 SQLSMALLINT sql_desc_fixed_prec_scale;
174 SQLLEN *sql_desc_indicator_ptr;
175 DSTR sql_desc_label;
176 SQLULEN sql_desc_length;
177 /* this point to a constant buffer, do not free or modify */
178 const char *sql_desc_literal_prefix;
179 /* this point to a constant buffer, do not free or modify */
180 const char *sql_desc_literal_suffix;
181 DSTR sql_desc_local_type_name;
182 DSTR sql_desc_name;
183 SQLSMALLINT sql_desc_nullable;
184 SQLINTEGER sql_desc_num_prec_radix;
185 SQLLEN sql_desc_octet_length;
186 SQLLEN *sql_desc_octet_length_ptr;
187 SQLSMALLINT sql_desc_parameter_type;
188 SQLSMALLINT sql_desc_precision;
189 SQLSMALLINT sql_desc_rowver;
190 SQLSMALLINT sql_desc_scale;
191 DSTR sql_desc_schema_name;
192 SQLSMALLINT sql_desc_searchable;
193 DSTR sql_desc_table_name;
194 SQLSMALLINT sql_desc_type;
195 /* this point to a constant buffer, do not free or modify */
196 const char *sql_desc_type_name;
197 SQLSMALLINT sql_desc_unnamed;
198 SQLSMALLINT sql_desc_unsigned;
199 SQLSMALLINT sql_desc_updatable;
200 };
201
202 struct _hdesc
203 {
204 SQLSMALLINT htype; /* do not reorder this field */
205 struct _sql_errors errs; /* do not reorder this field */
206 tds_mutex mtx;
207 int type;
208 SQLHANDLE parent;
209 struct _dheader header;
210 struct _drecord *records;
211 };
212
213 typedef struct _hdesc TDS_DESC;
214
215 #define DESC_IRD 1
216 #define DESC_IPD 2
217 #define DESC_ARD 3
218 #define DESC_APD 4
219
220 struct _heattr
221 {
222 SQLUINTEGER connection_pooling;
223 SQLUINTEGER cp_match;
224 SQLINTEGER odbc_version;
225 SQLINTEGER output_nts;
226 };
227
228 struct _hchk
229 {
230 SQLSMALLINT htype; /* do not reorder this field */
231 struct _sql_errors errs; /* do not reorder this field */
232 tds_mutex mtx;
233 };
234
235 struct _henv
236 {
237 SQLSMALLINT htype; /* do not reorder this field */
238 struct _sql_errors errs; /* do not reorder this field */
239 tds_mutex mtx;
240 TDSCONTEXT *tds_ctx;
241 struct _heattr attr;
242 };
243
244 struct _hcattr
245 {
246 SQLUINTEGER access_mode;
247 SQLUINTEGER async_enable;
248 SQLUINTEGER auto_ipd;
249 SQLUINTEGER autocommit;
250 SQLUINTEGER connection_dead;
251 SQLUINTEGER connection_timeout;
252 DSTR current_catalog;
253 SQLUINTEGER login_timeout;
254 SQLUINTEGER metadata_id;
255 SQLUINTEGER odbc_cursors;
256 SQLUINTEGER packet_size;
257 SQLHWND quite_mode;
258 DSTR translate_lib;
259 SQLUINTEGER translate_option;
260 SQLUINTEGER txn_isolation;
261 SQLUINTEGER mars_enabled;
262 SQLUINTEGER cursor_type;
263 SQLUINTEGER bulk_enabled;
264 #ifdef TDS_NO_DM
265 SQLUINTEGER trace;
266 DSTR tracefile;
267 #endif
268 };
269
270 #define TDS_MAX_APP_DESC 100
271
272 struct _hstmt;
273 struct _hdbc
274 {
275 SQLSMALLINT htype; /* do not reorder this field */
276 struct _sql_errors errs; /* do not reorder this field */
277 tds_mutex mtx;
278 struct _henv *env;
279 TDSSOCKET *tds_socket;
280 DSTR dsn;
281 DSTR oldpwd;
282 #ifdef ENABLE_ODBC_WIDE
283 DSTR original_charset;
284 TDSICONV *mb_conv;
285 #endif
286
292 struct _hstmt *current_statement;
294 struct _hstmt *stmt_list;
295 struct _hcattr attr;
297 TDS_DESC *uad[TDS_MAX_APP_DESC];
299 unsigned int cursor_support:1;
300 unsigned int use_oldpwd:1;
301 TDS_INT default_query_timeout;
302
303 TDSBCPINFO *bcpinfo;
304 char *bcphint;
305 };
306
307 struct _hsattr
308 {
309 /* TODO remove IRD, ARD, IPD, APD from statement, do not duplicate */
310 /* TDS_DESC *app_row_desc; */
311 /* TDS_DESC *app_param_desc; */
312 SQLUINTEGER async_enable;
313 SQLUINTEGER concurrency;
314 SQLUINTEGER cursor_scrollable;
315 SQLUINTEGER cursor_sensitivity;
316 SQLUINTEGER cursor_type;
317 SQLUINTEGER enable_auto_ipd;
318 SQLPOINTER fetch_bookmark_ptr;
319 SQLULEN keyset_size;
320 SQLULEN max_length;
321 SQLULEN max_rows;
322 SQLUINTEGER metadata_id;
323 SQLUINTEGER noscan;
324 /* apd->sql_desc_bind_offset_ptr */
325 /* SQLUINTEGER *param_bind_offset_ptr; */
326 /* apd->sql_desc_bind_type */
327 /* SQLUINTEGER param_bind_type; */
328 /* apd->sql_desc_array_status_ptr */
329 /* SQLUSMALLINT *param_operation_ptr; */
330 /* ipd->sql_desc_array_status_ptr */
331 /* SQLUSMALLINT *param_status_ptr; */
332 /* ipd->sql_desc_rows_processed_ptr */
333 /* SQLUSMALLINT *params_processed_ptr; */
334 /* apd->sql_desc_array_size */
335 /* SQLUINTEGER paramset_size; */
336 SQLUINTEGER query_timeout;
337 SQLUINTEGER retrieve_data;
338 /* ard->sql_desc_bind_offset_ptr */
339 /* SQLUINTEGER *row_bind_offset_ptr; */
340 /* ard->sql_desc_array_size */
341 /* SQLUINTEGER row_array_size; */
342 /* ard->sql_desc_bind_type */
343 /* SQLUINTEGER row_bind_type; */
344 SQLULEN row_number;
345 /* ard->sql_desc_array_status_ptr */
346 /* SQLUINTEGER *row_operation_ptr; */
347 /* ird->sql_desc_array_status_ptr */
348 /* SQLUINTEGER *row_status_ptr; */
349 /* ird->sql_desc_rows_processed_ptr */
350 /* SQLUINTEGER *rows_fetched_ptr; */
351 SQLUINTEGER simulate_cursor;
352 SQLUINTEGER use_bookmarks;
353 /* SQLGetStmtAttr only */
354 /* TDS_DESC *imp_row_desc; */
355 /* TDS_DESC *imp_param_desc; */
356 DSTR qn_msgtext;
357 DSTR qn_options;
358 SQLUINTEGER qn_timeout;
359 };
360
361 typedef enum
362 {
363 NOT_IN_ROW,
364 IN_NORMAL_ROW,
365 IN_COMPUTE_ROW,
366 AFTER_COMPUTE_ROW,
367 PRE_NORMAL_ROW
368 } TDS_ODBC_ROW_STATUS;
369
370 typedef enum
371 {
372 ODBC_SPECIAL_NONE = 0,
373 ODBC_SPECIAL_GETTYPEINFO = 1,
374 ODBC_SPECIAL_COLUMNS = 2,
375 ODBC_SPECIAL_PROCEDURECOLUMNS = 3,
376 ODBC_SPECIAL_SPECIALCOLUMNS = 4
377 } TDS_ODBC_SPECIAL_ROWS;
378
379 struct _hstmt
380 {
381 SQLSMALLINT htype; /* do not reorder this field */
382 struct _sql_errors errs; /* do not reorder this field */
383 tds_mutex mtx;
384 struct _hdbc *dbc;
386 DSTR query;
388 TDSSOCKET *tds;
389
391 struct _hstmt *next;
393 struct _hstmt *prev;
394
395 /* begin prepared query stuff */
396 unsigned is_prepared_query:1;
397 unsigned prepared_query_is_func:1;
398 unsigned prepared_query_is_rpc:1;
403 unsigned need_reprepare:1;
404 unsigned param_data_called:1;
405 /* end prepared query stuff */
406
408 TDSPARAMINFO *params;
410 int param_num;
412 char *prepared_pos;
413
414 unsigned int curr_param_row, num_param_rows;
415
417 unsigned int param_count;
418 int row;
420 TDS_INT8 row_count;
422 TDS_ODBC_ROW_STATUS row_status;
423 /* do NOT free dynamic, free from socket or attach to connection */
424 TDSDYNAMIC *dyn;
425 TDS_DESC *ard, *ird, *apd, *ipd;
426 TDS_DESC *orig_ard, *orig_apd;
427 SQLULEN sql_rowset_size;
428 struct _hsattr attr;
429 DSTR cursor_name; /* auto generated cursor name */
430 TDS_ODBC_SPECIAL_ROWS special_row;
431 /* do NOT free cursor, free from socket or attach to connection */
432 TDSCURSOR *cursor;
433 };
434
435 typedef struct _henv TDS_ENV;
436 typedef struct _hdbc TDS_DBC;
437 typedef struct _hstmt TDS_STMT;
438 typedef struct _hchk TDS_CHK;
439
440 typedef struct {
441 /* this must be the first member */
442 TDSCOLUMNFUNCS common;
443 void (*set_type_info)(TDSCOLUMN *col, struct _drecord *drec, SQLINTEGER odbc_ver);
444 } TDS_FUNCS;
445
446 #define IS_HENV(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_ENV)
447 #define IS_HDBC(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_DBC)
448 #define IS_HSTMT(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_STMT)
449 #define IS_HDESC(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_DESC)
450
451 /* fix a bug in MingW headers */
452 #ifdef __MINGW32__
453 #if SQL_INTERVAL_YEAR == (100 + SQL_CODE_SECOND)
454
455 #undef SQL_INTERVAL_YEAR
456 #undef SQL_INTERVAL_MONTH
457 #undef SQL_INTERVAL_DAY
458 #undef SQL_INTERVAL_HOUR
459 #undef SQL_INTERVAL_MINUTE
460 #undef SQL_INTERVAL_SECOND
461 #undef SQL_INTERVAL_YEAR_TO_MONTH
462 #undef SQL_INTERVAL_DAY_TO_HOUR
463 #undef SQL_INTERVAL_DAY_TO_MINUTE
464 #undef SQL_INTERVAL_DAY_TO_SECOND
465 #undef SQL_INTERVAL_HOUR_TO_MINUTE
466 #undef SQL_INTERVAL_HOUR_TO_SECOND
467 #undef SQL_INTERVAL_MINUTE_TO_SECOND
468
469 #define SQL_INTERVAL_YEAR (100 + SQL_CODE_YEAR)
470 #define SQL_INTERVAL_MONTH (100 + SQL_CODE_MONTH)
471 #define SQL_INTERVAL_DAY (100 + SQL_CODE_DAY)
472 #define SQL_INTERVAL_HOUR (100 + SQL_CODE_HOUR)
473 #define SQL_INTERVAL_MINUTE (100 + SQL_CODE_MINUTE)
474 #define SQL_INTERVAL_SECOND (100 + SQL_CODE_SECOND)
475 #define SQL_INTERVAL_YEAR_TO_MONTH (100 + SQL_CODE_YEAR_TO_MONTH)
476 #define SQL_INTERVAL_DAY_TO_HOUR (100 + SQL_CODE_DAY_TO_HOUR)
477 #define SQL_INTERVAL_DAY_TO_MINUTE (100 + SQL_CODE_DAY_TO_MINUTE)
478 #define SQL_INTERVAL_DAY_TO_SECOND (100 + SQL_CODE_DAY_TO_SECOND)
479 #define SQL_INTERVAL_HOUR_TO_MINUTE (100 + SQL_CODE_HOUR_TO_MINUTE)
480 #define SQL_INTERVAL_HOUR_TO_SECOND (100 + SQL_CODE_HOUR_TO_SECOND)
481 #define SQL_INTERVAL_MINUTE_TO_SECOND (100 + SQL_CODE_MINUTE_TO_SECOND)
482
483 #endif
484 #endif
485
486 #ifdef _WIN32
487 bool get_login_info(HWND hwndParent, TDSLOGIN * login);
488 #endif
489
490 #define ODBC_PARAM_LIST \
491 ODBC_PARAM(Servername) \
492 ODBC_PARAM(Server) \
493 ODBC_PARAM(DSN) \
494 ODBC_PARAM(UID) \
495 ODBC_PARAM(PWD) \
496 ODBC_PARAM(Address) \
497 ODBC_PARAM(Port) \
498 ODBC_PARAM(TDS_Version) \
499 ODBC_PARAM(Language) \
500 ODBC_PARAM(Database) \
501 ODBC_PARAM(TextSize) \
502 ODBC_PARAM(PacketSize) \
503 ODBC_PARAM(ClientCharset) \
504 ODBC_PARAM(DumpFile) \
505 ODBC_PARAM(DumpFileAppend) \
506 ODBC_PARAM(DebugFlags) \
507 ODBC_PARAM(Encryption) \
508 ODBC_PARAM(Trusted_Connection) \
509 ODBC_PARAM(APP) \
510 ODBC_PARAM(WSID) \
511 ODBC_PARAM(UseNTLMv2) \
512 ODBC_PARAM(MARS_Connection) \
513 ODBC_PARAM(REALM) \
514 ODBC_PARAM(ServerSPN) \
515 ODBC_PARAM(AttachDbFilename) \
516 ODBC_PARAM(ApplicationIntent)
517
518 #define ODBC_PARAM(p) ODBC_PARAM_##p,
519 enum {
520 ODBC_PARAM_LIST
521 ODBC_PARAM_SIZE
522 };
523 #undef ODBC_PARAM
524
525
526 /*
527 * connectparams.h
528 */
529
530 typedef struct {
531 const char *p;
532 size_t len;
533 } TDS_PARSED_PARAM;
534
542 int odbc_parse_connect_string(TDS_ERRS *errs, const char *connect_string, const char *connect_string_end, TDSLOGIN * login, TDS_PARSED_PARAM *parsed_params);
543 int odbc_get_dsn_info(TDS_ERRS *errs, const char *DSN, TDSLOGIN * login);
544 #ifdef _WIN32
545 int odbc_build_connect_string(TDS_ERRS *errs, TDS_PARSED_PARAM *params, char **out);
546 #endif
547
548 /*
549 * convert_tds2sql.c
550 */
551 SQLLEN odbc_tds2sql_col(TDS_STMT * stmt, TDSCOLUMN *curcol, int desttype, TDS_CHAR * dest, SQLULEN destlen, const struct _drecord *drec_ixd);
552 SQLLEN odbc_tds2sql_int4(TDS_STMT * stmt, TDS_INT *src, int desttype, TDS_CHAR * dest, SQLULEN destlen);
553
554
555
556 /*
557 * descriptor.c
558 */
559 TDS_DESC *desc_alloc(SQLHANDLE parent, int desc_type, int alloc_type);
560 SQLRETURN desc_free(TDS_DESC * desc);
561 SQLRETURN desc_alloc_records(TDS_DESC * desc, unsigned count);
562 SQLRETURN desc_copy(TDS_DESC * dest, TDS_DESC * src);
563 SQLRETURN desc_free_records(TDS_DESC * desc);
564 TDS_DBC *desc_get_dbc(TDS_DESC *desc);
565
566 /*
567 * odbc.c
568 */
569 SQLRETURN _SQLRowCount(SQLHSTMT hstmt, SQLLEN FAR * pcrow);
570
571 /*
572 * odbc_checks.h
573 */
574 #if ENABLE_EXTRA_CHECKS
575 /* macro */
576 #define CHECK_ENV_EXTRA(env) odbc_check_env_extra(env)
577 #define CHECK_DBC_EXTRA(dbc) odbc_check_dbc_extra(dbc)
578 #define CHECK_STMT_EXTRA(stmt) odbc_check_stmt_extra(stmt)
579 #define CHECK_DESC_EXTRA(desc) odbc_check_desc_extra(desc)
580 /* declarations*/
581 void odbc_check_env_extra(TDS_ENV * env);
582 void odbc_check_dbc_extra(TDS_DBC * dbc);
583 void odbc_check_stmt_extra(TDS_STMT * stmt);
584 void odbc_check_desc_extra(TDS_DESC * desc);
585 #else
586 /* macro */
587 #define CHECK_ENV_EXTRA(env)
588 #define CHECK_DBC_EXTRA(dbc)
589 #define CHECK_STMT_EXTRA(stmt)
590 #define CHECK_DESC_EXTRA(desc)
591 #endif
592
593 /*
594 * odbc_util.h
595 */
596
597 /* helpers for ODBC wide string support */
598 #undef _wide
599 #undef _WIDE
600 #ifdef ENABLE_ODBC_WIDE
601 typedef union {
602 char mb[1];
603 SQLWCHAR wide[1];
604 } ODBC_CHAR;
605 # define _wide ,wide
606 # define _wide0 ,0
607 # define _WIDE ,int wide
608 #else
609 # define _wide
610 # define _wide0
611 # define _WIDE
612 # define ODBC_CHAR SQLCHAR
613 #endif
614 int odbc_set_stmt_query(struct _hstmt *stmt, const ODBC_CHAR *sql, int sql_len _WIDE);
615 void odbc_set_return_status(struct _hstmt *stmt, unsigned int n_row);
616 void odbc_set_return_params(struct _hstmt *stmt, unsigned int n_row);
617
618 void odbc_set_sql_type_info(TDSCOLUMN * col, struct _drecord *drec, SQLINTEGER odbc_ver);
619
620 int odbc_sql_to_c_type_default(int sql_type);
621 TDS_SERVER_TYPE odbc_sql_to_server_type(TDSCONNECTION * conn, int sql_type, int sql_unsigned);
622 TDS_SERVER_TYPE odbc_c_to_server_type(int c_type);
623
624 unsigned int odbc_get_string_size(int size, const ODBC_CHAR * str _WIDE);
625 void odbc_rdbms_version(TDSSOCKET * tds_socket, char *pversion_string);
626 SQLINTEGER odbc_get_param_len(const struct _drecord *drec_axd, const struct _drecord *drec_ixd, const TDS_DESC* axd, unsigned int n_row);
627
628 #ifdef ENABLE_ODBC_WIDE
629 DSTR* odbc_dstr_copy_flag(TDS_DBC *dbc, DSTR *s, int size, const ODBC_CHAR * str, int flag);
630 #define odbc_dstr_copy(dbc, s, len, out) \
631 odbc_dstr_copy_flag(dbc, s, len, sizeof((out)->mb) ? (out) : (out), wide)
632 #define odbc_dstr_copy_oct(dbc, s, len, out) \
633 odbc_dstr_copy_flag(dbc, s, len, out, wide|0x20)
634 #else
635 DSTR* odbc_dstr_copy(TDS_DBC *dbc, DSTR *s, int size, const ODBC_CHAR * str);
636 #define odbc_dstr_copy_oct odbc_dstr_copy
637 #endif
638
639
640 SQLRETURN odbc_set_string_flag(TDS_DBC *dbc, SQLPOINTER buffer, SQLINTEGER cbBuffer, void FAR * pcbBuffer, const char *s, int len, int flag);
641 #ifdef ENABLE_ODBC_WIDE
642 #define odbc_set_string(dbc, buf, buf_len, out_len, s, s_len) \
643 odbc_set_string_flag(dbc, sizeof((buf)->mb) ? (buf) : (buf), buf_len, out_len, s, s_len, (wide) | (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0:0x10))
644 #define odbc_set_string_oct(dbc, buf, buf_len, out_len, s, s_len) \
645 odbc_set_string_flag(dbc, buf, buf_len, out_len, s, s_len, (wide) | (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0x20:0x30))
646 #else
647 #define odbc_set_string(dbc, buf, buf_len, out_len, s, s_len) \
648 odbc_set_string_flag(dbc, buf, buf_len, out_len, s, s_len, (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0:0x10))
649 #define odbc_set_string_oct(dbc, buf, buf_len, out_len, s, s_len) \
650 odbc_set_string_flag(dbc, buf, buf_len, out_len, s, s_len, (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0x20:0x30))
651 #endif
652
653 #define odbc_set_dstr_oct(dbc, buf, buf_len, out_len, s) odbc_set_string_oct(dbc, buf, buf_len, out_len, tds_dstr_cstr(s), tds_dstr_len(s))
654 #define odbc_set_dstr(dbc, buf, buf_len, out_len, s) odbc_set_string(dbc, buf, buf_len, out_len, tds_dstr_cstr(s), tds_dstr_len(s))
655
656 SQLSMALLINT odbc_get_concise_sql_type(SQLSMALLINT type, SQLSMALLINT interval);
657 SQLRETURN odbc_set_concise_sql_type(SQLSMALLINT concise_type, struct _drecord *drec, int check_only);
658 SQLSMALLINT odbc_get_concise_c_type(SQLSMALLINT type, SQLSMALLINT interval);
659 SQLRETURN odbc_set_concise_c_type(SQLSMALLINT concise_type, struct _drecord *drec, int check_only);
660
661 SQLLEN odbc_get_octet_len(int c_type, const struct _drecord *drec);
662 void odbc_convert_err_set(struct _sql_errors *errs, TDS_INT err);
663
664 /*
665 * prepare_query.c
666 */
667 SQLRETURN prepare_call(struct _hstmt *stmt);
668 SQLRETURN native_sql(struct _hdbc *dbc, DSTR *s);
669 int parse_prepared_query(struct _hstmt *stmt, bool compute_row);
670 int start_parse_prepared_query(struct _hstmt *stmt, bool compute_row);
671 int continue_parse_prepared_query(struct _hstmt *stmt, SQLPOINTER DataPtr, SQLLEN StrLen_or_Ind);
672 const char *parse_const_param(const char * s, TDS_SERVER_TYPE *type);
673 const char *odbc_skip_rpc_name(const char *s);
674
675 /*
676 * sql2tds.c
677 */
678 SQLRETURN odbc_sql2tds(TDS_STMT * stmt, const struct _drecord *drec_ixd, const struct _drecord *drec_axd, TDSCOLUMN *curcol, bool compute_row, const TDS_DESC* axd, unsigned int n_row);
679 TDS_INT convert_datetime2server(int bindtype, const void *src, TDS_DATETIMEALL * dta);
680
681 /*
682 * bcp.c
683 */
684 void odbc_bcp_free_storage(TDS_DBC *dbc);
685 void odbc_bcp_init(TDS_DBC *dbc, const ODBC_CHAR *tblname, const ODBC_CHAR *hfile, const ODBC_CHAR *errfile, int direction _WIDE);
686 void odbc_bcp_control(TDS_DBC *dbc, int field, void *value);
687 void odbc_bcp_colptr(TDS_DBC *dbc, const void * colptr, int table_column);
688 void odbc_bcp_sendrow(TDS_DBC *dbc);
689 int odbc_bcp_batch(TDS_DBC *dbc);
690 int odbc_bcp_done(TDS_DBC *dbc);
691 void odbc_bcp_bind(TDS_DBC *dbc, const void * varaddr, int prefixlen, int varlen, const void * terminator, int termlen, int vartype, int table_column);
692
693 /*
694 * sqlwchar.c
695 */
696 #if SIZEOF_SQLWCHAR != SIZEOF_WCHAR_T
697 size_t sqlwcslen(const SQLWCHAR * s);
698
699 typedef struct sqlwstr_buf {
700 struct sqlwstr_buf *next;
701 wchar_t buf[256];
702 } SQLWSTRBUF;
703 const wchar_t *sqlwstr(const SQLWCHAR * s, SQLWSTRBUF **bufs);
704 void sqlwstr_free(SQLWSTRBUF *bufs);
705 #define SQLWSTR_BUFS(n) SQLWSTRBUF *bufs = NULL
706 #define SQLWSTR(s) sqlwstr(s, &bufs)
707 #define SQLWSTR_FREE() sqlwstr_free(bufs)
708 #else
709 #define sqlwcslen(s) wcslen(s)
710
711 #define SQLWSTR_BUFS(n) do {} while(0)
712 #define SQLWSTR(s) ((const wchar_t*)(s))
713 #define SQLWSTR_FREE() do {} while(0)
714 #endif
715
716 #if SIZEOF_SQLWCHAR == 2
717 # if WORDS_BIGENDIAN
718 # define ODBC_WIDE_NAME "UCS-2BE"
719 # define ODBC_WIDE_NAME_UTF "UTF-16BE"
720 # else
721 # define ODBC_WIDE_NAME "UCS-2LE"
722 # define ODBC_WIDE_NAME_UTF "UTF-16LE"
723 # endif
724 const char *odbc_get_wide_name(TDSCONNECTION *conn);
725 #elif SIZEOF_SQLWCHAR == 4
726 # if WORDS_BIGENDIAN
727 # define ODBC_WIDE_NAME "UCS-4BE"
728 # else
729 # define ODBC_WIDE_NAME "UCS-4LE"
730 # endif
731 static inline const char *
732 odbc_get_wide_name(TDSCONNECTION *conn)
733 {
734 return ODBC_WIDE_NAME;
735 }
736 #else
737 #error SIZEOF_SQLWCHAR not supported !!
738 #endif
739
740 #include <freetds/popvis.h>
741
742 #ifdef __cplusplus
743 #if 0
744 {
745 #endif
746 }
747 #endif
748
749 #endif
odbc_rdbms_version
void odbc_rdbms_version(TDSSOCKET *tds_socket, char *pversion_string)
Returns the version of the RDBMS in the ODBC format.
Definition: odbc_util.c:847
_hsattr
Definition: odbc.h:307
tds_socket
Information for a server connection.
Definition: tds.h:1141
_hdbc::current_statement
struct _hstmt * current_statement
Statement executing.
Definition: odbc.h:292
_hstmt::params
TDSPARAMINFO * params
parameters saved
Definition: odbc.h:408
_hstmt::prepared_pos
char * prepared_pos
position in prepared query to check parameters, used only in RPC
Definition: odbc.h:412
_hstmt::query
DSTR query
query to execute
Definition: odbc.h:386
TDS_FUNCS
Definition: odbc.h:440
tds_login
Definition: tds.h:511
_sql_error
Definition: odbc.h:92
tds_dstr
Structure to hold a string.
Definition: string.h:36
tds_column
Metadata about columns in regular and compute rows.
Definition: tds.h:690
_hdbc::stmt_list
struct _hstmt * stmt_list
list of all statements allocated from this connection
Definition: odbc.h:294
odbc_set_concise_sql_type
SQLRETURN odbc_set_concise_sql_type(SQLSMALLINT concise_type, struct _drecord *drec, int check_only)
Set concise type and all cascading field.
Definition: odbc_util.c:971
_heattr
Definition: odbc.h:220
_dheader
Definition: odbc.h:149
tds_result_info
Hold information for any results.
Definition: tds.h:769
_hstmt::tds
TDSSOCKET * tds
socket (only if active)
Definition: odbc.h:388
odbc_get_param_len
SQLINTEGER odbc_get_param_len(const struct _drecord *drec_axd, const struct _drecord *drec_ixd, const TDS_DESC *axd, unsigned int n_row)
Return length of parameter from parameter information.
Definition: odbc_util.c:856
tds_context
Definition: tds.h:1029
_henv
Definition: odbc.h:235
_hstmt::need_reprepare
unsigned need_reprepare
Prepared statement needs to be prepared again.
Definition: odbc.h:403
_hstmt
Definition: odbc.h:379
tds_bcpinfo
Definition: tds.h:1563
odbc_set_string_flag
SQLRETURN odbc_set_string_flag(TDS_DBC *dbc, SQLPOINTER buffer, SQLINTEGER cbBuffer, void FAR *pcbBuffer, const char *s, int len, int flag)
Copy a string to client setting size according to ODBC convenction.
Definition: odbc_util.c:279
tdsiconvinfo
Definition: iconv.h:91
tds_column_funcs
Definition: tds.h:638
TDS_PARSED_PARAM
Definition: odbc.h:530
odbc_set_concise_c_type
SQLRETURN odbc_set_concise_c_type(SQLSMALLINT concise_type, struct _drecord *drec, int check_only)
Set concise type and all cascading field.
Definition: odbc_util.c:1093
_hstmt::row_count
TDS_INT8 row_count
row count to return
Definition: odbc.h:420
_hdesc
Definition: odbc.h:202
_hstmt::next
struct _hstmt * next
next in list
Definition: odbc.h:391
_sql_errors
Definition: odbc.h:104
_hstmt::param_count
unsigned int param_count
number of parameter in current query
Definition: odbc.h:417
_hstmt::prev
struct _hstmt * prev
previous in list
Definition: odbc.h:393
_hdbc
Definition: odbc.h:273
odbc_c_to_server_type
TDS_SERVER_TYPE odbc_c_to_server_type(int c_type)
Pass this an SQL_C_* type and get a SYB* type which most closely corresponds to the SQL_C_* type...
Definition: odbc_util.c:596
_hchk
Definition: odbc.h:228
tds_cursor
Holds informations about a cursor.
Definition: tds.h:937
_hstmt::param_num
int param_num
last valid parameter in params, it&#39;s a ODBC index (from 1 relative to descriptor) ...
Definition: odbc.h:410
_drecord
Definition: odbc.h:161
_hstmt::row_status
TDS_ODBC_ROW_STATUS row_status
status of row, it can happen that this flag mark that we are still parsing row, this it&#39;s normal ...
Definition: odbc.h:422
tds.h
Main include file for libtds.
tds_connection
Definition: tds.h:1069
TDS_DATETIMEALL
this structure is not directed connected to a TDS protocol but keeps any DATE/TIME information...
Definition: tds.h:144
_hcattr
Definition: odbc.h:244
tds_dynamic
Holds information for a dynamic (also called prepared) query.
Definition: tds.h:977