21#ifndef _tdsguard_gQHaPEvp2dAAa45TAutROb_
22#define _tdsguard_gQHaPEvp2dAAa45TAutROb_
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
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>
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))
82#define ODBC_API SQL_API
85#if (defined(_WIN32) || defined(__CYGWIN__)) && defined(__GNUC__)
86# define ODBC_PUBLIC __attribute__((dllexport))
91#define ODBC_MAX(a,b) ( (a) > (b) ? (a) : (b) )
92#define ODBC_MIN(a,b) ( (a) < (b) ? (a) : (b) )
93#define ODBC_CLAMP(x,a,b) ( (x) < (a) ? (a) : (x) > (b) ? (b) : (x) )
118#if ENABLE_EXTRA_CHECKS
119void odbc_check_struct_extra(
void *p);
121static inline void odbc_check_struct_extra(
void *p TDS_UNUSED) {}
124#define ODBC_RETURN(handle, rc) \
125 do { odbc_check_struct_extra(handle); \
126 return handle->errs.lastrc = (rc); } while(0)
127#define ODBC_RETURN_(handle) \
128 do { odbc_check_struct_extra(handle); \
129 return handle->errs.lastrc; } while(0)
131#define ODBC_EXIT(handle, rc) \
132 do { SQLRETURN _odbc_rc = handle->errs.lastrc = (rc); \
133 odbc_check_struct_extra(handle); \
134 tds_mutex_unlock(&handle->mtx); \
135 return _odbc_rc; } while(0)
136#define ODBC_EXIT_(handle) \
137 do { SQLRETURN _odbc_rc = handle->errs.lastrc; \
138 odbc_check_struct_extra(handle); \
139 tds_mutex_unlock(&handle->mtx); \
140 return _odbc_rc; } while(0)
147void odbc_errs_add(
struct _sql_errors *errs,
const char *sqlstate,
const char *msg);
150void odbc_errs_add_rdbms(
struct _sql_errors *errs, TDS_UINT native,
const char *sqlstate,
const char *msg,
int linenum,
151 int msgstate,
const char *server,
int row);
156 SQLSMALLINT sql_desc_alloc_type;
158 SQLSMALLINT sql_desc_count;
159 SQLINTEGER sql_desc_bind_type;
160 SQLULEN sql_desc_array_size;
161 SQLUSMALLINT *sql_desc_array_status_ptr;
162 SQLULEN *sql_desc_rows_processed_ptr;
163 SQLLEN *sql_desc_bind_offset_ptr;
169 DSTR sql_desc_base_column_name;
170 DSTR sql_desc_base_table_name;
171 SQLUINTEGER sql_desc_auto_unique_value;
172 SQLINTEGER sql_desc_case_sensitive;
173 DSTR sql_desc_catalog_name;
174 SQLPOINTER sql_desc_data_ptr;
175 SQLSMALLINT sql_desc_concise_type;
176 SQLSMALLINT sql_desc_datetime_interval_code;
177 SQLINTEGER sql_desc_datetime_interval_precision;
178 SQLLEN sql_desc_display_size;
179 SQLLEN *sql_desc_indicator_ptr;
181 SQLULEN sql_desc_length;
183 const char *sql_desc_literal_prefix;
185 const char *sql_desc_literal_suffix;
186 DSTR sql_desc_local_type_name;
188 SQLSMALLINT sql_desc_fixed_prec_scale;
189 SQLSMALLINT sql_desc_nullable;
190 SQLINTEGER sql_desc_num_prec_radix;
191 SQLLEN sql_desc_octet_length;
192 SQLLEN *sql_desc_octet_length_ptr;
193 SQLSMALLINT sql_desc_parameter_type;
194 SQLSMALLINT sql_desc_precision;
195 SQLSMALLINT sql_desc_rowver;
196 SQLSMALLINT sql_desc_scale;
197 DSTR sql_desc_schema_name;
198 DSTR sql_desc_table_name;
199 SQLSMALLINT sql_desc_searchable;
200 SQLSMALLINT sql_desc_type;
202 const char *sql_desc_type_name;
203 SQLSMALLINT sql_desc_unnamed;
204 SQLSMALLINT sql_desc_unsigned;
205 SQLSMALLINT sql_desc_updatable;
235 SQLUINTEGER connection_pooling;
236 SQLUINTEGER cp_match;
237 SQLINTEGER odbc_version;
238 SQLINTEGER output_nts;
259 SQLUINTEGER access_mode;
260 SQLUINTEGER async_enable;
261 SQLUINTEGER auto_ipd;
262 SQLUINTEGER autocommit;
263 SQLUINTEGER connection_dead;
264 SQLUINTEGER connection_timeout;
265 DSTR current_catalog;
266 SQLUINTEGER login_timeout;
267 SQLUINTEGER metadata_id;
268 SQLUINTEGER odbc_cursors;
269 SQLUINTEGER packet_size;
272 SQLUINTEGER translate_option;
273 SQLUINTEGER txn_isolation;
274 SQLUINTEGER mars_enabled;
275 SQLUINTEGER cursor_type;
276 SQLUINTEGER bulk_enabled;
283#define TDS_MAX_APP_DESC 100
295#ifdef ENABLE_ODBC_WIDE
296 int original_charset_num;
313 unsigned int use_oldpwd:1;
314 TDS_INT default_query_timeout;
325 SQLUINTEGER async_enable;
326 SQLUINTEGER concurrency;
327 SQLUINTEGER cursor_scrollable;
328 SQLUINTEGER cursor_sensitivity;
329 SQLUINTEGER cursor_type;
330 SQLUINTEGER enable_auto_ipd;
331 SQLPOINTER fetch_bookmark_ptr;
335 SQLUINTEGER metadata_id;
349 SQLUINTEGER query_timeout;
350 SQLUINTEGER retrieve_data;
364 SQLUINTEGER simulate_cursor;
365 SQLUINTEGER use_bookmarks;
371 SQLUINTEGER qn_timeout;
372 SQLUINTEGER param_focus;
382} TDS_ODBC_ROW_STATUS;
386 ODBC_SPECIAL_NONE = 0,
387 ODBC_SPECIAL_GETTYPEINFO = 1,
388 ODBC_SPECIAL_COLUMNS = 2,
389 ODBC_SPECIAL_PROCEDURECOLUMNS = 3,
390 ODBC_SPECIAL_SPECIALCOLUMNS = 4
391} TDS_ODBC_SPECIAL_ROWS;
410 unsigned is_prepared_query:1;
411 unsigned prepared_query_is_func:1;
412 unsigned prepared_query_is_rpc:1;
418 unsigned param_data_called:1;
428 unsigned int curr_param_row, num_param_rows;
441 SQLULEN sql_rowset_size;
444 TDS_ODBC_SPECIAL_ROWS special_row;
457 void (*set_type_info)(
TDSCOLUMN *col,
struct _drecord *drec, SQLINTEGER odbc_ver);
460#define IS_HENV(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_ENV)
461#define IS_HDBC(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_DBC)
462#define IS_HSTMT(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_STMT)
463#define IS_HDESC(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_DESC)
467#if SQL_INTERVAL_YEAR == (100 + SQL_CODE_SECOND)
469#undef SQL_INTERVAL_YEAR
470#undef SQL_INTERVAL_MONTH
471#undef SQL_INTERVAL_DAY
472#undef SQL_INTERVAL_HOUR
473#undef SQL_INTERVAL_MINUTE
474#undef SQL_INTERVAL_SECOND
475#undef SQL_INTERVAL_YEAR_TO_MONTH
476#undef SQL_INTERVAL_DAY_TO_HOUR
477#undef SQL_INTERVAL_DAY_TO_MINUTE
478#undef SQL_INTERVAL_DAY_TO_SECOND
479#undef SQL_INTERVAL_HOUR_TO_MINUTE
480#undef SQL_INTERVAL_HOUR_TO_SECOND
481#undef SQL_INTERVAL_MINUTE_TO_SECOND
483#define SQL_INTERVAL_YEAR (100 + SQL_CODE_YEAR)
484#define SQL_INTERVAL_MONTH (100 + SQL_CODE_MONTH)
485#define SQL_INTERVAL_DAY (100 + SQL_CODE_DAY)
486#define SQL_INTERVAL_HOUR (100 + SQL_CODE_HOUR)
487#define SQL_INTERVAL_MINUTE (100 + SQL_CODE_MINUTE)
488#define SQL_INTERVAL_SECOND (100 + SQL_CODE_SECOND)
489#define SQL_INTERVAL_YEAR_TO_MONTH (100 + SQL_CODE_YEAR_TO_MONTH)
490#define SQL_INTERVAL_DAY_TO_HOUR (100 + SQL_CODE_DAY_TO_HOUR)
491#define SQL_INTERVAL_DAY_TO_MINUTE (100 + SQL_CODE_DAY_TO_MINUTE)
492#define SQL_INTERVAL_DAY_TO_SECOND (100 + SQL_CODE_DAY_TO_SECOND)
493#define SQL_INTERVAL_HOUR_TO_MINUTE (100 + SQL_CODE_HOUR_TO_MINUTE)
494#define SQL_INTERVAL_HOUR_TO_SECOND (100 + SQL_CODE_HOUR_TO_SECOND)
495#define SQL_INTERVAL_MINUTE_TO_SECOND (100 + SQL_CODE_MINUTE_TO_SECOND)
501bool get_login_info(HWND hwndParent,
TDSLOGIN * login);
504#define ODBC_PARAM_LIST \
505 ODBC_PARAM(Servername) \
510 ODBC_PARAM(Address) \
512 ODBC_PARAM(TDS_Version) \
513 ODBC_PARAM(Language) \
514 ODBC_PARAM(Database) \
515 ODBC_PARAM(TextSize) \
516 ODBC_PARAM(PacketSize) \
517 ODBC_PARAM(ClientCharset) \
518 ODBC_PARAM(DumpFile) \
519 ODBC_PARAM(DumpFileAppend) \
520 ODBC_PARAM(DebugFlags) \
521 ODBC_PARAM(Encryption) \
522 ODBC_PARAM(Trusted_Connection) \
525 ODBC_PARAM(UseNTLMv2) \
526 ODBC_PARAM(MARS_Connection) \
528 ODBC_PARAM(ServerSPN) \
529 ODBC_PARAM(AttachDbFilename) \
530 ODBC_PARAM(ApplicationIntent) \
531 ODBC_PARAM(Timeout) \
532 ODBC_PARAM(Encrypt) \
533 ODBC_PARAM(HostNameInCertificate)
535#define ODBC_PARAM(p) ODBC_PARAM_##p,
559bool odbc_parse_connect_string(
TDS_ERRS *errs,
const char *connect_string,
const char *connect_string_end,
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);
584TDS_DESC *desc_alloc(SQLHANDLE parent,
int desc_type, SQLSMALLINT alloc_type);
585SQLRETURN desc_free(
TDS_DESC * desc);
586SQLRETURN desc_alloc_records(
TDS_DESC * desc,
unsigned count);
588SQLRETURN desc_free_records(
TDS_DESC * desc);
591void tvp_free(
SQLTVP *tvp);
597SQLRETURN odbc_SQLRowCount(SQLHSTMT hstmt, SQLLEN FAR * pcrow);
602#if ENABLE_EXTRA_CHECKS
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)
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);
615#define CHECK_ENV_EXTRA(env)
616#define CHECK_DBC_EXTRA(dbc)
617#define CHECK_STMT_EXTRA(stmt)
618#define CHECK_DESC_EXTRA(desc)
628#ifdef ENABLE_ODBC_WIDE
635# define _WIDE ,int wide
640# define ODBC_CHAR SQLCHAR
642int odbc_set_stmt_query(
struct _hstmt *stmt,
const ODBC_CHAR *sql,
int 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);
646void odbc_set_sql_type_info(
TDSCOLUMN * col,
struct _drecord *drec, SQLINTEGER odbc_ver);
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);
652unsigned int odbc_get_string_size(
int size,
const ODBC_CHAR * str _WIDE);
655 const TDS_DESC* axd,
unsigned int n_row);
657#ifdef ENABLE_ODBC_WIDE
658DSTR* odbc_dstr_copy_flag(
TDS_DBC *dbc,
DSTR *s,
int 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)
664DSTR* odbc_dstr_copy(
TDS_DBC *dbc,
DSTR *s,
int size,
const ODBC_CHAR * str);
665#define odbc_dstr_copy_oct odbc_dstr_copy
670 const char *s,
int 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))
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))
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))
688SQLSMALLINT odbc_get_concise_sql_type(SQLSMALLINT type, SQLSMALLINT interval);
690SQLSMALLINT odbc_get_concise_c_type(SQLSMALLINT type, SQLSMALLINT interval);
693SQLLEN odbc_get_octet_len(
int c_type,
const struct _drecord *drec);
694void odbc_convert_err_set(
struct _sql_errors *errs, TDS_INT err);
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);
711 bool compute_row,
const TDS_DESC* axd,
unsigned int n_row);
712TDS_INT convert_datetime2server(
int bindtype,
const void *src,
TDS_DATETIMEALL * dta);
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);
730#if SIZEOF_SQLWCHAR != SIZEOF_WCHAR_T
731size_t sqlwcslen(
const SQLWCHAR * s);
733typedef struct sqlwstr_buf {
734 struct sqlwstr_buf *next;
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)
743#define sqlwcslen(s) wcslen(s)
745#define SQLWSTR_BUFS(n) do {} while(0)
746#define SQLWSTR(s) ((const wchar_t*)(s))
747#define SQLWSTR_FREE() do {} while(0)
752#include <freetds/popvis.h>
Main include file for libtds.
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:983
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:1110
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:865
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
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
void odbc_rdbms_version(TDSSOCKET *tds_socket, char *pversion_string)
Returns the version of the RDBMS in the ODBC format.
Definition odbc_util.c:856
Descriptor header.
Definition odbc.h:155
Descriptor record.
Definition odbc.h:168
int focus
Nested descriptor to use.
Definition odbc.h:220
struct _hstmt * stmt_list
list of all statements allocated from this connection
Definition odbc.h:307
TDS_DESC * uad[TDS_MAX_APP_DESC]
descriptors associated to connection
Definition odbc.h:310
struct _hstmt * current_statement
Statement executing.
Definition odbc.h:305
unsigned int cursor_support
<>0 if server handle cursors
Definition odbc.h:312
unsigned int param_count
number of parameter in current query
Definition odbc.h:431
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:436
size_t prepared_pos
position in prepared query to check parameters, used only in RPC
Definition odbc.h:426
TDS_INT8 row_count
row count to return
Definition odbc.h:434
int param_num
last valid parameter in params, it's a ODBC index (from 1 relative to descriptor)
Definition odbc.h:424
DSTR query
query to execute
Definition odbc.h:400
unsigned need_reprepare
Prepared statement needs to be prepared again.
Definition odbc.h:417
struct _hstmt * next
next in list
Definition odbc.h:405
TDSSOCKET * tds
socket (only if active)
Definition odbc.h:402
struct _hstmt * prev
previous in list
Definition odbc.h:407
TDSPARAMINFO * params
parameters saved
Definition odbc.h:422
this structure is not directed connected to a TDS protocol but keeps any DATE/TIME information.
Definition tds.h:145
Metadata about columns in regular and compute rows.
Definition tds.h:698
Hold information for any results.
Definition tds.h:778
Holds information about a cursor.
Definition tds.h:946
Holds information for a dynamic (also called prepared) query.
Definition tds.h:986
Information for a server connection.
Definition tds.h:1185
Structure to hold a string.
Definition string.h:36