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

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/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
91 struct _sql_error
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
104 struct _sql_errors
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
150 struct _dheader
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 SQLLEN *sql_desc_bind_offset_ptr;
160};
161
163 struct _drecord
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
204 struct _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
229 struct _heattr
230{
231 SQLUINTEGER connection_pooling;
232 SQLUINTEGER cp_match;
233 SQLINTEGER odbc_version;
234 SQLINTEGER output_nts;
235};
236
237 struct _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
244 struct _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
253 struct _hcattr
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;
282 struct _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#ifdef ENABLE_ODBC_WIDE
292 int original_charset_num;
293 TDSICONV *mb_conv;
294#endif
295
301 struct _hstmt *current_statement;
303 struct _hstmt *stmt_list;
304 struct _hcattr attr;
306 TDS_DESC *uad[TDS_MAX_APP_DESC];
308 unsigned int cursor_support:1;
309 unsigned int use_oldpwd:1;
310 TDS_INT default_query_timeout;
311
312 TDSBCPINFO *bcpinfo;
313};
314
315 struct _hsattr
316{
317 /* TODO remove IRD, ARD, IPD, APD from statement, do not duplicate */
318/* TDS_DESC *app_row_desc; */
319/* TDS_DESC *app_param_desc; */
320 SQLUINTEGER async_enable;
321 SQLUINTEGER concurrency;
322 SQLUINTEGER cursor_scrollable;
323 SQLUINTEGER cursor_sensitivity;
324 SQLUINTEGER cursor_type;
325 SQLUINTEGER enable_auto_ipd;
326 SQLPOINTER fetch_bookmark_ptr;
327 SQLULEN keyset_size;
328 SQLULEN max_length;
329 SQLULEN max_rows;
330 SQLUINTEGER metadata_id;
331 SQLUINTEGER noscan;
332 /* apd->sql_desc_bind_offset_ptr */
333 /* SQLUINTEGER *param_bind_offset_ptr; */
334 /* apd->sql_desc_bind_type */
335 /* SQLUINTEGER param_bind_type; */
336 /* apd->sql_desc_array_status_ptr */
337 /* SQLUSMALLINT *param_operation_ptr; */
338 /* ipd->sql_desc_array_status_ptr */
339 /* SQLUSMALLINT *param_status_ptr; */
340 /* ipd->sql_desc_rows_processed_ptr */
341 /* SQLUSMALLINT *params_processed_ptr; */
342 /* apd->sql_desc_array_size */
343 /* SQLUINTEGER paramset_size; */
344 SQLUINTEGER query_timeout;
345 SQLUINTEGER retrieve_data;
346 /* ard->sql_desc_bind_offset_ptr */
347 /* SQLUINTEGER *row_bind_offset_ptr; */
348 /* ard->sql_desc_array_size */
349 /* SQLUINTEGER row_array_size; */
350 /* ard->sql_desc_bind_type */
351 /* SQLUINTEGER row_bind_type; */
352 SQLULEN row_number;
353 /* ard->sql_desc_array_status_ptr */
354 /* SQLUINTEGER *row_operation_ptr; */
355 /* ird->sql_desc_array_status_ptr */
356 /* SQLUINTEGER *row_status_ptr; */
357 /* ird->sql_desc_rows_processed_ptr */
358 /* SQLUINTEGER *rows_fetched_ptr; */
359 SQLUINTEGER simulate_cursor;
360 SQLUINTEGER use_bookmarks;
361 /* SQLGetStmtAttr only */
362/* TDS_DESC *imp_row_desc; */
363/* TDS_DESC *imp_param_desc; */
364 DSTR qn_msgtext;
365 DSTR qn_options;
366 SQLUINTEGER qn_timeout;
367 SQLUINTEGER param_focus;
368};
369
370typedef enum
371{
372 NOT_IN_ROW,
373 IN_NORMAL_ROW,
374 IN_COMPUTE_ROW,
375 AFTER_COMPUTE_ROW,
376 PRE_NORMAL_ROW
377} TDS_ODBC_ROW_STATUS;
378
379typedef enum
380{
381 ODBC_SPECIAL_NONE = 0,
382 ODBC_SPECIAL_GETTYPEINFO = 1,
383 ODBC_SPECIAL_COLUMNS = 2,
384 ODBC_SPECIAL_PROCEDURECOLUMNS = 3,
385 ODBC_SPECIAL_SPECIALCOLUMNS = 4
386} TDS_ODBC_SPECIAL_ROWS;
387
388 struct _hstmt
389{
390 SQLSMALLINT htype; /* do not reorder this field */
391 struct _sql_errors errs; /* do not reorder this field */
392 tds_mutex mtx;
393 struct _hdbc *dbc;
395 DSTR query;
397 TDSSOCKET *tds;
398
400 struct _hstmt *next;
402 struct _hstmt *prev;
403
404 /* begin prepared query stuff */
405 unsigned is_prepared_query:1;
406 unsigned prepared_query_is_func:1;
407 unsigned prepared_query_is_rpc:1;
412 unsigned need_reprepare:1;
413 unsigned param_data_called:1;
414 unsigned params_queried:1;
415 unsigned params_set:1;
416 /* end prepared query stuff */
417
419 TDSPARAMINFO *params;
421 int param_num;
423 size_t prepared_pos;
424
425 unsigned int curr_param_row, num_param_rows;
426
428 unsigned int param_count;
429 int row;
431 TDS_INT8 row_count;
433 TDS_ODBC_ROW_STATUS row_status;
434 /* do NOT free dynamic, free from socket or attach to connection */
435 TDSDYNAMIC *dyn;
436 TDS_DESC *ard, *ird, *apd, *ipd;
437 TDS_DESC *orig_ard, *orig_apd;
438 SQLULEN sql_rowset_size;
439 struct _hsattr attr;
440 DSTR cursor_name; /* auto generated cursor name */
441 TDS_ODBC_SPECIAL_ROWS special_row;
442 /* do NOT free cursor, free from socket or attach to connection */
443 TDSCURSOR *cursor;
444};
445
446typedef struct _henv TDS_ENV;
447typedef struct _hdbc TDS_DBC;
448typedef struct _hstmt TDS_STMT;
449typedef struct _hchk TDS_CHK;
450
451 typedef struct {
452 /* this must be the first member */
453 TDSCOLUMNFUNCS common;
454 void (*set_type_info)(TDSCOLUMN *col, struct _drecord *drec, SQLINTEGER odbc_ver);
455} TDS_FUNCS;
456
457#define IS_HENV(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_ENV)
458#define IS_HDBC(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_DBC)
459#define IS_HSTMT(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_STMT)
460#define IS_HDESC(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_DESC)
461
462/* fix a bug in MingW headers */
463#ifdef __MINGW32__
464#if SQL_INTERVAL_YEAR == (100 + SQL_CODE_SECOND)
465
466#undef SQL_INTERVAL_YEAR
467#undef SQL_INTERVAL_MONTH
468#undef SQL_INTERVAL_DAY
469#undef SQL_INTERVAL_HOUR
470#undef SQL_INTERVAL_MINUTE
471#undef SQL_INTERVAL_SECOND
472#undef SQL_INTERVAL_YEAR_TO_MONTH
473#undef SQL_INTERVAL_DAY_TO_HOUR
474#undef SQL_INTERVAL_DAY_TO_MINUTE
475#undef SQL_INTERVAL_DAY_TO_SECOND
476#undef SQL_INTERVAL_HOUR_TO_MINUTE
477#undef SQL_INTERVAL_HOUR_TO_SECOND
478#undef SQL_INTERVAL_MINUTE_TO_SECOND
479
480#define SQL_INTERVAL_YEAR (100 + SQL_CODE_YEAR)
481#define SQL_INTERVAL_MONTH (100 + SQL_CODE_MONTH)
482#define SQL_INTERVAL_DAY (100 + SQL_CODE_DAY)
483#define SQL_INTERVAL_HOUR (100 + SQL_CODE_HOUR)
484#define SQL_INTERVAL_MINUTE (100 + SQL_CODE_MINUTE)
485#define SQL_INTERVAL_SECOND (100 + SQL_CODE_SECOND)
486#define SQL_INTERVAL_YEAR_TO_MONTH (100 + SQL_CODE_YEAR_TO_MONTH)
487#define SQL_INTERVAL_DAY_TO_HOUR (100 + SQL_CODE_DAY_TO_HOUR)
488#define SQL_INTERVAL_DAY_TO_MINUTE (100 + SQL_CODE_DAY_TO_MINUTE)
489#define SQL_INTERVAL_DAY_TO_SECOND (100 + SQL_CODE_DAY_TO_SECOND)
490#define SQL_INTERVAL_HOUR_TO_MINUTE (100 + SQL_CODE_HOUR_TO_MINUTE)
491#define SQL_INTERVAL_HOUR_TO_SECOND (100 + SQL_CODE_HOUR_TO_SECOND)
492#define SQL_INTERVAL_MINUTE_TO_SECOND (100 + SQL_CODE_MINUTE_TO_SECOND)
493
494#endif
495#endif
496
497#ifdef _WIN32
498bool get_login_info(HWND hwndParent, TDSLOGIN * login);
499#endif
500
501#define ODBC_PARAM_LIST \
502 ODBC_PARAM(Servername) \
503 ODBC_PARAM(Server) \
504 ODBC_PARAM(DSN) \
505 ODBC_PARAM(UID) \
506 ODBC_PARAM(PWD) \
507 ODBC_PARAM(Address) \
508 ODBC_PARAM(Port) \
509 ODBC_PARAM(TDS_Version) \
510 ODBC_PARAM(Language) \
511 ODBC_PARAM(Database) \
512 ODBC_PARAM(TextSize) \
513 ODBC_PARAM(PacketSize) \
514 ODBC_PARAM(ClientCharset) \
515 ODBC_PARAM(DumpFile) \
516 ODBC_PARAM(DumpFileAppend) \
517 ODBC_PARAM(DebugFlags) \
518 ODBC_PARAM(Encryption) \
519 ODBC_PARAM(Trusted_Connection) \
520 ODBC_PARAM(APP) \
521 ODBC_PARAM(WSID) \
522 ODBC_PARAM(UseNTLMv2) \
523 ODBC_PARAM(MARS_Connection) \
524 ODBC_PARAM(REALM) \
525 ODBC_PARAM(ServerSPN) \
526 ODBC_PARAM(AttachDbFilename) \
527 ODBC_PARAM(ApplicationIntent) \
528 ODBC_PARAM(Timeout) \
529 ODBC_PARAM(Encrypt) \
530 ODBC_PARAM(HostNameInCertificate)
531
532#define ODBC_PARAM(p) ODBC_PARAM_##p,
533enum {
534 ODBC_PARAM_LIST
535 ODBC_PARAM_SIZE
536};
537#undef ODBC_PARAM
538
539#define ODBC_PARAM(p) extern const char odbc_param_##p[];
540ODBC_PARAM_LIST
541#undef ODBC_PARAM
542
543/*
544 * connectparams.h
545 */
546
547 typedef struct {
548 const char *p;
549 size_t len;
550} TDS_PARSED_PARAM;
551
559bool odbc_parse_connect_string(TDS_ERRS *errs, const char *connect_string, const char *connect_string_end,
560 TDSLOGIN * login, TDS_PARSED_PARAM *parsed_params);
561bool odbc_get_dsn_info(TDS_ERRS *errs, const char *DSN, TDSLOGIN * login);
562#ifdef _WIN32
563int odbc_build_connect_string(TDS_ERRS *errs, TDS_PARSED_PARAM *params, char **out);
564#endif
565
566/*
567 * convert_tds2sql.c
568 */
569SQLLEN odbc_tds2sql_col(TDS_STMT * stmt, TDSCOLUMN *curcol, int desttype,
570 TDS_CHAR * dest, SQLULEN destlen, const struct _drecord *drec_ixd);
571SQLLEN odbc_tds2sql_int4(TDS_STMT * stmt, TDS_INT *src, int desttype, TDS_CHAR * dest, SQLULEN destlen);
572
573
574
575/*
576 * descriptor.c
577 */
578 typedef struct {
579 DSTR type_name;
580 TDS_DESC *apd;
581 TDS_DESC *ipd;
582} SQLTVP;
583
584 TDS_DESC *desc_alloc(SQLHANDLE parent, int desc_type, SQLSMALLINT alloc_type);
585SQLRETURN desc_free(TDS_DESC * desc);
586SQLRETURN desc_alloc_records(TDS_DESC * desc, SQLSMALLINT count);
587SQLRETURN desc_copy(TDS_DESC * dest, TDS_DESC * src);
588SQLRETURN desc_free_records(TDS_DESC * desc);
589 TDS_DBC *desc_get_dbc(TDS_DESC *desc);
590 SQLTVP *tvp_alloc(TDS_STMT *stmt);
591void tvp_free(SQLTVP *tvp);
592
593/*
594 * odbc.c
595 */
596
597SQLRETURN odbc_SQLRowCount(SQLHSTMT hstmt, SQLLEN FAR * pcrow);
598
599/*
600 * odbc_checks.h
601 */
602#if ENABLE_EXTRA_CHECKS
603/* macro */
604#define CHECK_ENV_EXTRA(env) odbc_check_env_extra(env)
605#define CHECK_DBC_EXTRA(dbc) odbc_check_dbc_extra(dbc)
606#define CHECK_STMT_EXTRA(stmt) odbc_check_stmt_extra(stmt)
607#define CHECK_DESC_EXTRA(desc) odbc_check_desc_extra(desc)
608/* declarations*/
609void odbc_check_env_extra(TDS_ENV * env);
610void odbc_check_dbc_extra(TDS_DBC * dbc);
611void odbc_check_stmt_extra(TDS_STMT * stmt);
612void odbc_check_desc_extra(TDS_DESC * desc);
613#else
614/* macro */
615#define CHECK_ENV_EXTRA(env)
616#define CHECK_DBC_EXTRA(dbc)
617#define CHECK_STMT_EXTRA(stmt)
618#define CHECK_DESC_EXTRA(desc)
619#endif
620
621/*
622 * odbc_util.h
623 */
624
625/* helpers for ODBC wide string support */
626#undef _wide
627#undef _WIDE
628#ifdef ENABLE_ODBC_WIDE
629typedef union {
630 char mb[1];
631 SQLWCHAR wide[1];
632} ODBC_CHAR;
633# define _wide ,wide
634# define _wide0 ,0
635# define _WIDE ,int wide
636#else
637# define _wide
638# define _wide0
639# define _WIDE
640# define ODBC_CHAR SQLCHAR
641#endif
642SQLRETURN odbc_set_stmt_query(struct _hstmt *stmt, const ODBC_CHAR *sql, ptrdiff_t sql_len _WIDE);
643void odbc_set_return_status(struct _hstmt *stmt, unsigned int n_row);
644void odbc_set_return_params(struct _hstmt *stmt, unsigned int n_row);
645
646void odbc_set_sql_type_info(TDSCOLUMN * col, struct _drecord *drec, SQLINTEGER odbc_ver);
647
648int odbc_sql_to_c_type_default(int sql_type);
649TDS_SERVER_TYPE odbc_sql_to_server_type(TDSCONNECTION * conn, int sql_type, int sql_unsigned);
650TDS_SERVER_TYPE odbc_c_to_server_type(int c_type);
651
652size_t odbc_get_string_size(ptrdiff_t size, const ODBC_CHAR * str _WIDE);
653void odbc_rdbms_version(TDSSOCKET * tds_socket, char *pversion_string);
654SQLLEN odbc_get_param_len(const struct _drecord *drec_axd, const struct _drecord *drec_ixd,
655 const TDS_DESC* axd, SQLSETPOSIROW n_row);
656
657#ifdef ENABLE_ODBC_WIDE
658 DSTR* odbc_dstr_copy_flag(TDS_DBC *dbc, DSTR *s, ptrdiff_t size, const ODBC_CHAR * str, int flag);
659#define odbc_dstr_copy(dbc, s, len, out) \
660 odbc_dstr_copy_flag(dbc, s, len, sizeof((out)->mb) ? (out) : (out), wide)
661#define odbc_dstr_copy_oct(dbc, s, len, out) \
662 odbc_dstr_copy_flag(dbc, s, len, out, wide|0x20)
663#else
664 DSTR* odbc_dstr_copy(TDS_DBC *dbc, DSTR *s, ptrdiff_t size, const ODBC_CHAR * str);
665#define odbc_dstr_copy_oct odbc_dstr_copy
666#endif
667
668
669SQLRETURN odbc_set_string_flag(TDS_DBC *dbc, SQLPOINTER buffer, SQLINTEGER cbBuffer, void FAR * pcbBuffer,
670 const char *s, ptrdiff_t len, int flag);
671#ifdef ENABLE_ODBC_WIDE
672#define odbc_set_string(dbc, buf, buf_len, out_len, s, s_len) \
673 odbc_set_string_flag(dbc, sizeof((buf)->mb) ? (buf) : (buf), buf_len, out_len, s, s_len, \
674 (wide) | (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0:0x10))
675#define odbc_set_string_oct(dbc, buf, buf_len, out_len, s, s_len) \
676 odbc_set_string_flag(dbc, buf, buf_len, out_len, s, s_len, (wide) | (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0x20:0x30))
677#else
678#define odbc_set_string(dbc, buf, buf_len, out_len, s, s_len) \
679 odbc_set_string_flag(dbc, buf, buf_len, out_len, s, s_len, (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0:0x10))
680#define odbc_set_string_oct(dbc, buf, buf_len, out_len, s, s_len) \
681 odbc_set_string_flag(dbc, buf, buf_len, out_len, s, s_len, (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0x20:0x30))
682#endif
683
684#define odbc_set_dstr_oct(dbc, buf, buf_len, out_len, s) \
685 odbc_set_string_oct(dbc, buf, buf_len, out_len, tds_dstr_cstr(s), tds_dstr_len(s))
686#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))
687
688SQLSMALLINT odbc_get_concise_sql_type(SQLSMALLINT type, SQLSMALLINT interval);
689SQLRETURN odbc_set_concise_sql_type(SQLSMALLINT concise_type, struct _drecord *drec, int check_only);
690SQLSMALLINT odbc_get_concise_c_type(SQLSMALLINT type, SQLSMALLINT interval);
691SQLRETURN odbc_set_concise_c_type(SQLSMALLINT concise_type, struct _drecord *drec, int check_only);
692
693SQLLEN odbc_get_octet_len(int c_type, const struct _drecord *drec);
694void odbc_convert_err_set(struct _sql_errors *errs, TDS_INT err);
695
696/*
697 * prepare_query.c
698 */
699SQLRETURN prepare_call(struct _hstmt *stmt);
700SQLRETURN native_sql(struct _hdbc *dbc, DSTR *s);
701int parse_prepared_query(struct _hstmt *stmt, bool compute_row);
702int start_parse_prepared_query(struct _hstmt *stmt, bool compute_row);
703int continue_parse_prepared_query(struct _hstmt *stmt, SQLPOINTER DataPtr, SQLLEN StrLen_or_Ind);
704const char *parse_const_param(const char * s, TDS_SERVER_TYPE *type);
705const char *odbc_skip_rpc_name(const char *s);
706
707/*
708 * sql2tds.c
709 */
710SQLRETURN odbc_sql2tds(TDS_STMT * stmt, const struct _drecord *drec_ixd, const struct _drecord *drec_axd, TDSCOLUMN *curcol,
711 bool compute_row, const TDS_DESC* axd, SQLSETPOSIROW n_row);
712TDS_INT convert_datetime2server(int bindtype, const void *src, TDS_DATETIMEALL * dta);
713
714/*
715 * bcp.c
716 */
717void odbc_bcp_free_storage(TDS_DBC *dbc);
718void odbc_bcp_init(TDS_DBC *dbc, const ODBC_CHAR *tblname, const ODBC_CHAR *hfile, const ODBC_CHAR *errfile, int direction _WIDE);
719void odbc_bcp_control(TDS_DBC *dbc, int field, void *value);
720void odbc_bcp_colptr(TDS_DBC *dbc, const void * colptr, int table_column);
721void odbc_bcp_sendrow(TDS_DBC *dbc);
722int odbc_bcp_batch(TDS_DBC *dbc);
723int odbc_bcp_done(TDS_DBC *dbc);
724void odbc_bcp_bind(TDS_DBC *dbc, const void * varaddr, int prefixlen, int varlen, const void * terminator, int termlen,
725 int vartype, int table_column);
726
727/*
728 * sqlwchar.c
729 */
730#if SIZEOF_SQLWCHAR != SIZEOF_WCHAR_T
731size_t sqlwcslen(const SQLWCHAR * s);
732
733typedef struct sqlwstr_buf {
734 struct sqlwstr_buf *next;
735 wchar_t buf[256];
736} SQLWSTRBUF;
737const wchar_t *sqlwstr(const SQLWCHAR * s, SQLWSTRBUF **bufs);
738void sqlwstr_free(SQLWSTRBUF *bufs);
739#define SQLWSTR_BUFS(n) SQLWSTRBUF *bufs = NULL
740#define SQLWSTR(s) sqlwstr(s, &bufs)
741#define SQLWSTR_FREE() sqlwstr_free(bufs)
742#else
743#define sqlwcslen(s) wcslen(s)
744
745#define SQLWSTR_BUFS(n) do {} while(0)
746#define SQLWSTR(s) ((const wchar_t*)(s))
747#define SQLWSTR_FREE() do {} while(0)
748#endif
749
750int odbc_get_wide_canonic(TDSCONNECTION *conn);
751
752/* compatibility with old BCP implementation */
753#define BCPHINTS_OLD 6
754#define SQL_COPT_TDSODBC_IMPL_BCP_CONTROL_OLD (SQL_COPT_TDSODBC_IMPL_BASE+1)
755
756/* iODBC extensions used by our driver */
757#ifndef SQL_ATTR_DRIVER_UNICODE_TYPE
758#define SQL_ATTR_DRIVER_UNICODE_TYPE 1065
759#endif
760
761#ifndef SQL_DM_CP_UTF16
762#define SQL_DM_CP_UTF16 1
763#endif
764#ifndef SQL_DM_CP_UTF8
765#define SQL_DM_CP_UTF8 2
766#endif
767#ifndef SQL_DM_CP_UCS4
768#define SQL_DM_CP_UCS4 3
769#endif
770
771#include <freetds/popvis.h>
772
773#ifdef __cplusplus
774#if 0
775{
776#endif
777}
778#endif
779
780#endif
tds.h
Main include file for libtds.
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:988
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:1115
odbc_set_string_flag
SQLRETURN odbc_set_string_flag(TDS_DBC *dbc, 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
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:605
odbc_get_param_len
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:870
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:861
tdsiconvinfo
Definition iconv.h:92
_sql_error
Definition odbc.h:92
_sql_errors
Definition odbc.h:105
_dheader
Descriptor header.
Definition odbc.h:151
_drecord
Descriptor record.
Definition odbc.h:164
_hdesc
Definition odbc.h:205
_hdesc::focus
int focus
Nested descriptor to use.
Definition odbc.h:216
_heattr
Definition odbc.h:230
_hchk
Definition odbc.h:238
_henv
Definition odbc.h:245
_hcattr
Definition odbc.h:254
_hdbc
Definition odbc.h:283
_hdbc::stmt_list
struct _hstmt * stmt_list
list of all statements allocated from this connection
Definition odbc.h:303
_hdbc::uad
TDS_DESC * uad[TDS_MAX_APP_DESC]
descriptors associated to connection
Definition odbc.h:306
_hdbc::current_statement
struct _hstmt * current_statement
Statement executing.
Definition odbc.h:301
_hdbc::cursor_support
unsigned int cursor_support
<>0 if server handle cursors
Definition odbc.h:308
_hsattr
Definition odbc.h:316
_hstmt
Definition odbc.h:389
_hstmt::param_count
unsigned int param_count
number of parameter in current query
Definition odbc.h:428
_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's normal
Definition odbc.h:433
_hstmt::prepared_pos
size_t prepared_pos
position in prepared query to check parameters, used only in RPC
Definition odbc.h:423
_hstmt::row_count
TDS_INT8 row_count
row count to return
Definition odbc.h:431
_hstmt::param_num
int param_num
last valid parameter in params, it's a ODBC index (from 1 relative to descriptor)
Definition odbc.h:421
_hstmt::query
DSTR query
query to execute
Definition odbc.h:395
_hstmt::need_reprepare
unsigned need_reprepare
Prepared statement needs to be prepared again.
Definition odbc.h:412
_hstmt::next
struct _hstmt * next
next in list
Definition odbc.h:400
_hstmt::tds
TDSSOCKET * tds
socket (only if active)
Definition odbc.h:397
_hstmt::prev
struct _hstmt * prev
previous in list
Definition odbc.h:402
_hstmt::params
TDSPARAMINFO * params
parameters saved
Definition odbc.h:419
TDS_FUNCS
Definition odbc.h:451
TDS_PARSED_PARAM
Definition odbc.h:547
SQLTVP
Definition odbc.h:578
TDS_DATETIMEALL
This structure is not directly connected to TDS protocol but keeps any DATE/TIME information.
Definition tds.h:145
tds_login
Definition tds.h:498
tds_column_funcs
Definition tds.h:628
tds_column
Metadata about columns in regular and compute rows.
Definition tds.h:674
tds_result_info
Hold information for any results.
Definition tds.h:754
tds_cursor
Holds information about a cursor.
Definition tds.h:922
tds_dynamic
Holds information for a dynamic (also called prepared) query.
Definition tds.h:962
tds_context
Definition tds.h:1015
tds_connection
Definition tds.h:1077
tds_socket
Information for a server connection.
Definition tds.h:1162
tds_bcpinfo
Definition tds.h:1681
tds_dstr
Structure to hold a string.
Definition string.h:36