FreeTDS API
Loading...
Searching...
No Matches
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 _tdsguard_gQHaPEvp2dAAa45TAutROb_
22#define _tdsguard_gQHaPEvp2dAAa45TAutROb_
23
24#define TDS_DONT_DEFINE_DEFAULT_FUNCTIONS
25#include <freetds/tds.h>
26#include <freetds/thread.h>
27#include <freetds/tds/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
69extern "C"
70{
71#if 0
72}
73#endif
74#endif
75
76#include <freetds/pushvis.h>
77#ifdef __clang__
78#define ODBC_API SQL_API __attribute__((visibility("default")))
79#elif defined(__GNUC__) && __GNUC__ >= 4 && !defined(__MINGW32__)
80#define ODBC_API SQL_API __attribute__((externally_visible))
81#else
82#define ODBC_API SQL_API
83#endif
84
85#if (defined(_WIN32) || defined(__CYGWIN__)) && defined(__GNUC__)
86# define ODBC_PUBLIC __attribute__((dllexport))
87#else
88# define ODBC_PUBLIC
89#endif
90
92{
93 const char *msg;
94 char state2[6];
95 char state3[6];
96 TDS_UINT native;
97 char *server;
98 int linenum;
99 int msgstate;
100 int row;
101 bool msg_is_static;
102};
103
105{
106 struct _sql_error *errs;
107 int num_errors;
108 SQLRETURN lastrc;
109 char ranked;
110};
111
112typedef struct _sql_errors TDS_ERRS;
113
114#if ENABLE_EXTRA_CHECKS
115void odbc_check_struct_extra(void *p);
116#else
117static inline void odbc_check_struct_extra(void *p TDS_UNUSED) {}
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
140void odbc_errs_reset(struct _sql_errors *errs);
141
143void odbc_errs_add(struct _sql_errors *errs, const char *sqlstate, const char *msg);
144
146void 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
151{
152 SQLSMALLINT sql_desc_alloc_type;
153 /* TODO SQLLEN ?? see http://support.microsoft.com/default.aspx?scid=kb;en-us;298678 */
154 SQLSMALLINT sql_desc_count;
155 SQLINTEGER sql_desc_bind_type;
156 SQLULEN sql_desc_array_size;
157 SQLUSMALLINT *sql_desc_array_status_ptr;
158 SQLULEN *sql_desc_rows_processed_ptr;
159 const SQLLEN *sql_desc_bind_offset_ptr;
160};
161
164{
165 DSTR sql_desc_base_column_name;
166 DSTR sql_desc_base_table_name;
167 SQLUINTEGER sql_desc_auto_unique_value;
168 SQLINTEGER sql_desc_case_sensitive;
169 DSTR sql_desc_catalog_name;
170 SQLPOINTER sql_desc_data_ptr;
171 SQLSMALLINT sql_desc_concise_type;
172 SQLSMALLINT sql_desc_datetime_interval_code;
173 SQLINTEGER sql_desc_datetime_interval_precision;
174 SQLLEN sql_desc_display_size;
175 SQLLEN *sql_desc_indicator_ptr;
176 DSTR sql_desc_label;
177 SQLULEN sql_desc_length;
178 /* this point to a constant buffer, do not free or modify */
179 const char *sql_desc_literal_prefix;
180 /* this point to a constant buffer, do not free or modify */
181 const char *sql_desc_literal_suffix;
182 DSTR sql_desc_local_type_name;
183 DSTR sql_desc_name;
184 SQLSMALLINT sql_desc_fixed_prec_scale;
185 SQLSMALLINT sql_desc_nullable;
186 SQLINTEGER sql_desc_num_prec_radix;
187 SQLLEN sql_desc_octet_length;
188 SQLLEN *sql_desc_octet_length_ptr;
189 SQLSMALLINT sql_desc_parameter_type;
190 SQLSMALLINT sql_desc_precision;
191 SQLSMALLINT sql_desc_rowver;
192 SQLSMALLINT sql_desc_scale;
193 DSTR sql_desc_schema_name;
194 DSTR sql_desc_table_name;
195 SQLSMALLINT sql_desc_searchable;
196 SQLSMALLINT sql_desc_type;
197 /* this point to a constant buffer, do not free or modify */
198 const char *sql_desc_type_name;
199 SQLSMALLINT sql_desc_unnamed;
200 SQLSMALLINT sql_desc_unsigned;
201 SQLSMALLINT sql_desc_updatable;
202};
203
204struct _hdesc
205{
206 SQLSMALLINT htype; /* do not reorder this field */
207 struct _sql_errors errs; /* do not reorder this field */
208 tds_mutex mtx;
209 int type;
216 int focus;
217 SQLHANDLE parent;
218 struct _dheader header;
219 struct _drecord *records;
220};
221
222typedef struct _hdesc TDS_DESC;
223
224#define DESC_IRD 1
225#define DESC_IPD 2
226#define DESC_ARD 3
227#define DESC_APD 4
228
230{
231 SQLUINTEGER connection_pooling;
232 SQLUINTEGER cp_match;
233 SQLINTEGER odbc_version;
234 SQLINTEGER output_nts;
235};
236
237struct _hchk
238{
239 SQLSMALLINT htype; /* do not reorder this field */
240 struct _sql_errors errs; /* do not reorder this field */
241 tds_mutex mtx;
242};
243
244struct _henv
245{
246 SQLSMALLINT htype; /* do not reorder this field */
247 struct _sql_errors errs; /* do not reorder this field */
248 tds_mutex mtx;
249 TDSCONTEXT *tds_ctx;
250 struct _heattr attr;
251};
252
254{
255 SQLUINTEGER access_mode;
256 SQLUINTEGER async_enable;
257 SQLUINTEGER auto_ipd;
258 SQLUINTEGER autocommit;
259 SQLUINTEGER connection_dead;
260 SQLUINTEGER connection_timeout;
261 DSTR current_catalog;
262 SQLUINTEGER login_timeout;
263 SQLUINTEGER metadata_id;
264 SQLUINTEGER odbc_cursors;
265 SQLUINTEGER packet_size;
266 SQLHWND quite_mode;
267 DSTR translate_lib;
268 SQLUINTEGER translate_option;
269 SQLUINTEGER txn_isolation;
270 SQLUINTEGER mars_enabled;
271 SQLUINTEGER cursor_type;
272 SQLUINTEGER bulk_enabled;
273#ifdef TDS_NO_DM
274 SQLUINTEGER trace;
275 DSTR tracefile;
276#endif
277};
278
279#define TDS_MAX_APP_DESC 100
280
281struct _hstmt;
282struct _hdbc
283{
284 SQLSMALLINT htype; /* do not reorder this field */
285 struct _sql_errors errs; /* do not reorder this field */
286 tds_mutex mtx;
287 struct _henv *env;
288 TDSSOCKET *tds_socket;
289 DSTR dsn;
290 DSTR oldpwd;
291 DSTR db_filename;
292#ifdef ENABLE_ODBC_WIDE
293 int original_charset_num;
294 TDSICONV *mb_conv;
295#endif
296
305 struct _hcattr attr;
307 TDS_DESC *uad[TDS_MAX_APP_DESC];
309 unsigned int cursor_support:1;
310 unsigned int use_oldpwd:1;
311 TDS_INT default_query_timeout;
312
313 TDSBCPINFO *bcpinfo;
314
315 /* ODBC extra options. Format strings for tds_strftime()
316 * to be applied when a client application fetches a date/time field
317 * as a character type. (Not used for the reverse direction)
318 */
319 DSTR datetime_fmt;
320 DSTR date_fmt;
321 DSTR time_fmt;
322};
323
325{
326 /* TODO remove IRD, ARD, IPD, APD from statement, do not duplicate */
327/* TDS_DESC *app_row_desc; */
328/* TDS_DESC *app_param_desc; */
329 SQLUINTEGER async_enable;
330 SQLUINTEGER concurrency;
331 SQLUINTEGER cursor_scrollable;
332 SQLUINTEGER cursor_sensitivity;
333 SQLUINTEGER cursor_type;
334 SQLUINTEGER enable_auto_ipd;
335 SQLPOINTER fetch_bookmark_ptr;
336 SQLULEN keyset_size;
337 SQLULEN max_length;
338 SQLULEN max_rows;
339 SQLUINTEGER metadata_id;
340 SQLUINTEGER noscan;
341 /* apd->sql_desc_bind_offset_ptr */
342 /* SQLUINTEGER *param_bind_offset_ptr; */
343 /* apd->sql_desc_bind_type */
344 /* SQLUINTEGER param_bind_type; */
345 /* apd->sql_desc_array_status_ptr */
346 /* SQLUSMALLINT *param_operation_ptr; */
347 /* ipd->sql_desc_array_status_ptr */
348 /* SQLUSMALLINT *param_status_ptr; */
349 /* ipd->sql_desc_rows_processed_ptr */
350 /* SQLUSMALLINT *params_processed_ptr; */
351 /* apd->sql_desc_array_size */
352 /* SQLUINTEGER paramset_size; */
353 SQLUINTEGER query_timeout;
354 SQLUINTEGER retrieve_data;
355 /* ard->sql_desc_bind_offset_ptr */
356 /* SQLUINTEGER *row_bind_offset_ptr; */
357 /* ard->sql_desc_array_size */
358 /* SQLUINTEGER row_array_size; */
359 /* ard->sql_desc_bind_type */
360 /* SQLUINTEGER row_bind_type; */
361 SQLULEN row_number;
362 /* ard->sql_desc_array_status_ptr */
363 /* SQLUINTEGER *row_operation_ptr; */
364 /* ird->sql_desc_array_status_ptr */
365 /* SQLUINTEGER *row_status_ptr; */
366 /* ird->sql_desc_rows_processed_ptr */
367 /* SQLUINTEGER *rows_fetched_ptr; */
368 SQLUINTEGER simulate_cursor;
369 SQLUINTEGER use_bookmarks;
370 /* SQLGetStmtAttr only */
371/* TDS_DESC *imp_row_desc; */
372/* TDS_DESC *imp_param_desc; */
373 DSTR qn_msgtext;
374 DSTR qn_options;
375 SQLUINTEGER qn_timeout;
376 SQLUINTEGER param_focus;
377};
378
379typedef enum
380{
381 NOT_IN_ROW,
382 IN_NORMAL_ROW,
383 IN_COMPUTE_ROW,
384 AFTER_COMPUTE_ROW,
385 PRE_NORMAL_ROW
386} TDS_ODBC_ROW_STATUS;
387
388typedef enum
389{
390 ODBC_SPECIAL_NONE = 0,
391 ODBC_SPECIAL_GETTYPEINFO = 1,
392 ODBC_SPECIAL_COLUMNS = 2,
393 ODBC_SPECIAL_PROCEDURECOLUMNS = 3,
394 ODBC_SPECIAL_SPECIALCOLUMNS = 4
395} TDS_ODBC_SPECIAL_ROWS;
396
397struct _hstmt
398{
399 SQLSMALLINT htype; /* do not reorder this field */
400 struct _sql_errors errs; /* do not reorder this field */
401 tds_mutex mtx;
402 struct _hdbc *dbc;
406 TDSSOCKET *tds;
407
409 struct _hstmt *next;
411 struct _hstmt *prev;
412
413 /* begin prepared query stuff */
414 unsigned is_prepared_query:1;
415 unsigned prepared_query_is_func:1;
416 unsigned prepared_query_is_rpc:1;
421 unsigned need_reprepare:1;
422 unsigned param_data_called:1;
423 unsigned params_queried:1;
424 unsigned params_set:1;
425 /* end prepared query stuff */
426
428 TDSPARAMINFO *params;
433
434 unsigned int curr_param_row, num_param_rows;
435
437 unsigned int param_count;
438 int row;
440 TDS_INT8 row_count;
442 TDS_ODBC_ROW_STATUS row_status;
443 /* do NOT free dynamic, free from socket or attach to connection */
444 TDSDYNAMIC *dyn;
445 TDS_DESC *ard, *ird, *apd, *ipd;
446 TDS_DESC *orig_ard, *orig_apd;
447 SQLULEN sql_rowset_size;
448 struct _hsattr attr;
449 DSTR cursor_name; /* auto generated cursor name */
450 TDS_ODBC_SPECIAL_ROWS special_row;
451 /* do NOT free cursor, free from socket or attach to connection */
452 TDSCURSOR *cursor;
453};
454
455typedef struct _henv TDS_ENV;
456typedef struct _hdbc TDS_DBC;
457typedef struct _hstmt TDS_STMT;
458typedef struct _hchk TDS_CHK;
459
460typedef struct
461{
462 /* this must be the first member */
463 TDSCOLUMNFUNCS common;
464 void (*set_type_info)(TDSCOLUMN * col, struct _drecord * drec, const TDS_DBC * dbc);
465} TDS_FUNCS;
466
467#define IS_HENV(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_ENV)
468#define IS_HDBC(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_DBC)
469#define IS_HSTMT(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_STMT)
470#define IS_HDESC(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_DESC)
471
472/* fix a bug in MingW headers */
473#ifdef __MINGW32__
474#if SQL_INTERVAL_YEAR == (100 + SQL_CODE_SECOND)
475
476#undef SQL_INTERVAL_YEAR
477#undef SQL_INTERVAL_MONTH
478#undef SQL_INTERVAL_DAY
479#undef SQL_INTERVAL_HOUR
480#undef SQL_INTERVAL_MINUTE
481#undef SQL_INTERVAL_SECOND
482#undef SQL_INTERVAL_YEAR_TO_MONTH
483#undef SQL_INTERVAL_DAY_TO_HOUR
484#undef SQL_INTERVAL_DAY_TO_MINUTE
485#undef SQL_INTERVAL_DAY_TO_SECOND
486#undef SQL_INTERVAL_HOUR_TO_MINUTE
487#undef SQL_INTERVAL_HOUR_TO_SECOND
488#undef SQL_INTERVAL_MINUTE_TO_SECOND
489
490#define SQL_INTERVAL_YEAR (100 + SQL_CODE_YEAR)
491#define SQL_INTERVAL_MONTH (100 + SQL_CODE_MONTH)
492#define SQL_INTERVAL_DAY (100 + SQL_CODE_DAY)
493#define SQL_INTERVAL_HOUR (100 + SQL_CODE_HOUR)
494#define SQL_INTERVAL_MINUTE (100 + SQL_CODE_MINUTE)
495#define SQL_INTERVAL_SECOND (100 + SQL_CODE_SECOND)
496#define SQL_INTERVAL_YEAR_TO_MONTH (100 + SQL_CODE_YEAR_TO_MONTH)
497#define SQL_INTERVAL_DAY_TO_HOUR (100 + SQL_CODE_DAY_TO_HOUR)
498#define SQL_INTERVAL_DAY_TO_MINUTE (100 + SQL_CODE_DAY_TO_MINUTE)
499#define SQL_INTERVAL_DAY_TO_SECOND (100 + SQL_CODE_DAY_TO_SECOND)
500#define SQL_INTERVAL_HOUR_TO_MINUTE (100 + SQL_CODE_HOUR_TO_MINUTE)
501#define SQL_INTERVAL_HOUR_TO_SECOND (100 + SQL_CODE_HOUR_TO_SECOND)
502#define SQL_INTERVAL_MINUTE_TO_SECOND (100 + SQL_CODE_MINUTE_TO_SECOND)
503
504#endif
505#endif
506
507#ifdef _WIN32
508bool get_login_info(HWND hwndParent, TDSLOGIN * login);
509#endif
510
511#define ODBC_PARAM_LIST \
512 ODBC_PARAM(Address) \
513 ODBC_PARAM(APP) \
514 ODBC_PARAM(ApplicationIntent) \
515 ODBC_PARAM(AttachDbFilename) \
516 ODBC_PARAM(ClientCharset) \
517 ODBC_PARAM(ConnectionTimeout) \
518 ODBC_PARAM(Database) \
519 ODBC_PARAM(DateFmt) \
520 ODBC_PARAM(DateTimeFmt) \
521 ODBC_PARAM(DebugFlags) \
522 ODBC_PARAM(DSN) \
523 ODBC_PARAM(DumpFile) \
524 ODBC_PARAM(DumpFileAppend) \
525 ODBC_PARAM(Encrypt) \
526 ODBC_PARAM(Encryption) \
527 ODBC_PARAM(HostNameInCertificate) \
528 ODBC_PARAM(Language) \
529 ODBC_PARAM(MARS_Connection) \
530 ODBC_PARAM(PacketSize) \
531 ODBC_PARAM(Port) \
532 ODBC_PARAM(PWD) \
533 ODBC_PARAM(REALM) \
534 ODBC_PARAM(Server) \
535 ODBC_PARAM(ServerCertificate) \
536 ODBC_PARAM(Servername) \
537 ODBC_PARAM(ServerSPN) \
538 ODBC_PARAM(TDS_Version) \
539 ODBC_PARAM(TextSize) \
540 ODBC_PARAM(TimeFmt) \
541 ODBC_PARAM(Timeout) \
542 ODBC_PARAM(Trusted_Connection) \
543 ODBC_PARAM(UID) \
544 ODBC_PARAM(UseNTLMv2) \
545 ODBC_PARAM(WSID)
546
547#define ODBC_PARAM(p) ODBC_PARAM_##p,
548enum {
549 ODBC_PARAM_LIST
550 ODBC_PARAM_SIZE
551};
552#undef ODBC_PARAM
553
554#define ODBC_PARAM(p) extern const char odbc_param_##p[];
555ODBC_PARAM_LIST
556#undef ODBC_PARAM
557
558/*
559 * connectparams.h
560 */
561
562typedef struct {
563 const char *p;
564 size_t len;
566
577bool odbc_parse_connect_string(TDS_ERRS * errs, const char *connect_string, const char *connect_string_end,
578 TDSLOGIN * login, TDS_DBC * dbc, TDS_PARSED_PARAM * parsed_params);
579bool odbc_get_dsn_info(TDS_ERRS *errs, const char *DSN, TDSLOGIN * login);
580#ifdef _WIN32
581int odbc_build_connect_string(TDS_ERRS *errs, TDS_PARSED_PARAM *params, char **out);
582#endif
583
584/*
585 * convert_tds2sql.c
586 */
587SQLLEN odbc_tds2sql_col(TDS_STMT * stmt, TDSCOLUMN *curcol, int desttype,
588 TDS_CHAR * dest, SQLULEN destlen, const struct _drecord *drec_ixd);
589SQLLEN odbc_tds2sql_int4(TDS_STMT * stmt, TDS_INT *src, int desttype, TDS_CHAR * dest, SQLULEN destlen);
590
591
592
593/*
594 * descriptor.c
595 */
596typedef struct {
597 DSTR type_name;
598 TDS_DESC *apd;
599 TDS_DESC *ipd;
600} SQLTVP;
601
602TDS_DESC *desc_alloc(SQLHANDLE parent, int desc_type, SQLSMALLINT alloc_type);
603SQLRETURN desc_free(TDS_DESC * desc);
604SQLRETURN desc_alloc_records(TDS_DESC * desc, SQLSMALLINT count);
605SQLRETURN desc_copy(TDS_DESC * dest, TDS_DESC * src);
606SQLRETURN desc_free_records(TDS_DESC * desc);
607TDS_DBC *desc_get_dbc(TDS_DESC *desc);
608SQLTVP *tvp_alloc(TDS_STMT *stmt);
609void tvp_free(SQLTVP *tvp);
610
611/*
612 * odbc.c
613 */
614
615SQLRETURN odbc_SQLRowCount(SQLHSTMT hstmt, SQLLEN FAR * pcrow);
616
617/*
618 * odbc_checks.h
619 */
620#if ENABLE_EXTRA_CHECKS
621/* macro */
622#define CHECK_ENV_EXTRA(env) odbc_check_env_extra(env)
623#define CHECK_DBC_EXTRA(dbc) odbc_check_dbc_extra(dbc)
624#define CHECK_STMT_EXTRA(stmt) odbc_check_stmt_extra(stmt)
625#define CHECK_DESC_EXTRA(desc) odbc_check_desc_extra(desc)
626/* declarations*/
627void odbc_check_env_extra(TDS_ENV * env);
628void odbc_check_dbc_extra(TDS_DBC * dbc);
629void odbc_check_stmt_extra(TDS_STMT * stmt);
630void odbc_check_desc_extra(TDS_DESC * desc);
631#else
632/* macro */
633#define CHECK_ENV_EXTRA(env)
634#define CHECK_DBC_EXTRA(dbc)
635#define CHECK_STMT_EXTRA(stmt)
636#define CHECK_DESC_EXTRA(desc)
637#endif
638
639/*
640 * odbc_util.h
641 */
642
643/* helpers for ODBC wide string support */
644#undef _wide
645#undef _WIDE
646#ifdef ENABLE_ODBC_WIDE
647typedef union {
648 char mb[1];
649 SQLWCHAR wide[1];
650} ODBC_CHAR;
651# define _wide ,wide
652# define _wide0 ,0
653# define _WIDE ,int wide
654#else
655# define _wide
656# define _wide0
657# define _WIDE
658# define ODBC_CHAR SQLCHAR
659#endif
660SQLRETURN odbc_set_stmt_query(struct _hstmt *stmt, const ODBC_CHAR *sql, ptrdiff_t sql_len _WIDE);
661void odbc_set_return_status(struct _hstmt *stmt, unsigned int n_row);
662void odbc_set_return_params(struct _hstmt *stmt, unsigned int n_row);
663
664void odbc_set_sql_type_info(TDSCOLUMN * col, struct _drecord *drec, const TDS_DBC * dbc);
665
666int odbc_sql_to_c_type_default(int sql_type);
667TDS_SERVER_TYPE odbc_sql_to_server_type(TDSCONNECTION * conn, int sql_type, int sql_unsigned);
668TDS_SERVER_TYPE odbc_c_to_server_type(int c_type);
669
670size_t odbc_get_string_size(ptrdiff_t size, const ODBC_CHAR * str _WIDE);
671void odbc_rdbms_version(TDSSOCKET * tds_socket, char *pversion_string);
672SQLLEN odbc_get_param_len(const struct _drecord *drec_axd, const struct _drecord *drec_ixd,
673 const TDS_DESC* axd, SQLSETPOSIROW n_row);
674
675#ifdef ENABLE_ODBC_WIDE
676DSTR* odbc_dstr_copy_flag(TDS_DBC *dbc, DSTR *s, ptrdiff_t size, const ODBC_CHAR * str, int flag);
677#define odbc_dstr_copy(dbc, s, len, out) \
678 odbc_dstr_copy_flag(dbc, s, len, sizeof((out)->mb) ? (out) : (out), wide)
679#define odbc_dstr_copy_oct(dbc, s, len, out) \
680 odbc_dstr_copy_flag(dbc, s, len, out, wide|0x20)
681#else
682DSTR* odbc_dstr_copy(TDS_DBC *dbc, DSTR *s, ptrdiff_t size, const ODBC_CHAR * str);
683#define odbc_dstr_copy_oct odbc_dstr_copy
684#endif
685
686
687SQLRETURN odbc_set_string_flag(TDS_DBC *dbc, SQLPOINTER buffer, SQLINTEGER cbBuffer, void FAR * pcbBuffer,
688 const char *s, ptrdiff_t len, int flag);
689#ifdef ENABLE_ODBC_WIDE
690#define odbc_set_string(dbc, buf, buf_len, out_len, s, s_len) \
691 odbc_set_string_flag(dbc, sizeof((buf)->mb) ? (buf) : (buf), buf_len, out_len, s, s_len, \
692 (wide) | (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0:0x10))
693#define odbc_set_string_oct(dbc, buf, buf_len, out_len, s, s_len) \
694 odbc_set_string_flag(dbc, buf, buf_len, out_len, s, s_len, (wide) | (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0x20:0x30))
695#else
696#define odbc_set_string(dbc, buf, buf_len, out_len, s, s_len) \
697 odbc_set_string_flag(dbc, buf, buf_len, out_len, s, s_len, (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0:0x10))
698#define odbc_set_string_oct(dbc, buf, buf_len, out_len, s, s_len) \
699 odbc_set_string_flag(dbc, buf, buf_len, out_len, s, s_len, (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0x20:0x30))
700#endif
701
702#define odbc_set_dstr_oct(dbc, buf, buf_len, out_len, s) \
703 odbc_set_string_oct(dbc, buf, buf_len, out_len, tds_dstr_cstr(s), tds_dstr_len(s))
704#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))
705
706SQLSMALLINT odbc_get_concise_sql_type(SQLSMALLINT type, SQLSMALLINT interval);
707SQLRETURN odbc_set_concise_sql_type(SQLSMALLINT concise_type, struct _drecord *drec, int check_only);
708SQLSMALLINT odbc_get_concise_c_type(SQLSMALLINT type, SQLSMALLINT interval);
709SQLRETURN odbc_set_concise_c_type(SQLSMALLINT concise_type, struct _drecord *drec, int check_only);
710
711SQLLEN odbc_get_octet_len(int c_type, const struct _drecord *drec);
712void odbc_convert_err_set(struct _sql_errors *errs, TDS_INT err);
713
714/*
715 * prepare_query.c
716 */
717SQLRETURN prepare_call(struct _hstmt *stmt);
718SQLRETURN native_sql(struct _hdbc *dbc, DSTR *s);
719int parse_prepared_query(struct _hstmt *stmt, bool compute_row);
720int start_parse_prepared_query(struct _hstmt *stmt, bool compute_row);
721int continue_parse_prepared_query(struct _hstmt *stmt, SQLPOINTER DataPtr, SQLLEN StrLen_or_Ind);
722const char *parse_const_param(const char * s, TDS_SERVER_TYPE *type);
723const char *odbc_skip_rpc_name(const char *s);
724
725/*
726 * sql2tds.c
727 */
728typedef union {
729 TDS_DATETIMEALL dta;
730 TDS_NUMERIC num;
732
733SQLRETURN odbc_sql2tds(TDS_STMT * stmt, const struct _drecord *drec_ixd, const struct _drecord *drec_axd, TDSCOLUMN *curcol,
734 bool compute_row, const TDS_DESC* axd, SQLSETPOSIROW n_row);
735TDS_INT convert_datetime2server(int bindtype, const void *src, TDS_DATETIMEALL * dta);
736TDS_INT convert_numeric2server(struct _sql_errors *errs, const void *src, TDS_NUMERIC *num);
737
738/*
739 * bcp.c
740 */
741void odbc_bcp_free_storage(TDS_DBC *dbc);
742void odbc_bcp_init(TDS_DBC *dbc, const ODBC_CHAR *tblname, const ODBC_CHAR *hfile, const ODBC_CHAR *errfile, int direction _WIDE);
743void odbc_bcp_control(TDS_DBC *dbc, int field, void *value);
744void odbc_bcp_colptr(TDS_DBC *dbc, const void * colptr, int table_column);
745void odbc_bcp_sendrow(TDS_DBC *dbc);
746int odbc_bcp_batch(TDS_DBC *dbc);
747int odbc_bcp_done(TDS_DBC *dbc);
748void odbc_bcp_bind(TDS_DBC *dbc, const void * varaddr, int prefixlen, int varlen, const void * terminator, int termlen,
749 int vartype, int table_column);
750
751/*
752 * sqlwchar.c
753 */
754#if SIZEOF_SQLWCHAR != SIZEOF_WCHAR_T
755size_t sqlwcslen(const SQLWCHAR * s);
756#else
757#define sqlwcslen(s) wcslen(s)
758#endif
759
760#ifdef ENABLE_ODBC_WIDE
761#if SIZEOF_SQLWCHAR != SIZEOF_WCHAR_T
762typedef struct sqlwstr_buf {
763 struct sqlwstr_buf *next;
764 wchar_t buf[256];
765} SQLWSTRBUF;
766const wchar_t *sqlwstr(const SQLWCHAR * s, SQLWSTRBUF **bufs);
767void sqlwstr_free(SQLWSTRBUF *bufs);
768#define SQLWSTR_BUFS(n) SQLWSTRBUF *bufs = NULL
769#define SQLWSTR(s) sqlwstr(s, &bufs)
770#define SQLWSTR_FREE() sqlwstr_free(bufs)
771#else
772#define SQLWSTR_BUFS(n) do {} while(0)
773#define SQLWSTR(s) ((const wchar_t*)(s))
774#define SQLWSTR_FREE() do {} while(0)
775#endif
776#endif
777
778int odbc_get_wide_canonic(TDSCONNECTION *conn);
779
780/* compatibility with old BCP implementation */
781#define BCPHINTS_OLD 6
782#define SQL_COPT_TDSODBC_IMPL_BCP_CONTROL_OLD (SQL_COPT_TDSODBC_IMPL_BASE+1)
783
784/* iODBC extensions used by our driver */
785#ifndef SQL_ATTR_DRIVER_UNICODE_TYPE
786#define SQL_ATTR_DRIVER_UNICODE_TYPE 1065
787#endif
788
789#ifndef SQL_DM_CP_UTF16
790#define SQL_DM_CP_UTF16 1
791#endif
792#ifndef SQL_DM_CP_UTF8
793#define SQL_DM_CP_UTF8 2
794#endif
795#ifndef SQL_DM_CP_UCS4
796#define SQL_DM_CP_UCS4 3
797#endif
798
799#include <freetds/popvis.h>
800
801#ifdef __cplusplus
802#if 0
803{
804#endif
805}
806#endif
807
808#endif
Main include file for libtds.
struct tds_dynamic TDSDYNAMIC
Holds information for a dynamic (also called prepared) query.
struct tds_cursor TDSCURSOR
Holds information about a cursor.
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:996
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:1123
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:613
SQLLEN odbc_get_param_len(const struct _drecord *drec_axd, const struct _drecord *drec_ixd, const TDS_DESC *axd, SQLSETPOSIROW n_row)
Return length of parameter from parameter information.
Definition odbc_util.c:878
SQLRETURN odbc_set_string_flag(TDS_DBC *dbc TDS_UNUSED, SQLPOINTER buffer, SQLINTEGER cbBuffer, void FAR *pcbBuffer, const char *s, ptrdiff_t len, int flag)
Copy a string to client setting size according to ODBC convenction.
Definition odbc_util.c:304
void odbc_rdbms_version(TDSSOCKET *tds_socket, char *pversion_string)
Returns the version of the RDBMS in the ODBC format.
Definition odbc_util.c:869
struct tds_dstr * DSTR
Structure to hold a string.
Definition odbc.h:92
Definition odbc.h:105
Descriptor header.
Definition odbc.h:151
Descriptor record.
Definition odbc.h:164
Definition odbc.h:205
int focus
Nested descriptor to use.
Definition odbc.h:216
Definition odbc.h:230
Definition odbc.h:238
Definition odbc.h:245
Definition odbc.h:254
Definition odbc.h:283
struct _hstmt * stmt_list
list of all statements allocated from this connection
Definition odbc.h:304
TDS_DESC * uad[TDS_MAX_APP_DESC]
descriptors associated to connection
Definition odbc.h:307
struct _hstmt * current_statement
Statement executing.
Definition odbc.h:302
unsigned int cursor_support
<>0 if server handle cursors
Definition odbc.h:309
Definition odbc.h:325
Definition odbc.h:398
unsigned int param_count
number of parameter in current query
Definition odbc.h:437
TDS_ODBC_ROW_STATUS row_status
status of row, it can happen that this flag mark that we are still parsing row, this it's normal
Definition odbc.h:442
size_t prepared_pos
position in prepared query to check parameters, used only in RPC
Definition odbc.h:432
TDS_INT8 row_count
row count to return
Definition odbc.h:440
int param_num
last valid parameter in params, it's a ODBC index (from 1 relative to descriptor)
Definition odbc.h:430
DSTR query
query to execute
Definition odbc.h:404
unsigned need_reprepare
Prepared statement needs to be prepared again.
Definition odbc.h:421
struct _hstmt * next
next in list
Definition odbc.h:409
TDSSOCKET * tds
socket (only if active)
Definition odbc.h:406
struct _hstmt * prev
previous in list
Definition odbc.h:411
TDSPARAMINFO * params
parameters saved
Definition odbc.h:428
Definition odbc.h:461
Definition odbc.h:562
Definition odbc.h:596
Definition odbc.h:728
This structure is not directly connected to TDS protocol but keeps any DATE/TIME information.
Definition tds.h:146
Information for a server connection.
Definition tds.h:1190