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);
153 SQLSMALLINT sql_desc_alloc_type;
155 SQLSMALLINT sql_desc_count;
156 SQLINTEGER sql_desc_bind_type;
157 SQLULEN sql_desc_array_size;
158 SQLUSMALLINT *sql_desc_array_status_ptr;
159 SQLULEN *sql_desc_rows_processed_ptr;
160 SQLLEN *sql_desc_bind_offset_ptr;
166 DSTR sql_desc_base_column_name;
167 DSTR sql_desc_base_table_name;
168 SQLUINTEGER sql_desc_auto_unique_value;
169 SQLINTEGER sql_desc_case_sensitive;
170 DSTR sql_desc_catalog_name;
171 SQLPOINTER sql_desc_data_ptr;
172 SQLSMALLINT sql_desc_concise_type;
173 SQLSMALLINT sql_desc_datetime_interval_code;
174 SQLINTEGER sql_desc_datetime_interval_precision;
175 SQLLEN sql_desc_display_size;
176 SQLLEN *sql_desc_indicator_ptr;
178 SQLULEN sql_desc_length;
180 const char *sql_desc_literal_prefix;
182 const char *sql_desc_literal_suffix;
183 DSTR sql_desc_local_type_name;
185 SQLSMALLINT sql_desc_fixed_prec_scale;
186 SQLSMALLINT sql_desc_nullable;
187 SQLINTEGER sql_desc_num_prec_radix;
188 SQLLEN sql_desc_octet_length;
189 SQLLEN *sql_desc_octet_length_ptr;
190 SQLSMALLINT sql_desc_parameter_type;
191 SQLSMALLINT sql_desc_precision;
192 SQLSMALLINT sql_desc_rowver;
193 SQLSMALLINT sql_desc_scale;
194 DSTR sql_desc_schema_name;
195 DSTR sql_desc_table_name;
196 SQLSMALLINT sql_desc_searchable;
197 SQLSMALLINT sql_desc_type;
199 const char *sql_desc_type_name;
200 SQLSMALLINT sql_desc_unnamed;
201 SQLSMALLINT sql_desc_unsigned;
202 SQLSMALLINT sql_desc_updatable;
232 SQLUINTEGER connection_pooling;
233 SQLUINTEGER cp_match;
234 SQLINTEGER odbc_version;
235 SQLINTEGER output_nts;
256 SQLUINTEGER access_mode;
257 SQLUINTEGER async_enable;
258 SQLUINTEGER auto_ipd;
259 SQLUINTEGER autocommit;
260 SQLUINTEGER connection_dead;
261 SQLUINTEGER connection_timeout;
262 DSTR current_catalog;
263 SQLUINTEGER login_timeout;
264 SQLUINTEGER metadata_id;
265 SQLUINTEGER odbc_cursors;
266 SQLUINTEGER packet_size;
269 SQLUINTEGER translate_option;
270 SQLUINTEGER txn_isolation;
271 SQLUINTEGER mars_enabled;
272 SQLUINTEGER cursor_type;
273 SQLUINTEGER bulk_enabled;
280 #define TDS_MAX_APP_DESC 100
292 #ifdef ENABLE_ODBC_WIDE
293 int original_charset_num;
310 unsigned int use_oldpwd:1;
311 TDS_INT default_query_timeout;
321 SQLUINTEGER async_enable;
322 SQLUINTEGER concurrency;
323 SQLUINTEGER cursor_scrollable;
324 SQLUINTEGER cursor_sensitivity;
325 SQLUINTEGER cursor_type;
326 SQLUINTEGER enable_auto_ipd;
327 SQLPOINTER fetch_bookmark_ptr;
331 SQLUINTEGER metadata_id;
345 SQLUINTEGER query_timeout;
346 SQLUINTEGER retrieve_data;
360 SQLUINTEGER simulate_cursor;
361 SQLUINTEGER use_bookmarks;
367 SQLUINTEGER qn_timeout;
368 SQLUINTEGER param_focus;
378 } TDS_ODBC_ROW_STATUS;
382 ODBC_SPECIAL_NONE = 0,
383 ODBC_SPECIAL_GETTYPEINFO = 1,
384 ODBC_SPECIAL_COLUMNS = 2,
385 ODBC_SPECIAL_PROCEDURECOLUMNS = 3,
386 ODBC_SPECIAL_SPECIALCOLUMNS = 4
387 } TDS_ODBC_SPECIAL_ROWS;
406 unsigned is_prepared_query:1;
407 unsigned prepared_query_is_func:1;
408 unsigned prepared_query_is_rpc:1;
414 unsigned param_data_called:1;
424 unsigned int curr_param_row, num_param_rows;
437 SQLULEN sql_rowset_size;
440 TDS_ODBC_SPECIAL_ROWS special_row;
453 void (*set_type_info)(
TDSCOLUMN *col,
struct _drecord *drec, SQLINTEGER odbc_ver);
456 #define IS_HENV(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_ENV)
457 #define IS_HDBC(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_DBC)
458 #define IS_HSTMT(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_STMT)
459 #define IS_HDESC(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_DESC)
463 #if SQL_INTERVAL_YEAR == (100 + SQL_CODE_SECOND)
465 #undef SQL_INTERVAL_YEAR
466 #undef SQL_INTERVAL_MONTH
467 #undef SQL_INTERVAL_DAY
468 #undef SQL_INTERVAL_HOUR
469 #undef SQL_INTERVAL_MINUTE
470 #undef SQL_INTERVAL_SECOND
471 #undef SQL_INTERVAL_YEAR_TO_MONTH
472 #undef SQL_INTERVAL_DAY_TO_HOUR
473 #undef SQL_INTERVAL_DAY_TO_MINUTE
474 #undef SQL_INTERVAL_DAY_TO_SECOND
475 #undef SQL_INTERVAL_HOUR_TO_MINUTE
476 #undef SQL_INTERVAL_HOUR_TO_SECOND
477 #undef SQL_INTERVAL_MINUTE_TO_SECOND
479 #define SQL_INTERVAL_YEAR (100 + SQL_CODE_YEAR)
480 #define SQL_INTERVAL_MONTH (100 + SQL_CODE_MONTH)
481 #define SQL_INTERVAL_DAY (100 + SQL_CODE_DAY)
482 #define SQL_INTERVAL_HOUR (100 + SQL_CODE_HOUR)
483 #define SQL_INTERVAL_MINUTE (100 + SQL_CODE_MINUTE)
484 #define SQL_INTERVAL_SECOND (100 + SQL_CODE_SECOND)
485 #define SQL_INTERVAL_YEAR_TO_MONTH (100 + SQL_CODE_YEAR_TO_MONTH)
486 #define SQL_INTERVAL_DAY_TO_HOUR (100 + SQL_CODE_DAY_TO_HOUR)
487 #define SQL_INTERVAL_DAY_TO_MINUTE (100 + SQL_CODE_DAY_TO_MINUTE)
488 #define SQL_INTERVAL_DAY_TO_SECOND (100 + SQL_CODE_DAY_TO_SECOND)
489 #define SQL_INTERVAL_HOUR_TO_MINUTE (100 + SQL_CODE_HOUR_TO_MINUTE)
490 #define SQL_INTERVAL_HOUR_TO_SECOND (100 + SQL_CODE_HOUR_TO_SECOND)
491 #define SQL_INTERVAL_MINUTE_TO_SECOND (100 + SQL_CODE_MINUTE_TO_SECOND)
497 bool get_login_info(HWND hwndParent,
TDSLOGIN * login);
500 #define ODBC_PARAM_LIST \
501 ODBC_PARAM(Servername) \
506 ODBC_PARAM(Address) \
508 ODBC_PARAM(TDS_Version) \
509 ODBC_PARAM(Language) \
510 ODBC_PARAM(Database) \
511 ODBC_PARAM(TextSize) \
512 ODBC_PARAM(PacketSize) \
513 ODBC_PARAM(ClientCharset) \
514 ODBC_PARAM(DumpFile) \
515 ODBC_PARAM(DumpFileAppend) \
516 ODBC_PARAM(DebugFlags) \
517 ODBC_PARAM(Encryption) \
518 ODBC_PARAM(Trusted_Connection) \
521 ODBC_PARAM(UseNTLMv2) \
522 ODBC_PARAM(MARS_Connection) \
524 ODBC_PARAM(ServerSPN) \
525 ODBC_PARAM(AttachDbFilename) \
526 ODBC_PARAM(ApplicationIntent) \
529 #define ODBC_PARAM(p) ODBC_PARAM_##p,
553 bool odbc_parse_connect_string(
TDS_ERRS *errs,
const char *connect_string,
const char *connect_string_end,
TDSLOGIN * login,
TDS_PARSED_PARAM *parsed_params);
562 SQLLEN odbc_tds2sql_col(
TDS_STMT * stmt,
TDSCOLUMN *curcol,
int desttype, TDS_CHAR * dest, SQLULEN destlen,
const struct _drecord *drec_ixd);
563 SQLLEN odbc_tds2sql_int4(
TDS_STMT * stmt, TDS_INT *src,
int desttype, TDS_CHAR * dest, SQLULEN destlen);
576 TDS_DESC *desc_alloc(SQLHANDLE parent,
int desc_type, SQLSMALLINT alloc_type);
577 SQLRETURN desc_free(
TDS_DESC * desc);
578 SQLRETURN desc_alloc_records(
TDS_DESC * desc,
unsigned count);
580 SQLRETURN desc_free_records(
TDS_DESC * desc);
583 void tvp_free(
SQLTVP *tvp);
589 SQLRETURN _SQLRowCount(SQLHSTMT hstmt, SQLLEN FAR * pcrow);
594 #if ENABLE_EXTRA_CHECKS
596 #define CHECK_ENV_EXTRA(env) odbc_check_env_extra(env)
597 #define CHECK_DBC_EXTRA(dbc) odbc_check_dbc_extra(dbc)
598 #define CHECK_STMT_EXTRA(stmt) odbc_check_stmt_extra(stmt)
599 #define CHECK_DESC_EXTRA(desc) odbc_check_desc_extra(desc)
601 void odbc_check_env_extra(
TDS_ENV * env);
602 void odbc_check_dbc_extra(
TDS_DBC * dbc);
603 void odbc_check_stmt_extra(
TDS_STMT * stmt);
604 void odbc_check_desc_extra(
TDS_DESC * desc);
607 #define CHECK_ENV_EXTRA(env)
608 #define CHECK_DBC_EXTRA(dbc)
609 #define CHECK_STMT_EXTRA(stmt)
610 #define CHECK_DESC_EXTRA(desc)
620 #ifdef ENABLE_ODBC_WIDE
627 # define _WIDE ,int wide
632 # define ODBC_CHAR SQLCHAR
634 int odbc_set_stmt_query(
struct _hstmt *stmt,
const ODBC_CHAR *sql,
int sql_len _WIDE);
635 void odbc_set_return_status(
struct _hstmt *stmt,
unsigned int n_row);
636 void odbc_set_return_params(
struct _hstmt *stmt,
unsigned int n_row);
638 void odbc_set_sql_type_info(
TDSCOLUMN * col,
struct _drecord *drec, SQLINTEGER odbc_ver);
640 int odbc_sql_to_c_type_default(
int sql_type);
641 TDS_SERVER_TYPE odbc_sql_to_server_type(
TDSCONNECTION * conn,
int sql_type,
int sql_unsigned);
644 unsigned int odbc_get_string_size(
int size,
const ODBC_CHAR * str _WIDE);
648 #ifdef ENABLE_ODBC_WIDE
649 DSTR* odbc_dstr_copy_flag(
TDS_DBC *dbc,
DSTR *s,
int size,
const ODBC_CHAR * str,
int flag);
650 #define odbc_dstr_copy(dbc, s, len, out) \
651 odbc_dstr_copy_flag(dbc, s, len, sizeof((out)->mb) ? (out) : (out), wide)
652 #define odbc_dstr_copy_oct(dbc, s, len, out) \
653 odbc_dstr_copy_flag(dbc, s, len, out, wide|0x20)
655 DSTR* odbc_dstr_copy(
TDS_DBC *dbc,
DSTR *s,
int size,
const ODBC_CHAR * str);
656 #define odbc_dstr_copy_oct odbc_dstr_copy
660 SQLRETURN
odbc_set_string_flag(
TDS_DBC *dbc, SQLPOINTER buffer, SQLINTEGER cbBuffer,
void FAR * pcbBuffer,
const char *s,
int len,
int flag);
661 #ifdef ENABLE_ODBC_WIDE
662 #define odbc_set_string(dbc, buf, buf_len, out_len, s, s_len) \
663 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))
664 #define odbc_set_string_oct(dbc, buf, buf_len, out_len, s, s_len) \
665 odbc_set_string_flag(dbc, buf, buf_len, out_len, s, s_len, (wide) | (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0x20:0x30))
667 #define odbc_set_string(dbc, buf, buf_len, out_len, s, s_len) \
668 odbc_set_string_flag(dbc, buf, buf_len, out_len, s, s_len, (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0:0x10))
669 #define odbc_set_string_oct(dbc, buf, buf_len, out_len, s, s_len) \
670 odbc_set_string_flag(dbc, buf, buf_len, out_len, s, s_len, (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0x20:0x30))
673 #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))
674 #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))
676 SQLSMALLINT odbc_get_concise_sql_type(SQLSMALLINT type, SQLSMALLINT interval);
678 SQLSMALLINT odbc_get_concise_c_type(SQLSMALLINT type, SQLSMALLINT interval);
681 SQLLEN odbc_get_octet_len(
int c_type,
const struct _drecord *drec);
682 void odbc_convert_err_set(
struct _sql_errors *errs, TDS_INT err);
687 SQLRETURN prepare_call(
struct _hstmt *stmt);
688 SQLRETURN native_sql(
struct _hdbc *dbc,
DSTR *s);
689 int parse_prepared_query(
struct _hstmt *stmt,
bool compute_row);
690 int start_parse_prepared_query(
struct _hstmt *stmt,
bool compute_row);
691 int continue_parse_prepared_query(
struct _hstmt *stmt, SQLPOINTER DataPtr, SQLLEN StrLen_or_Ind);
692 const char *parse_const_param(
const char * s, TDS_SERVER_TYPE *type);
693 const char *odbc_skip_rpc_name(
const char *s);
699 TDS_INT convert_datetime2server(
int bindtype,
const void *src,
TDS_DATETIMEALL * dta);
704 void odbc_bcp_free_storage(
TDS_DBC *dbc);
705 void odbc_bcp_init(
TDS_DBC *dbc,
const ODBC_CHAR *tblname,
const ODBC_CHAR *hfile,
const ODBC_CHAR *errfile,
int direction _WIDE);
706 void odbc_bcp_control(
TDS_DBC *dbc,
int field,
void *value);
707 void odbc_bcp_colptr(
TDS_DBC *dbc,
const void * colptr,
int table_column);
708 void odbc_bcp_sendrow(
TDS_DBC *dbc);
709 int odbc_bcp_batch(
TDS_DBC *dbc);
710 int odbc_bcp_done(
TDS_DBC *dbc);
711 void odbc_bcp_bind(
TDS_DBC *dbc,
const void * varaddr,
int prefixlen,
int varlen,
const void * terminator,
int termlen,
int vartype,
int table_column);
716 #if SIZEOF_SQLWCHAR != SIZEOF_WCHAR_T
717 size_t sqlwcslen(
const SQLWCHAR * s);
719 typedef struct sqlwstr_buf {
720 struct sqlwstr_buf *next;
723 const wchar_t *sqlwstr(
const SQLWCHAR * s, SQLWSTRBUF **bufs);
724 void sqlwstr_free(SQLWSTRBUF *bufs);
725 #define SQLWSTR_BUFS(n) SQLWSTRBUF *bufs = NULL
726 #define SQLWSTR(s) sqlwstr(s, &bufs)
727 #define SQLWSTR_FREE() sqlwstr_free(bufs)
729 #define sqlwcslen(s) wcslen(s)
731 #define SQLWSTR_BUFS(n) do {} while(0)
732 #define SQLWSTR(s) ((const wchar_t*)(s))
733 #define SQLWSTR_FREE() do {} while(0)
738 #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:857
struct _hstmt * current_statement
Statement executing.
Definition: odbc.h:302
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:866
Holds informations about a cursor.
Definition: tds.h:940
Descriptor record.
Definition: odbc.h:164
Holds information for a dynamic (also called prepared) query.
Definition: tds.h:980
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:432
Hold information for any results.
Definition: tds.h:772
Main include file for libtds.
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:601
struct _hstmt * next
next in list
Definition: odbc.h:401
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:1111
TDSSOCKET * tds
socket (only if active)
Definition: odbc.h:398
int param_num
last valid parameter in params, it's a ODBC index (from 1 relative to descriptor) ...
Definition: odbc.h:420
int focus
Nested descriptor to use.
Definition: odbc.h:217
unsigned int param_count
number of parameter in current query
Definition: odbc.h:427
Descriptor header.
Definition: odbc.h:151
this structure is not directed connected to a TDS protocol but keeps any DATE/TIME information...
Definition: tds.h:144
size_t prepared_pos
position in prepared query to check parameters, used only in RPC
Definition: odbc.h:422
unsigned int cursor_support
<>0 if server handle cursors
Definition: odbc.h:309
TDS_DESC * uad[TDS_MAX_APP_DESC]
descriptors associated to connection
Definition: odbc.h:307
Structure to hold a string.
Definition: string.h:36
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:984
TDSPARAMINFO * params
parameters saved
Definition: odbc.h:418
struct _hstmt * prev
previous in list
Definition: odbc.h:403
struct _hstmt * stmt_list
list of all statements allocated from this connection
Definition: odbc.h:304
Information for a server connection.
Definition: tds.h:1179
unsigned need_reprepare
Prepared statement needs to be prepared again.
Definition: odbc.h:413
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:301
DSTR query
query to execute
Definition: odbc.h:396
TDS_INT8 row_count
row count to return
Definition: odbc.h:430
Metadata about columns in regular and compute rows.
Definition: tds.h:692