24 #define TDS_DONT_DEFINE_DEFAULT_FUNCTIONS
26 #include <freetds/thread.h>
27 #include <freetds/data.h>
29 #if defined(UNIXODBC) || defined(_WIN32) || defined(TDS_NO_DM)
32 #if defined(UNIXODBC) || defined(_WIN32)
38 #ifdef HAVE_IODBCINST_H
39 #include <iodbcinst.h>
45 #define SQLULEN SQLUINTEGER
48 #define SQLLEN SQLINTEGER
52 #ifndef HAVE_SQLSETPOSIROW
53 #define SQLSETPOSIROW SQLUSMALLINT
56 #ifndef HAVE_SQLROWOFFSET
57 #define SQLROWOFFSET SQLLEN
60 #ifndef HAVE_SQLROWSETSIZE
61 #define SQLROWSETSIZE SQLULEN
64 #ifndef SQL_COPT_SS_BASE
65 #define SQL_COPT_SS_BASE 1200
68 #ifndef SQL_COPT_SS_MARS_ENABLED
69 #define SQL_COPT_SS_MARS_ENABLED (SQL_COPT_SS_BASE+24)
72 #define SQL_INFO_FREETDS_TDS_VERSION 1300
74 #ifndef SQL_MARS_ENABLED_NO
75 #define SQL_MARS_ENABLED_NO 0
78 #ifndef SQL_MARS_ENABLED_YES
79 #define SQL_MARS_ENABLED_YES 1
83 #define SQL_SS_TIME2 (-154)
86 #ifndef SQL_SS_TIMESTAMPOFFSET
87 #define SQL_SS_TIMESTAMPOFFSET (-155)
93 #ifndef SQL_C_SS_TIME2
94 #define SQL_C_SS_TIME2 (0x4000)
97 #ifndef SQL_C_SS_TIMESTAMPOFFSET
98 #define SQL_C_SS_TIMESTAMPOFFSET (0x4001)
101 #ifndef SQL_CA_SS_BASE
102 #define SQL_CA_SS_BASE 1200
105 #ifndef SQL_CA_SS_UDT_CATALOG_NAME
106 #define SQL_CA_SS_UDT_CATALOG_NAME (SQL_CA_SS_BASE+18)
109 #ifndef SQL_CA_SS_UDT_SCHEMA_NAME
110 #define SQL_CA_SS_UDT_SCHEMA_NAME (SQL_CA_SS_BASE+19)
113 #ifndef SQL_CA_SS_UDT_TYPE_NAME
114 #define SQL_CA_SS_UDT_TYPE_NAME (SQL_CA_SS_BASE+20)
117 #ifndef SQL_CA_SS_UDT_ASSEMBLY_TYPE_NAME
118 #define SQL_CA_SS_UDT_ASSEMBLY_TYPE_NAME (SQL_CA_SS_BASE+21)
121 #ifndef SQL_CA_SS_XML_SCHEMACOLLECTION_CATALOG_NAME
122 #define SQL_CA_SS_XML_SCHEMACOLLECTION_CATALOG_NAME (SQL_CA_SS_BASE+22)
125 #ifndef SQL_CA_SS_XML_SCHEMACOLLECTION_SCHEMA_NAME
126 #define SQL_CA_SS_XML_SCHEMACOLLECTION_SCHEMA_NAME (SQL_CA_SS_BASE+23)
129 #ifndef SQL_CA_SS_XML_SCHEMACOLLECTION_NAME
130 #define SQL_CA_SS_XML_SCHEMACOLLECTION_NAME (SQL_CA_SS_BASE+24)
143 #include <freetds/pushvis.h>
144 #if defined(__GNUC__) && __GNUC__ >= 4 && !defined(__MINGW32__)
145 #define ODBC_API SQL_API __attribute__((externally_visible))
147 #define ODBC_API SQL_API
150 #if (defined(_WIN32) || defined(__CYGWIN__)) && defined(__GNUC__)
151 # define ODBC_PUBLIC __attribute__((dllexport))
156 #define ODBC_MAX(a,b) ( (a) > (b) ? (a) : (b) )
157 #define ODBC_MIN(a,b) ( (a) < (b) ? (a) : (b) )
181 #if ENABLE_EXTRA_CHECKS
182 void odbc_check_struct_extra(
void *p);
184 static inline void odbc_check_struct_extra(
void *p) {}
187 #define ODBC_RETURN(handle, rc) \
188 do { odbc_check_struct_extra(handle); \
189 return handle->errs.lastrc = (rc); } while(0)
190 #define ODBC_RETURN_(handle) \
191 do { odbc_check_struct_extra(handle); \
192 return handle->errs.lastrc; } while(0)
194 #define ODBC_EXIT(handle, rc) \
195 do { SQLRETURN _odbc_rc = handle->errs.lastrc = (rc); \
196 odbc_check_struct_extra(handle); \
197 tds_mutex_unlock(&handle->mtx); \
198 return _odbc_rc; } while(0)
199 #define ODBC_EXIT_(handle) \
200 do { SQLRETURN _odbc_rc = handle->errs.lastrc; \
201 odbc_check_struct_extra(handle); \
202 tds_mutex_unlock(&handle->mtx); \
203 return _odbc_rc; } while(0)
210 void odbc_errs_add(
struct _sql_errors *errs,
const char *sqlstate,
const char *msg);
213 void odbc_errs_add_rdbms(
struct _sql_errors *errs, TDS_UINT native,
const char *sqlstate,
const char *msg,
int linenum,
214 int msgstate,
const char *server,
int row);
218 SQLSMALLINT sql_desc_alloc_type;
219 SQLINTEGER sql_desc_bind_type;
220 SQLULEN sql_desc_array_size;
222 SQLSMALLINT sql_desc_count;
223 SQLUSMALLINT *sql_desc_array_status_ptr;
224 SQLULEN *sql_desc_rows_processed_ptr;
225 SQLLEN *sql_desc_bind_offset_ptr;
230 SQLUINTEGER sql_desc_auto_unique_value;
231 DSTR sql_desc_base_column_name;
232 DSTR sql_desc_base_table_name;
233 SQLINTEGER sql_desc_case_sensitive;
234 DSTR sql_desc_catalog_name;
235 SQLSMALLINT sql_desc_concise_type;
236 SQLPOINTER sql_desc_data_ptr;
237 SQLSMALLINT sql_desc_datetime_interval_code;
238 SQLINTEGER sql_desc_datetime_interval_precision;
239 SQLLEN sql_desc_display_size;
240 SQLSMALLINT sql_desc_fixed_prec_scale;
241 SQLLEN *sql_desc_indicator_ptr;
243 SQLULEN sql_desc_length;
245 const char *sql_desc_literal_prefix;
247 const char *sql_desc_literal_suffix;
248 DSTR sql_desc_local_type_name;
250 SQLSMALLINT sql_desc_nullable;
251 SQLINTEGER sql_desc_num_prec_radix;
252 SQLLEN sql_desc_octet_length;
253 SQLLEN *sql_desc_octet_length_ptr;
254 SQLSMALLINT sql_desc_parameter_type;
255 SQLSMALLINT sql_desc_precision;
256 SQLSMALLINT sql_desc_rowver;
257 SQLSMALLINT sql_desc_scale;
258 DSTR sql_desc_schema_name;
259 SQLSMALLINT sql_desc_searchable;
260 DSTR sql_desc_table_name;
261 SQLSMALLINT sql_desc_type;
263 const char *sql_desc_type_name;
264 SQLSMALLINT sql_desc_unnamed;
265 SQLSMALLINT sql_desc_unsigned;
266 SQLSMALLINT sql_desc_updatable;
289 SQLUINTEGER connection_pooling;
290 SQLUINTEGER cp_match;
291 SQLINTEGER odbc_version;
292 SQLINTEGER output_nts;
313 SQLUINTEGER access_mode;
314 SQLUINTEGER async_enable;
315 SQLUINTEGER auto_ipd;
316 SQLUINTEGER autocommit;
317 SQLUINTEGER connection_dead;
318 SQLUINTEGER connection_timeout;
319 DSTR current_catalog;
320 SQLUINTEGER login_timeout;
321 SQLUINTEGER metadata_id;
322 SQLUINTEGER odbc_cursors;
323 SQLUINTEGER packet_size;
326 SQLUINTEGER translate_option;
327 SQLUINTEGER txn_isolation;
328 SQLUINTEGER mars_enabled;
329 SQLUINTEGER cursor_type;
336 #define TDS_MAX_APP_DESC 100
348 #ifdef ENABLE_ODBC_WIDE
349 DSTR original_charset;
366 TDS_INT default_query_timeout;
374 SQLUINTEGER async_enable;
375 SQLUINTEGER concurrency;
376 SQLUINTEGER cursor_scrollable;
377 SQLUINTEGER cursor_sensitivity;
378 SQLUINTEGER cursor_type;
379 SQLUINTEGER enable_auto_ipd;
380 SQLPOINTER fetch_bookmark_ptr;
384 SQLUINTEGER metadata_id;
398 SQLUINTEGER query_timeout;
399 SQLUINTEGER retrieve_data;
413 SQLUINTEGER simulate_cursor;
414 SQLUINTEGER use_bookmarks;
420 SQLUINTEGER qn_timeout;
430 } TDS_ODBC_ROW_STATUS;
434 ODBC_SPECIAL_NONE = 0,
435 ODBC_SPECIAL_GETTYPEINFO = 1,
436 ODBC_SPECIAL_COLUMNS = 2,
437 ODBC_SPECIAL_PROCEDURECOLUMNS = 3,
438 ODBC_SPECIAL_SPECIALCOLUMNS = 4
439 } TDS_ODBC_SPECIAL_ROWS;
458 char *prepared_query;
459 unsigned prepared_query_is_func:1;
460 unsigned prepared_query_is_rpc:1;
461 unsigned need_reprepare:1;
462 unsigned param_data_called:1;
472 unsigned int curr_param_row, num_param_rows;
485 SQLULEN sql_rowset_size;
488 TDS_ODBC_SPECIAL_ROWS special_row;
501 SQLSMALLINT (*server_to_sql_type)(
TDSCOLUMN *col);
502 void (*set_type_info)(
TDSCOLUMN *col,
struct _drecord *drec, SQLINTEGER odbc_ver);
505 #define IS_HENV(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_ENV)
506 #define IS_HDBC(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_DBC)
507 #define IS_HSTMT(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_STMT)
508 #define IS_HDESC(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_DESC)
512 #if SQL_INTERVAL_YEAR == (100 + SQL_CODE_SECOND)
514 #undef SQL_INTERVAL_YEAR
515 #undef SQL_INTERVAL_MONTH
516 #undef SQL_INTERVAL_DAY
517 #undef SQL_INTERVAL_HOUR
518 #undef SQL_INTERVAL_MINUTE
519 #undef SQL_INTERVAL_SECOND
520 #undef SQL_INTERVAL_YEAR_TO_MONTH
521 #undef SQL_INTERVAL_DAY_TO_HOUR
522 #undef SQL_INTERVAL_DAY_TO_MINUTE
523 #undef SQL_INTERVAL_DAY_TO_SECOND
524 #undef SQL_INTERVAL_HOUR_TO_MINUTE
525 #undef SQL_INTERVAL_HOUR_TO_SECOND
526 #undef SQL_INTERVAL_MINUTE_TO_SECOND
528 #define SQL_INTERVAL_YEAR (100 + SQL_CODE_YEAR)
529 #define SQL_INTERVAL_MONTH (100 + SQL_CODE_MONTH)
530 #define SQL_INTERVAL_DAY (100 + SQL_CODE_DAY)
531 #define SQL_INTERVAL_HOUR (100 + SQL_CODE_HOUR)
532 #define SQL_INTERVAL_MINUTE (100 + SQL_CODE_MINUTE)
533 #define SQL_INTERVAL_SECOND (100 + SQL_CODE_SECOND)
534 #define SQL_INTERVAL_YEAR_TO_MONTH (100 + SQL_CODE_YEAR_TO_MONTH)
535 #define SQL_INTERVAL_DAY_TO_HOUR (100 + SQL_CODE_DAY_TO_HOUR)
536 #define SQL_INTERVAL_DAY_TO_MINUTE (100 + SQL_CODE_DAY_TO_MINUTE)
537 #define SQL_INTERVAL_DAY_TO_SECOND (100 + SQL_CODE_DAY_TO_SECOND)
538 #define SQL_INTERVAL_HOUR_TO_MINUTE (100 + SQL_CODE_HOUR_TO_MINUTE)
539 #define SQL_INTERVAL_HOUR_TO_SECOND (100 + SQL_CODE_HOUR_TO_SECOND)
540 #define SQL_INTERVAL_MINUTE_TO_SECOND (100 + SQL_CODE_MINUTE_TO_SECOND)
546 BOOL get_login_info(HWND hwndParent,
TDSLOGIN * login);
549 #define ODBC_PARAM_LIST \
550 ODBC_PARAM(Servername) \
555 ODBC_PARAM(Address) \
557 ODBC_PARAM(TDS_Version) \
558 ODBC_PARAM(Language) \
559 ODBC_PARAM(Database) \
560 ODBC_PARAM(TextSize) \
561 ODBC_PARAM(PacketSize) \
562 ODBC_PARAM(ClientCharset) \
563 ODBC_PARAM(DumpFile) \
564 ODBC_PARAM(DumpFileAppend) \
565 ODBC_PARAM(DebugFlags) \
566 ODBC_PARAM(Encryption) \
567 ODBC_PARAM(Trusted_Connection) \
570 ODBC_PARAM(UseNTLMv2) \
571 ODBC_PARAM(MARS_Connection) \
573 ODBC_PARAM(ServerSPN)
575 #define ODBC_PARAM(p) ODBC_PARAM_##p,
599 int odbc_parse_connect_string(
TDS_ERRS *errs,
const char *connect_string,
const char *connect_string_end,
TDSLOGIN * login,
TDS_PARSED_PARAM *parsed_params);
608 SQLLEN odbc_tds2sql(
TDS_STMT * stmt,
TDSCOLUMN *curcol,
int srctype, TDS_CHAR * src, TDS_UINT srclen,
int desttype, TDS_CHAR * dest, SQLULEN destlen,
const struct _drecord *drec_ixd);
613 TDS_DESC *desc_alloc(SQLHANDLE parent,
int desc_type,
int alloc_type);
614 SQLRETURN desc_free(
TDS_DESC * desc);
615 SQLRETURN desc_alloc_records(
TDS_DESC * desc,
unsigned count);
617 SQLRETURN desc_free_records(
TDS_DESC * desc);
623 SQLRETURN _SQLRowCount(SQLHSTMT hstmt, SQLLEN FAR * pcrow);
628 #if ENABLE_EXTRA_CHECKS
630 #define CHECK_ENV_EXTRA(env) odbc_check_env_extra(env)
631 #define CHECK_DBC_EXTRA(dbc) odbc_check_dbc_extra(dbc)
632 #define CHECK_STMT_EXTRA(stmt) odbc_check_stmt_extra(stmt)
633 #define CHECK_DESC_EXTRA(desc) odbc_check_desc_extra(desc)
635 void odbc_check_env_extra(
TDS_ENV * env);
636 void odbc_check_dbc_extra(
TDS_DBC * dbc);
637 void odbc_check_stmt_extra(
TDS_STMT * stmt);
638 void odbc_check_desc_extra(
TDS_DESC * desc);
641 #define CHECK_ENV_EXTRA(env)
642 #define CHECK_DBC_EXTRA(dbc)
643 #define CHECK_STMT_EXTRA(stmt)
644 #define CHECK_DESC_EXTRA(desc)
654 #ifdef ENABLE_ODBC_WIDE
661 # define _WIDE ,int wide
666 # define ODBC_CHAR SQLCHAR
668 int odbc_set_stmt_query(
struct _hstmt *stmt,
const ODBC_CHAR *sql,
int sql_len _WIDE);
669 int odbc_set_stmt_prepared_query(
struct _hstmt *stmt,
const ODBC_CHAR *sql,
int sql_len _WIDE);
670 void odbc_set_return_status(
struct _hstmt *stmt,
unsigned int n_row);
671 void odbc_set_return_params(
struct _hstmt *stmt,
unsigned int n_row);
676 static inline SQLSMALLINT
679 return ((
TDS_FUNCS *) col->funcs)->server_to_sql_type(col);
683 odbc_set_sql_type_info(
TDSCOLUMN * col,
struct _drecord *drec, SQLINTEGER odbc_ver)
685 ((
TDS_FUNCS *) col->funcs)->set_type_info(col, drec, odbc_ver);
688 int odbc_sql_to_c_type_default(
int sql_type);
689 int odbc_sql_to_server_type(
TDSCONNECTION * conn,
int sql_type,
int sql_unsigned);
692 SQLINTEGER odbc_sql_to_displaysize(
int sqltype,
TDSCOLUMN *col);
693 int odbc_get_string_size(
int size, ODBC_CHAR * str _WIDE);
697 #ifdef ENABLE_ODBC_WIDE
698 DSTR* odbc_dstr_copy_flag(
TDS_DBC *dbc,
DSTR *s,
int size, ODBC_CHAR * str,
int flag);
699 #define odbc_dstr_copy(dbc, s, len, out) \
700 odbc_dstr_copy_flag(dbc, s, len, sizeof((out)->mb) ? (out) : (out), wide)
701 #define odbc_dstr_copy_oct(dbc, s, len, out) \
702 odbc_dstr_copy_flag(dbc, s, len, out, wide|0x20)
704 DSTR* odbc_dstr_copy(
TDS_DBC *dbc,
DSTR *s,
int size, ODBC_CHAR * str);
705 #define odbc_dstr_copy_oct odbc_dstr_copy
709 SQLRETURN
odbc_set_string_flag(
TDS_DBC *dbc, SQLPOINTER buffer, SQLINTEGER cbBuffer,
void FAR * pcbBuffer,
const char *s,
int len,
int flag);
710 #ifdef ENABLE_ODBC_WIDE
711 #define odbc_set_string(dbc, buf, buf_len, out_len, s, s_len) \
712 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))
713 #define odbc_set_string_oct(dbc, buf, buf_len, out_len, s, s_len) \
714 odbc_set_string_flag(dbc, buf, buf_len, out_len, s, s_len, (wide) | (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0x20:0x30))
716 #define odbc_set_string(dbc, buf, buf_len, out_len, s, s_len) \
717 odbc_set_string_flag(dbc, buf, buf_len, out_len, s, s_len, (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0:0x10))
718 #define odbc_set_string_oct(dbc, buf, buf_len, out_len, s, s_len) \
719 odbc_set_string_flag(dbc, buf, buf_len, out_len, s, s_len, (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0x20:0x30))
722 SQLSMALLINT odbc_get_concise_sql_type(SQLSMALLINT type, SQLSMALLINT interval);
724 SQLSMALLINT odbc_get_concise_c_type(SQLSMALLINT type, SQLSMALLINT interval);
727 SQLLEN odbc_get_octet_len(
int c_type,
const struct _drecord *drec);
728 void odbc_convert_err_set(
struct _sql_errors *errs, TDS_INT err);
733 SQLRETURN prepare_call(
struct _hstmt *stmt);
734 SQLRETURN native_sql(
struct _hdbc *dbc,
char *s);
735 int parse_prepared_query(
struct _hstmt *stmt,
int compute_row);
736 int start_parse_prepared_query(
struct _hstmt *stmt,
int compute_row);
737 int continue_parse_prepared_query(
struct _hstmt *stmt, SQLPOINTER DataPtr, SQLLEN StrLen_or_Ind);
738 const char *parse_const_param(
const char * s, TDS_SERVER_TYPE *type);
748 #if SIZEOF_SQLWCHAR != SIZEOF_WCHAR_T
749 size_t sqlwcslen(
const SQLWCHAR * s);
751 typedef struct sqlwstr_buf {
752 struct sqlwstr_buf *next;
755 const wchar_t *sqlwstr(
const SQLWCHAR * s, SQLWSTRBUF **bufs);
756 void sqlwstr_free(SQLWSTRBUF *bufs);
757 #define SQLWSTR_BUFS(n) SQLWSTRBUF *bufs = NULL
758 #define SQLWSTR(s) sqlwstr(s, &bufs)
759 #define SQLWSTR_FREE() sqlwstr_free(bufs)
761 #define sqlwcslen(s) wcslen(s)
763 #define SQLWSTR_BUFS(n) do {} while(0)
764 #define SQLWSTR(s) ((const wchar_t*)(s))
765 #define SQLWSTR_FREE() do {} while(0)
768 #if SIZEOF_SQLWCHAR == 2
770 # define ODBC_WIDE_NAME "UCS-2BE"
771 # define ODBC_WIDE_NAME_UTF "UTF-16BE"
773 # define ODBC_WIDE_NAME "UCS-2LE"
774 # define ODBC_WIDE_NAME_UTF "UTF-16LE"
777 #elif SIZEOF_SQLWCHAR == 4
779 # define ODBC_WIDE_NAME "UCS-4BE"
781 # define ODBC_WIDE_NAME "UCS-4LE"
783 static inline const char *
786 return ODBC_WIDE_NAME;
789 #error SIZEOF_SQLWCHAR not supported !!
792 #include <freetds/popvis.h>
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:324
char * query
query to execute
Definition: odbc.h:448
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:480
TDS_DESC * uad[TDS_MAX_APP_DESC]
descriptors associated to connection
Definition: odbc.h:363
struct _hstmt * stmt_list
list of all statements allocated from this connection
Definition: odbc.h:360
Information for a server connection.
Definition: tds.h:1098
int param_num
last valid parameter in params, it's a ODBC index (from 1 relative to descriptor) ...
Definition: odbc.h:468
Main include file for libtds.
TDSSOCKET * tds
socket (only if active)
Definition: odbc.h:450
Structure to hold a string.
Definition: tds.h:93
struct _hstmt * current_statement
Statement executing.
Definition: odbc.h:358
char * prepared_pos
position in prepared query to check parameters, used only in RPC
Definition: odbc.h:470
unsigned int cursor_support
<>0 if server handle cursors
Definition: odbc.h:365
void odbc_rdbms_version(TDSSOCKET *tds_socket, char *pversion_string)
Returns the version of the RDBMS in the ODBC format.
Definition: odbc_util.c:961
Hold information for any results.
Definition: tds.h:739
Metadata about columns in regular and compute rows.
Definition: tds.h:662
struct _hstmt * next
next in list
Definition: odbc.h:453
struct _hstmt * prev
previous in list
Definition: odbc.h:455
Holds informations about a cursor.
Definition: tds.h:907
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:1081
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:1203
unsigned int param_count
number of parameter in current query
Definition: odbc.h:475
TDSPARAMINFO * params
parameters saved
Definition: odbc.h:466
TDS_INT8 row_count
row count to return
Definition: odbc.h:478
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:970
int 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:645
Holds information for a dynamic (also called prepared) query.
Definition: tds.h:944