-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | ODBC specific definitions to be used by SQL CLI clients.
--   
--   Access databases through ODBC using SQLCLI compatible functions. The
--   package adds ODBC specific definition to the sqlcli package.
@package sqlcli-odbc
@version 0.2.0.1

module SQL.ODBC
sql_attr_odbc_version :: Num a => a
sql_attr_connection_pooling :: Num a => a
sql_attr_cp_match :: Num a => a
sql_attr_unixodbc_syspath :: Num a => a
sql_attr_unixodbc_version :: Num a => a
sql_attr_unixodbc_envattr :: Num a => a
sql_cp_off :: CULong
sql_cp_one_per_driver :: CULong
sql_cp_one_per_henv :: CULong
sql_cp_default :: CULong
sql_cp_strict_match :: CULong
sql_cp_relaxed_match :: CULong
sql_cp_match_default :: CULong
sql_ov_odbc2 :: CULong
sql_ov_odbc3 :: CULong
sql_ov_odbc3_80 :: CULong
sql_attr_access_mode :: Num a => a
sql_attr_autocommit :: Num a => a
sql_attr_connection_timeout :: Num a => a
sql_attr_current_catalog :: Num a => a
sql_attr_disconnect_behavior :: Num a => a
sql_attr_enlist_in_dtc :: Num a => a
sql_attr_enlist_in_xa :: Num a => a
sql_attr_login_timeout :: Num a => a
sql_attr_odbc_cursors :: Num a => a
sql_attr_packet_size :: Num a => a
sql_attr_quiet_mode :: Num a => a
sql_attr_trace :: Num a => a
sql_attr_tracefile :: Num a => a
sql_attr_translate_lib :: Num a => a
sql_attr_translate_option :: Num a => a
sql_attr_txn_isolation :: Num a => a
sql_attr_connection_dead :: Num a => a
sql_attr_driver_threading :: Num a => a
sql_attr_ansi_app :: Num a => a
sql_attr_reset_connection :: Num a => a
sql_attr_async_dbc_functions_enable :: Num a => a
sql_connect_opt_drvr_start :: Num a => a
sql_conn_opt_max :: Num a => a
sql_conn_opt_min :: Num a => a
sql_mode_read_write :: Num a => a
sql_mode_read_only :: Num a => a
sql_mode_default :: Num a => a
sql_autocommit_off :: Num a => a
sql_autocommit_on :: Num a => a
sql_autocommit_default :: Num a => a
sql_login_timeout_default :: Num a => a
sql_opt_trace_off :: Num a => a
sql_opt_trace_on :: Num a => a
sql_opt_trace_default :: Num a => a
sql_opt_trace_file_default :: String
sql_cur_use_if_needed :: Num a => a
sql_cur_use_odbc :: Num a => a
sql_cur_use_driver :: Num a => a
sql_cur_default :: Num a => a
sql_db_return_to_pool :: Num a => a
sql_db_disconnect :: Num a => a
sql_db_default :: Num a => a
sql_dtc_done :: Num a => a
sql_cd_true :: Num a => a
sql_cd_false :: Num a => a
sql_aa_true :: Num a => a
sql_aa_false :: Num a => a
sql_reset_connection_yes :: Num a => a
sql_async_dbc_enable_on :: Num a => a
sql_async_dbc_enable_off :: Num a => a
sql_async_dbc_enable_default :: Num a => a
sql_date :: (Num a) => a
sql_interval :: (Num a) => a
sql_time :: (Num a) => a
sql_timestamp :: (Num a) => a
sql_longvarchar :: (Num a) => a
sql_binary :: (Num a) => a
sql_varbinary :: (Num a) => a
sql_longvarbinary :: (Num a) => a
sql_bigint :: (Num a) => a
sql_tinyint :: (Num a) => a
sql_bit :: (Num a) => a
sql_guid :: (Num a) => a
sql_code_year :: (Num a) => a
sql_code_month :: (Num a) => a
sql_code_day :: (Num a) => a
sql_code_hour :: (Num a) => a
sql_code_minute :: (Num a) => a
sql_code_second :: (Num a) => a
sql_code_year_to_month :: (Num a) => a
sql_code_day_to_hour :: (Num a) => a
sql_code_day_to_minute :: (Num a) => a
sql_code_day_to_second :: (Num a) => a
sql_code_hour_to_minute :: (Num a) => a
sql_code_hour_to_second :: (Num a) => a
sql_code_minute_to_second :: (Num a) => a
sql_interval_year :: (Num a) => a
sql_interval_month :: (Num a) => a
sql_interval_day :: (Num a) => a
sql_interval_hour :: (Num a) => a
sql_interval_minute :: (Num a) => a
sql_interval_second :: (Num a) => a
sql_interval_year_to_month :: (Num a) => a
sql_interval_day_to_hour :: (Num a) => a
sql_interval_day_to_minute :: (Num a) => a
sql_interval_day_to_second :: (Num a) => a
sql_interval_hour_to_minute :: (Num a) => a
sql_interval_hour_to_second :: (Num a) => a
sql_interval_minute_to_second :: (Num a) => a
sql_c_char :: (Num a) => a
sql_c_long :: (Num a) => a
sql_c_short :: (Num a) => a
sql_c_float :: (Num a) => a
sql_c_double :: (Num a) => a
sql_c_numeric :: (Num a) => a
sql_c_default :: (Num a) => a
sql_signed_offset :: (Num a) => a
sql_unsigned_offset :: (Num a) => a
sql_c_date :: (Num a) => a
sql_c_time :: (Num a) => a
sql_c_timestamp :: (Num a) => a
sql_c_type_date :: (Num a) => a
sql_c_type_time :: (Num a) => a
sql_c_type_timestamp :: (Num a) => a
sql_c_interval_year :: (Num a) => a
sql_c_interval_month :: (Num a) => a
sql_c_interval_day :: (Num a) => a
sql_c_interval_hour :: (Num a) => a
sql_c_interval_minute :: (Num a) => a
sql_c_interval_second :: (Num a) => a
sql_c_interval_year_to_month :: (Num a) => a
sql_c_interval_day_to_hour :: (Num a) => a
sql_c_interval_day_to_minute :: (Num a) => a
sql_c_interval_day_to_second :: (Num a) => a
sql_c_interval_hour_to_minute :: (Num a) => a
sql_c_interval_hour_to_second :: (Num a) => a
sql_c_interval_minute_to_second :: (Num a) => a
sql_c_binary :: (Num a) => a
sql_c_bit :: (Num a) => a
sql_c_sbigint :: (Num a) => a
sql_c_ubigint :: (Num a) => a
sql_c_tinyint :: (Num a) => a
sql_c_slong :: (Num a) => a
sql_c_sshort :: (Num a) => a
sql_c_stinyint :: (Num a) => a
sql_c_ulong :: (Num a) => a
sql_c_ushort :: (Num a) => a
sql_c_utinyint :: (Num a) => a
sql_c_bookmark :: (Num a) => a
sql_c_guid :: (Num a) => a
sql_wchar :: (Num a) => a
sql_wvarchar :: (Num a) => a
sql_wlongvarchar :: (Num a) => a
sql_c_wchar :: (Num a) => a

-- | returns the length of the buffer for odbc C types; returns Nothing for
--   variable length fields or unknown fields, otherwise returns the number
--   of octets needed to hold the value of that type
odbcCTypeLen :: (Num a) => SQLSMALLINT -> Maybe a

module SQL.CLI.ODBC

-- | holds information specific to ODBC implementation
odbcImplementation :: SQLConfig

-- | helper function to allocate and setup an ODBC environment handle; it
--   displays diagnostics on standard error and fails if the handle could
--   not be allocated or setting the environment failed; it requires ODBC 3
--   implementation
setupEnv :: (MonadIO m, MonadFail m) => m SQLHENV

-- | convert an implementation type identifier to an ODBC known type
toODBCType :: SQLSMALLINT -> SQLSMALLINT