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))
114#if ENABLE_EXTRA_CHECKS
115void odbc_check_struct_extra(
void *p);
117static inline void odbc_check_struct_extra(
void *p TDS_UNUSED) {}
120#define ODBC_RETURN(handle, rc) \
121 do { odbc_check_struct_extra(handle); \
122 return handle->errs.lastrc = (rc); } while(0)
123#define ODBC_RETURN_(handle) \
124 do { odbc_check_struct_extra(handle); \
125 return handle->errs.lastrc; } while(0)
127#define ODBC_EXIT(handle, rc) \
128 do { SQLRETURN _odbc_rc = handle->errs.lastrc = (rc); \
129 odbc_check_struct_extra(handle); \
130 tds_mutex_unlock(&handle->mtx); \
131 return _odbc_rc; } while(0)
132#define ODBC_EXIT_(handle) \
133 do { SQLRETURN _odbc_rc = handle->errs.lastrc; \
134 odbc_check_struct_extra(handle); \
135 tds_mutex_unlock(&handle->mtx); \
136 return _odbc_rc; } while(0)
143void odbc_errs_add(
struct _sql_errors *errs,
const char *sqlstate,
const char *msg);
146void odbc_errs_add_rdbms(
struct _sql_errors *errs, TDS_UINT native,
const char *sqlstate,
const char *msg,
int linenum,
147 int msgstate,
const char *server,
int row);
152 SQLSMALLINT sql_desc_alloc_type;
154 SQLSMALLINT sql_desc_count;
155 SQLINTEGER sql_desc_bind_type;
156 SQLULEN sql_desc_array_size;
157 SQLUSMALLINT *sql_desc_array_status_ptr;
158 SQLULEN *sql_desc_rows_processed_ptr;
159 SQLLEN *sql_desc_bind_offset_ptr;
165 DSTR sql_desc_base_column_name;
166 DSTR sql_desc_base_table_name;
167 SQLUINTEGER sql_desc_auto_unique_value;
168 SQLINTEGER sql_desc_case_sensitive;
169 DSTR sql_desc_catalog_name;
170 SQLPOINTER sql_desc_data_ptr;
171 SQLSMALLINT sql_desc_concise_type;
172 SQLSMALLINT sql_desc_datetime_interval_code;
173 SQLINTEGER sql_desc_datetime_interval_precision;
174 SQLLEN sql_desc_display_size;
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_fixed_prec_scale;
185 SQLSMALLINT sql_desc_nullable;
186 SQLINTEGER sql_desc_num_prec_radix;
187 SQLLEN sql_desc_octet_length;
188 SQLLEN *sql_desc_octet_length_ptr;
189 SQLSMALLINT sql_desc_parameter_type;
190 SQLSMALLINT sql_desc_precision;
191 SQLSMALLINT sql_desc_rowver;
192 SQLSMALLINT sql_desc_scale;
193 DSTR sql_desc_schema_name;
194 DSTR sql_desc_table_name;
195 SQLSMALLINT sql_desc_searchable;
196 SQLSMALLINT sql_desc_type;
198 const char *sql_desc_type_name;
199 SQLSMALLINT sql_desc_unnamed;
200 SQLSMALLINT sql_desc_unsigned;
201 SQLSMALLINT sql_desc_updatable;
231 SQLUINTEGER connection_pooling;
232 SQLUINTEGER cp_match;
233 SQLINTEGER odbc_version;
234 SQLINTEGER output_nts;
255 SQLUINTEGER access_mode;
256 SQLUINTEGER async_enable;
257 SQLUINTEGER auto_ipd;
258 SQLUINTEGER autocommit;
259 SQLUINTEGER connection_dead;
260 SQLUINTEGER connection_timeout;
261 DSTR current_catalog;
262 SQLUINTEGER login_timeout;
263 SQLUINTEGER metadata_id;
264 SQLUINTEGER odbc_cursors;
265 SQLUINTEGER packet_size;
268 SQLUINTEGER translate_option;
269 SQLUINTEGER txn_isolation;
270 SQLUINTEGER mars_enabled;
271 SQLUINTEGER cursor_type;
272 SQLUINTEGER bulk_enabled;
279#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;
415 unsigned params_queried:1;
416 unsigned params_set:1;
426 unsigned int curr_param_row, num_param_rows;
439 SQLULEN sql_rowset_size;
442 TDS_ODBC_SPECIAL_ROWS special_row;
455 void (*set_type_info)(
TDSCOLUMN *col,
struct _drecord *drec, SQLINTEGER odbc_ver);
458#define IS_HENV(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_ENV)
459#define IS_HDBC(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_DBC)
460#define IS_HSTMT(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_STMT)
461#define IS_HDESC(x) (((TDS_CHK *)x)->htype == SQL_HANDLE_DESC)
465#if SQL_INTERVAL_YEAR == (100 + SQL_CODE_SECOND)
467#undef SQL_INTERVAL_YEAR
468#undef SQL_INTERVAL_MONTH
469#undef SQL_INTERVAL_DAY
470#undef SQL_INTERVAL_HOUR
471#undef SQL_INTERVAL_MINUTE
472#undef SQL_INTERVAL_SECOND
473#undef SQL_INTERVAL_YEAR_TO_MONTH
474#undef SQL_INTERVAL_DAY_TO_HOUR
475#undef SQL_INTERVAL_DAY_TO_MINUTE
476#undef SQL_INTERVAL_DAY_TO_SECOND
477#undef SQL_INTERVAL_HOUR_TO_MINUTE
478#undef SQL_INTERVAL_HOUR_TO_SECOND
479#undef SQL_INTERVAL_MINUTE_TO_SECOND
481#define SQL_INTERVAL_YEAR (100 + SQL_CODE_YEAR)
482#define SQL_INTERVAL_MONTH (100 + SQL_CODE_MONTH)
483#define SQL_INTERVAL_DAY (100 + SQL_CODE_DAY)
484#define SQL_INTERVAL_HOUR (100 + SQL_CODE_HOUR)
485#define SQL_INTERVAL_MINUTE (100 + SQL_CODE_MINUTE)
486#define SQL_INTERVAL_SECOND (100 + SQL_CODE_SECOND)
487#define SQL_INTERVAL_YEAR_TO_MONTH (100 + SQL_CODE_YEAR_TO_MONTH)
488#define SQL_INTERVAL_DAY_TO_HOUR (100 + SQL_CODE_DAY_TO_HOUR)
489#define SQL_INTERVAL_DAY_TO_MINUTE (100 + SQL_CODE_DAY_TO_MINUTE)
490#define SQL_INTERVAL_DAY_TO_SECOND (100 + SQL_CODE_DAY_TO_SECOND)
491#define SQL_INTERVAL_HOUR_TO_MINUTE (100 + SQL_CODE_HOUR_TO_MINUTE)
492#define SQL_INTERVAL_HOUR_TO_SECOND (100 + SQL_CODE_HOUR_TO_SECOND)
493#define SQL_INTERVAL_MINUTE_TO_SECOND (100 + SQL_CODE_MINUTE_TO_SECOND)
499bool get_login_info(HWND hwndParent,
TDSLOGIN * login);
502#define ODBC_PARAM_LIST \
503 ODBC_PARAM(Address) \
505 ODBC_PARAM(ApplicationIntent) \
506 ODBC_PARAM(AttachDbFilename) \
507 ODBC_PARAM(ClientCharset) \
508 ODBC_PARAM(ConnectionTimeout) \
509 ODBC_PARAM(Database) \
510 ODBC_PARAM(DebugFlags) \
512 ODBC_PARAM(DumpFile) \
513 ODBC_PARAM(DumpFileAppend) \
514 ODBC_PARAM(Encrypt) \
515 ODBC_PARAM(Encryption) \
516 ODBC_PARAM(HostNameInCertificate) \
517 ODBC_PARAM(Language) \
518 ODBC_PARAM(MARS_Connection) \
519 ODBC_PARAM(PacketSize) \
524 ODBC_PARAM(ServerCertificate) \
525 ODBC_PARAM(Servername) \
526 ODBC_PARAM(ServerSPN) \
527 ODBC_PARAM(TDS_Version) \
528 ODBC_PARAM(TextSize) \
529 ODBC_PARAM(Timeout) \
530 ODBC_PARAM(Trusted_Connection) \
532 ODBC_PARAM(UseNTLMv2) \
535#define ODBC_PARAM(p) ODBC_PARAM_##p,
542#define ODBC_PARAM(p) extern const char odbc_param_##p[];
562bool odbc_parse_connect_string(
TDS_ERRS *errs,
const char *connect_string,
const char *connect_string_end,
573 TDS_CHAR * dest, SQLULEN destlen,
const struct _drecord *drec_ixd);
574SQLLEN odbc_tds2sql_int4(
TDS_STMT * stmt, TDS_INT *src,
int desttype, TDS_CHAR * dest, SQLULEN destlen);
587TDS_DESC *desc_alloc(SQLHANDLE parent,
int desc_type, SQLSMALLINT alloc_type);
588SQLRETURN desc_free(
TDS_DESC * desc);
589SQLRETURN desc_alloc_records(
TDS_DESC * desc, SQLSMALLINT count);
591SQLRETURN desc_free_records(
TDS_DESC * desc);
594void tvp_free(
SQLTVP *tvp);
600SQLRETURN odbc_SQLRowCount(SQLHSTMT hstmt, SQLLEN FAR * pcrow);
605#if ENABLE_EXTRA_CHECKS
607#define CHECK_ENV_EXTRA(env) odbc_check_env_extra(env)
608#define CHECK_DBC_EXTRA(dbc) odbc_check_dbc_extra(dbc)
609#define CHECK_STMT_EXTRA(stmt) odbc_check_stmt_extra(stmt)
610#define CHECK_DESC_EXTRA(desc) odbc_check_desc_extra(desc)
612void odbc_check_env_extra(
TDS_ENV * env);
613void odbc_check_dbc_extra(
TDS_DBC * dbc);
614void odbc_check_stmt_extra(
TDS_STMT * stmt);
615void odbc_check_desc_extra(
TDS_DESC * desc);
618#define CHECK_ENV_EXTRA(env)
619#define CHECK_DBC_EXTRA(dbc)
620#define CHECK_STMT_EXTRA(stmt)
621#define CHECK_DESC_EXTRA(desc)
631#ifdef ENABLE_ODBC_WIDE
638# define _WIDE ,int wide
643# define ODBC_CHAR SQLCHAR
645SQLRETURN odbc_set_stmt_query(
struct _hstmt *stmt,
const ODBC_CHAR *sql, ptrdiff_t sql_len _WIDE);
646void odbc_set_return_status(
struct _hstmt *stmt,
unsigned int n_row);
647void odbc_set_return_params(
struct _hstmt *stmt,
unsigned int n_row);
649void odbc_set_sql_type_info(
TDSCOLUMN * col,
struct _drecord *drec, SQLINTEGER odbc_ver);
651int odbc_sql_to_c_type_default(
int sql_type);
652TDS_SERVER_TYPE odbc_sql_to_server_type(
TDSCONNECTION * conn,
int sql_type,
int sql_unsigned);
655size_t odbc_get_string_size(ptrdiff_t size,
const ODBC_CHAR * str _WIDE);
658 const TDS_DESC* axd, SQLSETPOSIROW n_row);
660#ifdef ENABLE_ODBC_WIDE
661DSTR* odbc_dstr_copy_flag(
TDS_DBC *dbc,
DSTR *s, ptrdiff_t size,
const ODBC_CHAR * str,
int flag);
662#define odbc_dstr_copy(dbc, s, len, out) \
663 odbc_dstr_copy_flag(dbc, s, len, sizeof((out)->mb) ? (out) : (out), wide)
664#define odbc_dstr_copy_oct(dbc, s, len, out) \
665 odbc_dstr_copy_flag(dbc, s, len, out, wide|0x20)
667DSTR* odbc_dstr_copy(
TDS_DBC *dbc,
DSTR *s, ptrdiff_t size,
const ODBC_CHAR * str);
668#define odbc_dstr_copy_oct odbc_dstr_copy
673 const char *s, ptrdiff_t len,
int flag);
674#ifdef ENABLE_ODBC_WIDE
675#define odbc_set_string(dbc, buf, buf_len, out_len, s, s_len) \
676 odbc_set_string_flag(dbc, sizeof((buf)->mb) ? (buf) : (buf), buf_len, out_len, s, s_len, \
677 (wide) | (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0:0x10))
678#define odbc_set_string_oct(dbc, buf, buf_len, out_len, s, s_len) \
679 odbc_set_string_flag(dbc, buf, buf_len, out_len, s, s_len, (wide) | (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0x20:0x30))
681#define odbc_set_string(dbc, buf, buf_len, out_len, s, s_len) \
682 odbc_set_string_flag(dbc, buf, buf_len, out_len, s, s_len, (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0:0x10))
683#define odbc_set_string_oct(dbc, buf, buf_len, out_len, s, s_len) \
684 odbc_set_string_flag(dbc, buf, buf_len, out_len, s, s_len, (sizeof(*(out_len)) == sizeof(SQLSMALLINT)?0x20:0x30))
687#define odbc_set_dstr_oct(dbc, buf, buf_len, out_len, s) \
688 odbc_set_string_oct(dbc, buf, buf_len, out_len, tds_dstr_cstr(s), tds_dstr_len(s))
689#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))
691SQLSMALLINT odbc_get_concise_sql_type(SQLSMALLINT type, SQLSMALLINT interval);
693SQLSMALLINT odbc_get_concise_c_type(SQLSMALLINT type, SQLSMALLINT interval);
696SQLLEN odbc_get_octet_len(
int c_type,
const struct _drecord *drec);
697void odbc_convert_err_set(
struct _sql_errors *errs, TDS_INT err);
702SQLRETURN prepare_call(
struct _hstmt *stmt);
703SQLRETURN native_sql(
struct _hdbc *dbc,
DSTR *s);
704int parse_prepared_query(
struct _hstmt *stmt,
bool compute_row);
705int start_parse_prepared_query(
struct _hstmt *stmt,
bool compute_row);
706int continue_parse_prepared_query(
struct _hstmt *stmt, SQLPOINTER DataPtr, SQLLEN StrLen_or_Ind);
707const char *parse_const_param(
const char * s, TDS_SERVER_TYPE *type);
708const char *odbc_skip_rpc_name(
const char *s);
719 bool compute_row,
const TDS_DESC* axd, SQLSETPOSIROW n_row);
720TDS_INT convert_datetime2server(
int bindtype,
const void *src,
TDS_DATETIMEALL * dta);
726void odbc_bcp_free_storage(
TDS_DBC *dbc);
727void odbc_bcp_init(
TDS_DBC *dbc,
const ODBC_CHAR *tblname,
const ODBC_CHAR *hfile,
const ODBC_CHAR *errfile,
int direction _WIDE);
728void odbc_bcp_control(
TDS_DBC *dbc,
int field,
void *value);
729void odbc_bcp_colptr(
TDS_DBC *dbc,
const void * colptr,
int table_column);
730void odbc_bcp_sendrow(
TDS_DBC *dbc);
731int odbc_bcp_batch(
TDS_DBC *dbc);
732int odbc_bcp_done(
TDS_DBC *dbc);
733void odbc_bcp_bind(
TDS_DBC *dbc,
const void * varaddr,
int prefixlen,
int varlen,
const void * terminator,
int termlen,
734 int vartype,
int table_column);
739#if SIZEOF_SQLWCHAR != SIZEOF_WCHAR_T
740size_t sqlwcslen(
const SQLWCHAR * s);
742typedef struct sqlwstr_buf {
743 struct sqlwstr_buf *next;
746const wchar_t *sqlwstr(
const SQLWCHAR * s, SQLWSTRBUF **bufs);
747void sqlwstr_free(SQLWSTRBUF *bufs);
748#define SQLWSTR_BUFS(n) SQLWSTRBUF *bufs = NULL
749#define SQLWSTR(s) sqlwstr(s, &bufs)
750#define SQLWSTR_FREE() sqlwstr_free(bufs)
752#define sqlwcslen(s) wcslen(s)
754#define SQLWSTR_BUFS(n) do {} while(0)
755#define SQLWSTR(s) ((const wchar_t*)(s))
756#define SQLWSTR_FREE() do {} while(0)
762#define BCPHINTS_OLD 6
763#define SQL_COPT_TDSODBC_IMPL_BCP_CONTROL_OLD (SQL_COPT_TDSODBC_IMPL_BASE+1)
766#ifndef SQL_ATTR_DRIVER_UNICODE_TYPE
767#define SQL_ATTR_DRIVER_UNICODE_TYPE 1065
770#ifndef SQL_DM_CP_UTF16
771#define SQL_DM_CP_UTF16 1
773#ifndef SQL_DM_CP_UTF8
774#define SQL_DM_CP_UTF8 2
776#ifndef SQL_DM_CP_UCS4
777#define SQL_DM_CP_UCS4 3
780#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:988
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:1115
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:605
SQLLEN odbc_get_param_len(const struct _drecord *drec_axd, const struct _drecord *drec_ixd, const TDS_DESC *axd, SQLSETPOSIROW n_row)
Return length of parameter from parameter information.
Definition odbc_util.c:870
SQLRETURN odbc_set_string_flag(TDS_DBC *dbc TDS_UNUSED, SQLPOINTER buffer, SQLINTEGER cbBuffer, void FAR *pcbBuffer, const char *s, ptrdiff_t len, int flag)
Copy a string to client setting size according to ODBC convenction.
Definition odbc_util.c:304
void odbc_rdbms_version(TDSSOCKET *tds_socket, char *pversion_string)
Returns the version of the RDBMS in the ODBC format.
Definition odbc_util.c:861
Descriptor header.
Definition odbc.h:151
Descriptor record.
Definition odbc.h:164
int focus
Nested descriptor to use.
Definition odbc.h:216
struct _hstmt * stmt_list
list of all statements allocated from this connection
Definition odbc.h:304
TDS_DESC * uad[TDS_MAX_APP_DESC]
descriptors associated to connection
Definition odbc.h:307
struct _hstmt * current_statement
Statement executing.
Definition odbc.h:302
unsigned int cursor_support
<>0 if server handle cursors
Definition odbc.h:309
unsigned int param_count
number of parameter in current query
Definition odbc.h:429
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:434
size_t prepared_pos
position in prepared query to check parameters, used only in RPC
Definition odbc.h:424
TDS_INT8 row_count
row count to return
Definition odbc.h:432
int param_num
last valid parameter in params, it's a ODBC index (from 1 relative to descriptor)
Definition odbc.h:422
DSTR query
query to execute
Definition odbc.h:396
unsigned need_reprepare
Prepared statement needs to be prepared again.
Definition odbc.h:413
struct _hstmt * next
next in list
Definition odbc.h:401
TDSSOCKET * tds
socket (only if active)
Definition odbc.h:398
struct _hstmt * prev
previous in list
Definition odbc.h:403
TDSPARAMINFO * params
parameters saved
Definition odbc.h:420
This structure is not directly connected to TDS protocol but keeps any DATE/TIME information.
Definition tds.h:145
Metadata about columns in regular and compute rows.
Definition tds.h:674
Hold information for any results.
Definition tds.h:754
Holds information about a cursor.
Definition tds.h:922
Holds information for a dynamic (also called prepared) query.
Definition tds.h:963
Information for a server connection.
Definition tds.h:1163
Structure to hold a string.
Definition string.h:36