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> 49 #define SQLULEN SQLUINTEGER 52 #define SQLLEN SQLINTEGER 56 #ifndef HAVE_SQLSETPOSIROW 57 #define SQLSETPOSIROW SQLUSMALLINT 60 #ifndef HAVE_SQLROWOFFSET 61 #define SQLROWOFFSET SQLLEN 64 #ifndef HAVE_SQLROWSETSIZE 65 #define SQLROWSETSIZE SQLULEN 76 #include <freetds/pushvis.h> 77 #if defined(__GNUC__) && __GNUC__ >= 4 && !defined(__MINGW32__) 78 #define ODBC_API SQL_API __attribute__((externally_visible)) 80 #define ODBC_API SQL_API 83 #if (defined(_WIN32) || defined(__CYGWIN__)) && defined(__GNUC__) 84 # define ODBC_PUBLIC __attribute__((dllexport)) 89 #define ODBC_MAX(a,b) ( (a) > (b) ? (a) : (b) ) 90 #define ODBC_MIN(a,b) ( (a) < (b) ? (a) : (b) ) 91 #define ODBC_CLAMP(x,a,b) ( (x) < (a) ? (a) : (x) > (b) ? (b) : (x) ) 115 #if ENABLE_EXTRA_CHECKS 116 void odbc_check_struct_extra(
void *p);
118 static inline void odbc_check_struct_extra(
void *p) {}
121 #define ODBC_RETURN(handle, rc) \ 122 do { odbc_check_struct_extra(handle); \ 123 return handle->errs.lastrc = (rc); } while(0) 124 #define ODBC_RETURN_(handle) \ 125 do { odbc_check_struct_extra(handle); \ 126 return handle->errs.lastrc; } while(0) 128 #define ODBC_EXIT(handle, rc) \ 129 do { SQLRETURN _odbc_rc = handle->errs.lastrc = (rc); \ 130 odbc_check_struct_extra(handle); \ 131 tds_mutex_unlock(&handle->mtx); \ 132 return _odbc_rc; } while(0) 133 #define ODBC_EXIT_(handle) \ 134 do { SQLRETURN _odbc_rc = handle->errs.lastrc; \ 135 odbc_check_struct_extra(handle); \ 136 tds_mutex_unlock(&handle->mtx); \ 137 return _odbc_rc; } while(0) 144 void odbc_errs_add(
struct _sql_errors *errs,
const char *sqlstate,
const char *msg);
147 void odbc_errs_add_rdbms(
struct _sql_errors *errs, TDS_UINT native,
const char *sqlstate,
const char *msg,
int linenum,
148 int msgstate,
const char *server,
int row);
152 SQLSMALLINT sql_desc_alloc_type;
153 SQLINTEGER sql_desc_bind_type;
154 SQLULEN sql_desc_array_size;
156 SQLSMALLINT sql_desc_count;
157 SQLUSMALLINT *sql_desc_array_status_ptr;
158 SQLULEN *sql_desc_rows_processed_ptr;
159 SQLLEN *sql_desc_bind_offset_ptr;
164 SQLUINTEGER sql_desc_auto_unique_value;
165 DSTR sql_desc_base_column_name;
166 DSTR sql_desc_base_table_name;
167 SQLINTEGER sql_desc_case_sensitive;
168 DSTR sql_desc_catalog_name;
169 SQLSMALLINT sql_desc_concise_type;
170 SQLPOINTER sql_desc_data_ptr;
171 SQLSMALLINT sql_desc_datetime_interval_code;
172 SQLINTEGER sql_desc_datetime_interval_precision;
173 SQLLEN sql_desc_display_size;
174 SQLSMALLINT sql_desc_fixed_prec_scale;
175 SQLLEN *sql_desc_indicator_ptr;
177 SQLULEN sql_desc_length;
179 const char *sql_desc_literal_prefix;
181 const char *sql_desc_literal_suffix;
182 DSTR sql_desc_local_type_name;
184 SQLSMALLINT sql_desc_nullable;
185 SQLINTEGER sql_desc_num_prec_radix;
186 SQLLEN sql_desc_octet_length;
187 SQLLEN *sql_desc_octet_length_ptr;
188 SQLSMALLINT sql_desc_parameter_type;
189 SQLSMALLINT sql_desc_precision;
190 SQLSMALLINT sql_desc_rowver;
191 SQLSMALLINT sql_desc_scale;
192 DSTR sql_desc_schema_name;
193 SQLSMALLINT sql_desc_searchable;
194 DSTR sql_desc_table_name;
195 SQLSMALLINT sql_desc_type;
197 const char *sql_desc_type_name;
198 SQLSMALLINT sql_desc_unnamed;
199 SQLSMALLINT sql_desc_unsigned;
200 SQLSMALLINT sql_desc_updatable;
214 typedef struct _hdesc TDS_DESC;
223 SQLUINTEGER connection_pooling;
224 SQLUINTEGER cp_match;
225 SQLINTEGER odbc_version;
226 SQLINTEGER output_nts;
247 SQLUINTEGER access_mode;
248 SQLUINTEGER async_enable;
249 SQLUINTEGER auto_ipd;
250 SQLUINTEGER autocommit;
251 SQLUINTEGER connection_dead;
252 SQLUINTEGER connection_timeout;
253 DSTR current_catalog;
254 SQLUINTEGER login_timeout;
255 SQLUINTEGER metadata_id;
256 SQLUINTEGER odbc_cursors;
257 SQLUINTEGER packet_size;
260 SQLUINTEGER translate_option;
261 SQLUINTEGER txn_isolation;
262 SQLUINTEGER mars_enabled;
263 SQLUINTEGER cursor_type;
264 SQLUINTEGER bulk_enabled;
271 #define TDS_MAX_APP_DESC 100 283 #ifdef ENABLE_ODBC_WIDE 284 DSTR original_charset;
298 TDS_DESC *uad[TDS_MAX_APP_DESC];
300 unsigned int cursor_support:1;
301 unsigned int use_oldpwd:1;
302 TDS_INT default_query_timeout;
313 SQLUINTEGER async_enable;
314 SQLUINTEGER concurrency;
315 SQLUINTEGER cursor_scrollable;
316 SQLUINTEGER cursor_sensitivity;
317 SQLUINTEGER cursor_type;
318 SQLUINTEGER enable_auto_ipd;
319 SQLPOINTER fetch_bookmark_ptr;
323 SQLUINTEGER metadata_id;
337 SQLUINTEGER query_timeout;
338 SQLUINTEGER retrieve_data;
352 SQLUINTEGER simulate_cursor;
353 SQLUINTEGER use_bookmarks;
359 SQLUINTEGER qn_timeout;
369 } TDS_ODBC_ROW_STATUS;
373 ODBC_SPECIAL_NONE = 0,
374 ODBC_SPECIAL_GETTYPEINFO = 1,
375 ODBC_SPECIAL_COLUMNS = 2,
376 ODBC_SPECIAL_PROCEDURECOLUMNS = 3,
377 ODBC_SPECIAL_SPECIALCOLUMNS = 4
378 } TDS_ODBC_SPECIAL_ROWS;
397 unsigned is_prepared_query:1;
398 unsigned prepared_query_is_func:1;
399 unsigned prepared_query_is_rpc:1;
405 unsigned param_data_called:1;
415 unsigned int curr_param_row, num_param_rows;
426 TDS_DESC *ard, *ird, *apd, *ipd;
427 TDS_DESC *orig_ard, *orig_apd;
428 SQLULEN sql_rowset_size;
431 TDS_ODBC_SPECIAL_ROWS special_row;
444 void (*set_type_info)(
TDSCOLUMN *col,
struct _drecord *drec, SQLINTEGER odbc_ver);
447 #define IS_HENV(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_ENV) 448 #define IS_HDBC(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_DBC) 449 #define IS_HSTMT(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_STMT) 450 #define IS_HDESC(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_DESC) 454 #if SQL_INTERVAL_YEAR == (100 + SQL_CODE_SECOND) 456 #undef SQL_INTERVAL_YEAR 457 #undef SQL_INTERVAL_MONTH 458 #undef SQL_INTERVAL_DAY 459 #undef SQL_INTERVAL_HOUR 460 #undef SQL_INTERVAL_MINUTE 461 #undef SQL_INTERVAL_SECOND 462 #undef SQL_INTERVAL_YEAR_TO_MONTH 463 #undef SQL_INTERVAL_DAY_TO_HOUR 464 #undef SQL_INTERVAL_DAY_TO_MINUTE 465 #undef SQL_INTERVAL_DAY_TO_SECOND 466 #undef SQL_INTERVAL_HOUR_TO_MINUTE 467 #undef SQL_INTERVAL_HOUR_TO_SECOND 468 #undef SQL_INTERVAL_MINUTE_TO_SECOND 470 #define SQL_INTERVAL_YEAR (100 + SQL_CODE_YEAR) 471 #define SQL_INTERVAL_MONTH (100 + SQL_CODE_MONTH) 472 #define SQL_INTERVAL_DAY (100 + SQL_CODE_DAY) 473 #define SQL_INTERVAL_HOUR (100 + SQL_CODE_HOUR) 474 #define SQL_INTERVAL_MINUTE (100 + SQL_CODE_MINUTE) 475 #define SQL_INTERVAL_SECOND (100 + SQL_CODE_SECOND) 476 #define SQL_INTERVAL_YEAR_TO_MONTH (100 + SQL_CODE_YEAR_TO_MONTH) 477 #define SQL_INTERVAL_DAY_TO_HOUR (100 + SQL_CODE_DAY_TO_HOUR) 478 #define SQL_INTERVAL_DAY_TO_MINUTE (100 + SQL_CODE_DAY_TO_MINUTE) 479 #define SQL_INTERVAL_DAY_TO_SECOND (100 + SQL_CODE_DAY_TO_SECOND) 480 #define SQL_INTERVAL_HOUR_TO_MINUTE (100 + SQL_CODE_HOUR_TO_MINUTE) 481 #define SQL_INTERVAL_HOUR_TO_SECOND (100 + SQL_CODE_HOUR_TO_SECOND) 482 #define SQL_INTERVAL_MINUTE_TO_SECOND (100 + SQL_CODE_MINUTE_TO_SECOND) 488 bool get_login_info(HWND hwndParent,
TDSLOGIN * login);
491 #define ODBC_PARAM_LIST \ 492 ODBC_PARAM(Servername) \ 497 ODBC_PARAM(Address) \ 499 ODBC_PARAM(TDS_Version) \ 500 ODBC_PARAM(Language) \ 501 ODBC_PARAM(Database) \ 502 ODBC_PARAM(TextSize) \ 503 ODBC_PARAM(PacketSize) \ 504 ODBC_PARAM(ClientCharset) \ 505 ODBC_PARAM(DumpFile) \ 506 ODBC_PARAM(DumpFileAppend) \ 507 ODBC_PARAM(DebugFlags) \ 508 ODBC_PARAM(Encryption) \ 509 ODBC_PARAM(Trusted_Connection) \ 512 ODBC_PARAM(UseNTLMv2) \ 513 ODBC_PARAM(MARS_Connection) \ 515 ODBC_PARAM(ServerSPN) \ 516 ODBC_PARAM(AttachDbFilename) \ 517 ODBC_PARAM(ApplicationIntent) 519 #define ODBC_PARAM(p) ODBC_PARAM_##p, 543 int odbc_parse_connect_string(TDS_ERRS *errs,
const char *connect_string,
const char *connect_string_end,
TDSLOGIN * login,
TDS_PARSED_PARAM *parsed_params);
544 int odbc_get_dsn_info(TDS_ERRS *errs,
const char *DSN,
TDSLOGIN * login);
546 int odbc_build_connect_string(TDS_ERRS *errs,
TDS_PARSED_PARAM *params,
char **out);
552 SQLLEN odbc_tds2sql_col(
TDS_STMT * stmt,
TDSCOLUMN *curcol,
int desttype, TDS_CHAR * dest, SQLULEN destlen,
const struct _drecord *drec_ixd);
553 SQLLEN odbc_tds2sql_int4(
TDS_STMT * stmt, TDS_INT *src,
int desttype, TDS_CHAR * dest, SQLULEN destlen);
560 TDS_DESC *desc_alloc(SQLHANDLE parent,
int desc_type,
int alloc_type);
561 SQLRETURN desc_free(TDS_DESC * desc);
562 SQLRETURN desc_alloc_records(TDS_DESC * desc,
unsigned count);
563 SQLRETURN desc_copy(TDS_DESC * dest, TDS_DESC * src);
564 SQLRETURN desc_free_records(TDS_DESC * desc);
565 TDS_DBC *desc_get_dbc(TDS_DESC *desc);
570 SQLRETURN _SQLRowCount(SQLHSTMT hstmt, SQLLEN FAR * pcrow);
575 #if ENABLE_EXTRA_CHECKS 577 #define CHECK_ENV_EXTRA(env) odbc_check_env_extra(env) 578 #define CHECK_DBC_EXTRA(dbc) odbc_check_dbc_extra(dbc) 579 #define CHECK_STMT_EXTRA(stmt) odbc_check_stmt_extra(stmt) 580 #define CHECK_DESC_EXTRA(desc) odbc_check_desc_extra(desc) 582 void odbc_check_env_extra(
TDS_ENV * env);
583 void odbc_check_dbc_extra(
TDS_DBC * dbc);
584 void odbc_check_stmt_extra(
TDS_STMT * stmt);
585 void odbc_check_desc_extra(TDS_DESC * desc);
588 #define CHECK_ENV_EXTRA(env) 589 #define CHECK_DBC_EXTRA(dbc) 590 #define CHECK_STMT_EXTRA(stmt) 591 #define CHECK_DESC_EXTRA(desc) 601 #ifdef ENABLE_ODBC_WIDE 608 # define _WIDE ,int wide 613 # define ODBC_CHAR SQLCHAR 615 int odbc_set_stmt_query(
struct _hstmt *stmt,
const ODBC_CHAR *sql,
int sql_len _WIDE);
616 void odbc_set_return_status(
struct _hstmt *stmt,
unsigned int n_row);
617 void odbc_set_return_params(
struct _hstmt *stmt,
unsigned int n_row);
619 void odbc_set_sql_type_info(
TDSCOLUMN * col,
struct _drecord *drec, SQLINTEGER odbc_ver);
621 int odbc_sql_to_c_type_default(
int sql_type);
622 TDS_SERVER_TYPE odbc_sql_to_server_type(
TDSCONNECTION * conn,
int sql_type,
int sql_unsigned);
625 unsigned int odbc_get_string_size(
int size,
const ODBC_CHAR * str _WIDE);
629 #ifdef ENABLE_ODBC_WIDE 630 DSTR* odbc_dstr_copy_flag(
TDS_DBC *dbc,
DSTR *s,
int size,
const ODBC_CHAR * str,
int flag);
631 #define odbc_dstr_copy(dbc, s, len, out) \ 632 odbc_dstr_copy_flag(dbc, s, len, sizeof((out)->mb) ? (out) : (out), wide) 633 #define odbc_dstr_copy_oct(dbc, s, len, out) \ 634 odbc_dstr_copy_flag(dbc, s, len, out, wide|0x20) 636 DSTR* odbc_dstr_copy(
TDS_DBC *dbc,
DSTR *s,
int size,
const ODBC_CHAR * str);
637 #define odbc_dstr_copy_oct odbc_dstr_copy 641 SQLRETURN
odbc_set_string_flag(
TDS_DBC *dbc, SQLPOINTER buffer, SQLINTEGER cbBuffer,
void FAR * pcbBuffer,
const char *s,
int len,
int flag);
642 #ifdef ENABLE_ODBC_WIDE 643 #define odbc_set_string(dbc, buf, buf_len, out_len, s, s_len) \ 644 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)) 645 #define odbc_set_string_oct(dbc, buf, buf_len, out_len, s, s_len) \ 646 odbc_set_string_flag(dbc, buf, buf_len, out_len, s, s_len, (wide) | (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0x20:0x30)) 648 #define odbc_set_string(dbc, buf, buf_len, out_len, s, s_len) \ 649 odbc_set_string_flag(dbc, buf, buf_len, out_len, s, s_len, (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0:0x10)) 650 #define odbc_set_string_oct(dbc, buf, buf_len, out_len, s, s_len) \ 651 odbc_set_string_flag(dbc, buf, buf_len, out_len, s, s_len, (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0x20:0x30)) 654 #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)) 655 #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)) 657 SQLSMALLINT odbc_get_concise_sql_type(SQLSMALLINT type, SQLSMALLINT interval);
659 SQLSMALLINT odbc_get_concise_c_type(SQLSMALLINT type, SQLSMALLINT interval);
662 SQLLEN odbc_get_octet_len(
int c_type,
const struct _drecord *drec);
663 void odbc_convert_err_set(
struct _sql_errors *errs, TDS_INT err);
668 SQLRETURN prepare_call(
struct _hstmt *stmt);
669 SQLRETURN native_sql(
struct _hdbc *dbc,
DSTR *s);
670 int parse_prepared_query(
struct _hstmt *stmt,
bool compute_row);
671 int start_parse_prepared_query(
struct _hstmt *stmt,
bool compute_row);
672 int continue_parse_prepared_query(
struct _hstmt *stmt, SQLPOINTER DataPtr, SQLLEN StrLen_or_Ind);
673 const char *parse_const_param(
const char * s, TDS_SERVER_TYPE *type);
674 const char *odbc_skip_rpc_name(
const char *s);
679 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);
680 TDS_INT convert_datetime2server(
int bindtype,
const void *src,
TDS_DATETIMEALL * dta);
685 void odbc_bcp_free_storage(
TDS_DBC *dbc);
686 void odbc_bcp_init(
TDS_DBC *dbc,
const ODBC_CHAR *tblname,
const ODBC_CHAR *hfile,
const ODBC_CHAR *errfile,
int direction _WIDE);
687 void odbc_bcp_control(
TDS_DBC *dbc,
int field,
void *value);
688 void odbc_bcp_colptr(
TDS_DBC *dbc,
const void * colptr,
int table_column);
689 void odbc_bcp_sendrow(
TDS_DBC *dbc);
690 int odbc_bcp_batch(
TDS_DBC *dbc);
691 int odbc_bcp_done(
TDS_DBC *dbc);
692 void odbc_bcp_bind(
TDS_DBC *dbc,
const void * varaddr,
int prefixlen,
int varlen,
const void * terminator,
int termlen,
int vartype,
int table_column);
697 #if SIZEOF_SQLWCHAR != SIZEOF_WCHAR_T 698 size_t sqlwcslen(
const SQLWCHAR * s);
700 typedef struct sqlwstr_buf {
701 struct sqlwstr_buf *next;
704 const wchar_t *sqlwstr(
const SQLWCHAR * s, SQLWSTRBUF **bufs);
705 void sqlwstr_free(SQLWSTRBUF *bufs);
706 #define SQLWSTR_BUFS(n) SQLWSTRBUF *bufs = NULL 707 #define SQLWSTR(s) sqlwstr(s, &bufs) 708 #define SQLWSTR_FREE() sqlwstr_free(bufs) 710 #define sqlwcslen(s) wcslen(s) 712 #define SQLWSTR_BUFS(n) do {} while(0) 713 #define SQLWSTR(s) ((const wchar_t*)(s)) 714 #define SQLWSTR_FREE() do {} while(0) 717 #if SIZEOF_SQLWCHAR == 2 719 # define ODBC_WIDE_NAME "UCS-2BE" 720 # define ODBC_WIDE_NAME_UTF "UTF-16BE" 722 # define ODBC_WIDE_NAME "UCS-2LE" 723 # define ODBC_WIDE_NAME_UTF "UTF-16LE" 726 #elif SIZEOF_SQLWCHAR == 4 728 # define ODBC_WIDE_NAME "UCS-4BE" 730 # define ODBC_WIDE_NAME "UCS-4LE" 732 static inline const char *
735 return ODBC_WIDE_NAME;
738 #error SIZEOF_SQLWCHAR not supported !! 741 #include <freetds/popvis.h> 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
Information for a server connection.
Definition: tds.h:1141
struct _hstmt * current_statement
Statement executing.
Definition: odbc.h:293
TDSPARAMINFO * params
parameters saved
Definition: odbc.h:409
char * prepared_pos
position in prepared query to check parameters, used only in RPC
Definition: odbc.h:413
DSTR query
query to execute
Definition: odbc.h:387
Structure to hold a string.
Definition: string.h:36
Metadata about columns in regular and compute rows.
Definition: tds.h:690
struct _hstmt * stmt_list
list of all statements allocated from this connection
Definition: odbc.h:295
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
Hold information for any results.
Definition: tds.h:769
TDSSOCKET * tds
socket (only if active)
Definition: odbc.h:389
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
unsigned need_reprepare
Prepared statement needs to be prepared again.
Definition: odbc.h:404
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
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
TDS_INT8 row_count
row count to return
Definition: odbc.h:421
struct _hstmt * next
next in list
Definition: odbc.h:392
unsigned int param_count
number of parameter in current query
Definition: odbc.h:418
struct _hstmt * prev
previous in list
Definition: odbc.h:394
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
Holds informations about a cursor.
Definition: tds.h:937
int param_num
last valid parameter in params, it's a ODBC index (from 1 relative to descriptor) ...
Definition: odbc.h:411
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:423
Main include file for libtds.
this structure is not directed connected to a TDS protocol but keeps any DATE/TIME information...
Definition: tds.h:144
Holds information for a dynamic (also called prepared) query.
Definition: tds.h:977