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
72 #include <freetds/pushvis.h>
73 #if defined(__GNUC__) && __GNUC__ >= 4 && !defined(__MINGW32__)
74 #define ODBC_API SQL_API __attribute__((externally_visible))
76 #define ODBC_API SQL_API
79 #if (defined(_WIN32) || defined(__CYGWIN__)) && defined(__GNUC__)
80 # define ODBC_PUBLIC __attribute__((dllexport))
85 #define ODBC_MAX(a,b) ( (a) > (b) ? (a) : (b) )
86 #define ODBC_MIN(a,b) ( (a) < (b) ? (a) : (b) )
110 #if ENABLE_EXTRA_CHECKS
111 void odbc_check_struct_extra(
void *p);
113 static inline void odbc_check_struct_extra(
void *p) {}
116 #define ODBC_RETURN(handle, rc) \
117 do { odbc_check_struct_extra(handle); \
118 return handle->errs.lastrc = (rc); } while(0)
119 #define ODBC_RETURN_(handle) \
120 do { odbc_check_struct_extra(handle); \
121 return handle->errs.lastrc; } while(0)
123 #define ODBC_EXIT(handle, rc) \
124 do { SQLRETURN _odbc_rc = handle->errs.lastrc = (rc); \
125 odbc_check_struct_extra(handle); \
126 tds_mutex_unlock(&handle->mtx); \
127 return _odbc_rc; } while(0)
128 #define ODBC_EXIT_(handle) \
129 do { SQLRETURN _odbc_rc = handle->errs.lastrc; \
130 odbc_check_struct_extra(handle); \
131 tds_mutex_unlock(&handle->mtx); \
132 return _odbc_rc; } while(0)
139 void odbc_errs_add(
struct _sql_errors *errs,
const char *sqlstate,
const char *msg);
142 void odbc_errs_add_rdbms(
struct _sql_errors *errs, TDS_UINT native,
const char *sqlstate,
const char *msg,
int linenum,
143 int msgstate,
const char *server,
int row);
147 SQLSMALLINT sql_desc_alloc_type;
148 SQLINTEGER sql_desc_bind_type;
149 SQLULEN sql_desc_array_size;
151 SQLSMALLINT sql_desc_count;
152 SQLUSMALLINT *sql_desc_array_status_ptr;
153 SQLULEN *sql_desc_rows_processed_ptr;
154 SQLLEN *sql_desc_bind_offset_ptr;
159 SQLUINTEGER sql_desc_auto_unique_value;
160 DSTR sql_desc_base_column_name;
161 DSTR sql_desc_base_table_name;
162 SQLINTEGER sql_desc_case_sensitive;
163 DSTR sql_desc_catalog_name;
164 SQLSMALLINT sql_desc_concise_type;
165 SQLPOINTER sql_desc_data_ptr;
166 SQLSMALLINT sql_desc_datetime_interval_code;
167 SQLINTEGER sql_desc_datetime_interval_precision;
168 SQLLEN sql_desc_display_size;
169 SQLSMALLINT sql_desc_fixed_prec_scale;
170 SQLLEN *sql_desc_indicator_ptr;
172 SQLULEN sql_desc_length;
174 const char *sql_desc_literal_prefix;
176 const char *sql_desc_literal_suffix;
177 DSTR sql_desc_local_type_name;
179 SQLSMALLINT sql_desc_nullable;
180 SQLINTEGER sql_desc_num_prec_radix;
181 SQLLEN sql_desc_octet_length;
182 SQLLEN *sql_desc_octet_length_ptr;
183 SQLSMALLINT sql_desc_parameter_type;
184 SQLSMALLINT sql_desc_precision;
185 SQLSMALLINT sql_desc_rowver;
186 SQLSMALLINT sql_desc_scale;
187 DSTR sql_desc_schema_name;
188 SQLSMALLINT sql_desc_searchable;
189 DSTR sql_desc_table_name;
190 SQLSMALLINT sql_desc_type;
192 const char *sql_desc_type_name;
193 SQLSMALLINT sql_desc_unnamed;
194 SQLSMALLINT sql_desc_unsigned;
195 SQLSMALLINT sql_desc_updatable;
218 SQLUINTEGER connection_pooling;
219 SQLUINTEGER cp_match;
220 SQLINTEGER odbc_version;
221 SQLINTEGER output_nts;
242 SQLUINTEGER access_mode;
243 SQLUINTEGER async_enable;
244 SQLUINTEGER auto_ipd;
245 SQLUINTEGER autocommit;
246 SQLUINTEGER connection_dead;
247 SQLUINTEGER connection_timeout;
248 DSTR current_catalog;
249 SQLUINTEGER login_timeout;
250 SQLUINTEGER metadata_id;
251 SQLUINTEGER odbc_cursors;
252 SQLUINTEGER packet_size;
255 SQLUINTEGER translate_option;
256 SQLUINTEGER txn_isolation;
257 SQLUINTEGER mars_enabled;
258 SQLUINTEGER cursor_type;
259 SQLUINTEGER bulk_enabled;
266 #define TDS_MAX_APP_DESC 100
279 #ifdef ENABLE_ODBC_WIDE
280 DSTR original_charset;
297 unsigned int use_oldpwd:1;
298 TDS_INT default_query_timeout;
309 SQLUINTEGER async_enable;
310 SQLUINTEGER concurrency;
311 SQLUINTEGER cursor_scrollable;
312 SQLUINTEGER cursor_sensitivity;
313 SQLUINTEGER cursor_type;
314 SQLUINTEGER enable_auto_ipd;
315 SQLPOINTER fetch_bookmark_ptr;
319 SQLUINTEGER metadata_id;
333 SQLUINTEGER query_timeout;
334 SQLUINTEGER retrieve_data;
348 SQLUINTEGER simulate_cursor;
349 SQLUINTEGER use_bookmarks;
355 SQLUINTEGER qn_timeout;
365 } TDS_ODBC_ROW_STATUS;
369 ODBC_SPECIAL_NONE = 0,
370 ODBC_SPECIAL_GETTYPEINFO = 1,
371 ODBC_SPECIAL_COLUMNS = 2,
372 ODBC_SPECIAL_PROCEDURECOLUMNS = 3,
373 ODBC_SPECIAL_SPECIALCOLUMNS = 4
374 } TDS_ODBC_SPECIAL_ROWS;
393 unsigned is_prepared_query:1;
394 unsigned prepared_query_is_func:1;
395 unsigned prepared_query_is_rpc:1;
396 unsigned need_reprepare:1;
397 unsigned param_data_called:1;
407 unsigned int curr_param_row, num_param_rows;
420 SQLULEN sql_rowset_size;
423 TDS_ODBC_SPECIAL_ROWS special_row;
436 void (*set_type_info)(
TDSCOLUMN *col,
struct _drecord *drec, SQLINTEGER odbc_ver);
439 #define IS_HENV(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_ENV)
440 #define IS_HDBC(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_DBC)
441 #define IS_HSTMT(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_STMT)
442 #define IS_HDESC(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_DESC)
446 #if SQL_INTERVAL_YEAR == (100 + SQL_CODE_SECOND)
448 #undef SQL_INTERVAL_YEAR
449 #undef SQL_INTERVAL_MONTH
450 #undef SQL_INTERVAL_DAY
451 #undef SQL_INTERVAL_HOUR
452 #undef SQL_INTERVAL_MINUTE
453 #undef SQL_INTERVAL_SECOND
454 #undef SQL_INTERVAL_YEAR_TO_MONTH
455 #undef SQL_INTERVAL_DAY_TO_HOUR
456 #undef SQL_INTERVAL_DAY_TO_MINUTE
457 #undef SQL_INTERVAL_DAY_TO_SECOND
458 #undef SQL_INTERVAL_HOUR_TO_MINUTE
459 #undef SQL_INTERVAL_HOUR_TO_SECOND
460 #undef SQL_INTERVAL_MINUTE_TO_SECOND
462 #define SQL_INTERVAL_YEAR (100 + SQL_CODE_YEAR)
463 #define SQL_INTERVAL_MONTH (100 + SQL_CODE_MONTH)
464 #define SQL_INTERVAL_DAY (100 + SQL_CODE_DAY)
465 #define SQL_INTERVAL_HOUR (100 + SQL_CODE_HOUR)
466 #define SQL_INTERVAL_MINUTE (100 + SQL_CODE_MINUTE)
467 #define SQL_INTERVAL_SECOND (100 + SQL_CODE_SECOND)
468 #define SQL_INTERVAL_YEAR_TO_MONTH (100 + SQL_CODE_YEAR_TO_MONTH)
469 #define SQL_INTERVAL_DAY_TO_HOUR (100 + SQL_CODE_DAY_TO_HOUR)
470 #define SQL_INTERVAL_DAY_TO_MINUTE (100 + SQL_CODE_DAY_TO_MINUTE)
471 #define SQL_INTERVAL_DAY_TO_SECOND (100 + SQL_CODE_DAY_TO_SECOND)
472 #define SQL_INTERVAL_HOUR_TO_MINUTE (100 + SQL_CODE_HOUR_TO_MINUTE)
473 #define SQL_INTERVAL_HOUR_TO_SECOND (100 + SQL_CODE_HOUR_TO_SECOND)
474 #define SQL_INTERVAL_MINUTE_TO_SECOND (100 + SQL_CODE_MINUTE_TO_SECOND)
480 BOOL get_login_info(HWND hwndParent,
TDSLOGIN * login);
483 #define ODBC_PARAM_LIST \
484 ODBC_PARAM(Servername) \
489 ODBC_PARAM(Address) \
491 ODBC_PARAM(TDS_Version) \
492 ODBC_PARAM(Language) \
493 ODBC_PARAM(Database) \
494 ODBC_PARAM(TextSize) \
495 ODBC_PARAM(PacketSize) \
496 ODBC_PARAM(ClientCharset) \
497 ODBC_PARAM(DumpFile) \
498 ODBC_PARAM(DumpFileAppend) \
499 ODBC_PARAM(DebugFlags) \
500 ODBC_PARAM(Encryption) \
501 ODBC_PARAM(Trusted_Connection) \
504 ODBC_PARAM(UseNTLMv2) \
505 ODBC_PARAM(MARS_Connection) \
507 ODBC_PARAM(ServerSPN) \
508 ODBC_PARAM(AttachDbFilename) \
509 ODBC_PARAM(ApplicationIntent)
511 #define ODBC_PARAM(p) ODBC_PARAM_##p,
535 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 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);
549 TDS_DESC *desc_alloc(SQLHANDLE parent,
int desc_type,
int alloc_type);
550 SQLRETURN desc_free(
TDS_DESC * desc);
551 SQLRETURN desc_alloc_records(
TDS_DESC * desc,
unsigned count);
553 SQLRETURN desc_free_records(
TDS_DESC * desc);
559 SQLRETURN _SQLRowCount(SQLHSTMT hstmt, SQLLEN FAR * pcrow);
564 #if ENABLE_EXTRA_CHECKS
566 #define CHECK_ENV_EXTRA(env) odbc_check_env_extra(env)
567 #define CHECK_DBC_EXTRA(dbc) odbc_check_dbc_extra(dbc)
568 #define CHECK_STMT_EXTRA(stmt) odbc_check_stmt_extra(stmt)
569 #define CHECK_DESC_EXTRA(desc) odbc_check_desc_extra(desc)
571 void odbc_check_env_extra(
TDS_ENV * env);
572 void odbc_check_dbc_extra(
TDS_DBC * dbc);
573 void odbc_check_stmt_extra(
TDS_STMT * stmt);
574 void odbc_check_desc_extra(
TDS_DESC * desc);
577 #define CHECK_ENV_EXTRA(env)
578 #define CHECK_DBC_EXTRA(dbc)
579 #define CHECK_STMT_EXTRA(stmt)
580 #define CHECK_DESC_EXTRA(desc)
590 #ifdef ENABLE_ODBC_WIDE
597 # define _WIDE ,int wide
602 # define ODBC_CHAR SQLCHAR
604 int odbc_set_stmt_query(
struct _hstmt *stmt,
const ODBC_CHAR *sql,
int sql_len _WIDE);
605 void odbc_set_return_status(
struct _hstmt *stmt,
unsigned int n_row);
606 void odbc_set_return_params(
struct _hstmt *stmt,
unsigned int n_row);
608 void odbc_set_sql_type_info(
TDSCOLUMN * col,
struct _drecord *drec, SQLINTEGER odbc_ver);
610 int odbc_sql_to_c_type_default(
int sql_type);
611 int odbc_sql_to_server_type(
TDSCONNECTION * conn,
int sql_type,
int sql_unsigned);
614 unsigned int odbc_get_string_size(
int size,
const ODBC_CHAR * str _WIDE);
618 #ifdef ENABLE_ODBC_WIDE
619 DSTR* odbc_dstr_copy_flag(
TDS_DBC *dbc,
DSTR *s,
int size,
const ODBC_CHAR * str,
int flag);
620 #define odbc_dstr_copy(dbc, s, len, out) \
621 odbc_dstr_copy_flag(dbc, s, len, sizeof((out)->mb) ? (out) : (out), wide)
622 #define odbc_dstr_copy_oct(dbc, s, len, out) \
623 odbc_dstr_copy_flag(dbc, s, len, out, wide|0x20)
625 DSTR* odbc_dstr_copy(
TDS_DBC *dbc,
DSTR *s,
int size,
const ODBC_CHAR * str);
626 #define odbc_dstr_copy_oct odbc_dstr_copy
630 SQLRETURN
odbc_set_string_flag(
TDS_DBC *dbc, SQLPOINTER buffer, SQLINTEGER cbBuffer,
void FAR * pcbBuffer,
const char *s,
int len,
int flag);
631 #ifdef ENABLE_ODBC_WIDE
632 #define odbc_set_string(dbc, buf, buf_len, out_len, s, s_len) \
633 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))
634 #define odbc_set_string_oct(dbc, buf, buf_len, out_len, s, s_len) \
635 odbc_set_string_flag(dbc, buf, buf_len, out_len, s, s_len, (wide) | (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0x20:0x30))
637 #define odbc_set_string(dbc, buf, buf_len, out_len, s, s_len) \
638 odbc_set_string_flag(dbc, buf, buf_len, out_len, s, s_len, (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0:0x10))
639 #define odbc_set_string_oct(dbc, buf, buf_len, out_len, s, s_len) \
640 odbc_set_string_flag(dbc, buf, buf_len, out_len, s, s_len, (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0x20:0x30))
643 SQLSMALLINT odbc_get_concise_sql_type(SQLSMALLINT type, SQLSMALLINT interval);
645 SQLSMALLINT odbc_get_concise_c_type(SQLSMALLINT type, SQLSMALLINT interval);
648 SQLLEN odbc_get_octet_len(
int c_type,
const struct _drecord *drec);
649 void odbc_convert_err_set(
struct _sql_errors *errs, TDS_INT err);
654 SQLRETURN prepare_call(
struct _hstmt *stmt);
655 SQLRETURN native_sql(
struct _hdbc *dbc,
DSTR *s);
656 int parse_prepared_query(
struct _hstmt *stmt,
int compute_row);
657 int start_parse_prepared_query(
struct _hstmt *stmt,
int compute_row);
658 int continue_parse_prepared_query(
struct _hstmt *stmt, SQLPOINTER DataPtr, SQLLEN StrLen_or_Ind);
659 const char *parse_const_param(
const char * s, TDS_SERVER_TYPE *type);
665 TDS_INT convert_datetime2server(
int bindtype,
const void *src,
TDS_DATETIMEALL * dta);
670 void odbc_bcp_free_storage(
TDS_DBC *dbc);
671 void odbc_bcp_init(
TDS_DBC *dbc,
const ODBC_CHAR *tblname,
const ODBC_CHAR *hfile,
const ODBC_CHAR *errfile,
int direction _WIDE);
672 void odbc_bcp_control(
TDS_DBC *dbc,
int field,
void *value);
673 void odbc_bcp_colptr(
TDS_DBC *dbc,
const BYTE * colptr,
int table_column);
674 void odbc_bcp_sendrow(
TDS_DBC *dbc);
675 int odbc_bcp_batch(
TDS_DBC *dbc);
676 int odbc_bcp_done(
TDS_DBC *dbc);
677 void odbc_bcp_bind(
TDS_DBC *dbc,
const BYTE * varaddr,
int prefixlen,
int varlen,
const BYTE * terminator,
int termlen,
int vartype,
int table_column);
682 #if SIZEOF_SQLWCHAR != SIZEOF_WCHAR_T
683 size_t sqlwcslen(
const SQLWCHAR * s);
685 typedef struct sqlwstr_buf {
686 struct sqlwstr_buf *next;
689 const wchar_t *sqlwstr(
const SQLWCHAR * s, SQLWSTRBUF **bufs);
690 void sqlwstr_free(SQLWSTRBUF *bufs);
691 #define SQLWSTR_BUFS(n) SQLWSTRBUF *bufs = NULL
692 #define SQLWSTR(s) sqlwstr(s, &bufs)
693 #define SQLWSTR_FREE() sqlwstr_free(bufs)
695 #define sqlwcslen(s) wcslen(s)
697 #define SQLWSTR_BUFS(n) do {} while(0)
698 #define SQLWSTR(s) ((const wchar_t*)(s))
699 #define SQLWSTR_FREE() do {} while(0)
702 #if SIZEOF_SQLWCHAR == 2
704 # define ODBC_WIDE_NAME "UCS-2BE"
705 # define ODBC_WIDE_NAME_UTF "UTF-16BE"
707 # define ODBC_WIDE_NAME "UCS-2LE"
708 # define ODBC_WIDE_NAME_UTF "UTF-16LE"
711 #elif SIZEOF_SQLWCHAR == 4
713 # define ODBC_WIDE_NAME "UCS-4BE"
715 # define ODBC_WIDE_NAME "UCS-4LE"
717 static inline const char *
720 return ODBC_WIDE_NAME;
723 #error SIZEOF_SQLWCHAR not supported !!
726 #include <freetds/popvis.h>
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:601
this structure is not directed connected to a TDS protocol but keeps any DATE/TIME information...
Definition: tds.h:142
struct _hstmt * prev
previous in list
Definition: odbc.h:390
int param_num
last valid parameter in params, it's a ODBC index (from 1 relative to descriptor) ...
Definition: odbc.h:403
Structure to hold a string.
Definition: tds.h:94
char * prepared_pos
position in prepared query to check parameters, used only in RPC
Definition: odbc.h:405
Information for a server connection.
Definition: tds.h:1155
Holds informations about a cursor.
Definition: tds.h:958
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
unsigned int cursor_support
<>0 if server handle cursors
Definition: odbc.h:296
TDS_DESC * uad[TDS_MAX_APP_DESC]
descriptors associated to connection
Definition: odbc.h:294
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:858
Main include file for libtds.
TDSPARAMINFO * params
parameters saved
Definition: odbc.h:401
struct _hstmt * stmt_list
list of all statements allocated from this connection
Definition: odbc.h:291
Metadata about columns in regular and compute rows.
Definition: tds.h:713
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
struct _hstmt * next
next in list
Definition: odbc.h:388
TDS_INT8 row_count
row count to return
Definition: odbc.h:413
unsigned int param_count
number of parameter in current query
Definition: odbc.h:410
TDSSOCKET * tds
socket (only if active)
Definition: odbc.h:385
DSTR query
query to execute
Definition: odbc.h:383
Hold information for any results.
Definition: tds.h:790
Holds information for a dynamic (also called prepared) query.
Definition: tds.h:998
void odbc_rdbms_version(TDSSOCKET *tds_socket, char *pversion_string)
Returns the version of the RDBMS in the ODBC format.
Definition: odbc_util.c:849
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:415
struct _hstmt * current_statement
Statement executing.
Definition: odbc.h:289
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:280