DataBlade API Programmer's Manual
Chapter 12: DataBlade API Function Descriptions
Home
Contents
Index
Master Index
New Book
Function Summary
This section summarizes the DataBlade API functions by categories.
Data Handling
The DataBlade API provides the following functions for handling data.
Getting and Setting Parameters and Environment Variables
mi_get_connection_info()
mi_get_connection_user_data()
mi_set_connection_user_data()
mi_get_default_database_info()
mi_get_default_connection_info()
mi_set_default_connection_info()
mi_get_default_database_info()
mi_set_default_database_info()
mi_get_parameter_info()
mi_set_parameter_info()
mi_sysname()
mi_get_next_sysname() (client only)
Handling Collections: Sets, Multisets, and Lists
mi_collection_close()
mi_collection_create()
mi_collection_delete()
mi_collection_fetch()
mi_collection_free()
mi_collection_insert()
mi_collection_open()
mi_collection_update()
Converting and Copying (Server Only)
mi_fix_integer()
mi_fix_smallint()
mi_get_bytes()
mi_get_date()
mi_get_datetime()
mi_get_decimal()
mi_get_double_precision()
mi_get_int8()
mi_get_integer()
mi_get_interval()
mi_get_money()
mi_get_real()
mi_get_string()
mi_get_smallint()
mi_put_bytes()
mi_put_date()
mi_put_datetime()
mi_put_decimal()
mi_put_double_precision()
mi_put_int8
mi_put_integer()
mi_put_interval()
mi_put_money()
mi_put_real()
mi_put_smallint()
mi_put_string()
Converting Between ASCII and Binary
mi_date_to_binary()
mi_binary_to_date()
mi_datetime_to_binary()
mi_binary_to_datetime()
mi_money_to_binary()
mi_binary_to_money()
mi_decimal_to_binary()
mi_binary_to_decimal()
Converting Between Code Sets (Server Only)
mi_convert_from_codeset()
mi_convert_to_codeset()
Managing Variable-Length Data Types
mi_new_var()
mi_get_varlen()
mi_get_vardata()
mi_get_vardata_align()
mi_set_varlen()
mi_set_vardata()
mi_set_vardata_align()
mi_set_varptr()
mi_var_copy()
mi_var_free()
mi_lvarchar_to_string()
mi_string_to_lvarchar()
mi_var_to_buffer()
Handling Null Values (Server Only)
mi_func_handlesnulls()
Session, Thread, and Transaction Management
The DataBlade API provides the following functions for managing sessions, threads, and transactions.
Connecting / Disconnecting
mi_close()
mi_init_library()
mi_login()
mi_open()
mi_server_connect()
mi_server_reconnect()
Thread Management (Server Only)
mi_interrupt_check()
mi_yield()
Transaction and Server Processing State Changes
mi_transition_type()
mi_xact_levels()
mi_xact_state()
Query Processing
The DataBlade API provides the following functions for processing queries.
Sending SQL Statements
mi_exec()
mi_query_finish()
mi_query_interrupt()
Information About the Current Statement
mi_binary_query()
mi_command_is_finished()
General Information About Results
mi_get_result()
mi_result_command_name()
mi_result_row_count()
General Information About Statements
mi_statement_command_name()
Retrieving Rows and Row Data
mi_column_precision()
mi_column_count()
mi_column_id()
mi_column_name()
mi_column_nullable()
mi_column_scale()
mi_column_typedesc()
mi_column_type_id()
mi_get_row_desc()
mi_get_row_desc_from_type_desc()
mi_get_row_desc_without_row()
mi_get_type_source_type()
mi_next_row() mi_row_create()
mi_row_desc_create()
mi_row_desc_free()
mi_row_free()
mi_value()
mi_value_by_name()
mi_type_align()
mi_type_byvalue()
mi_typedesc_typeid()
mi_type_element_typedesc()
mi_type_full_name()
mi_typeid_equals()
mi_typeid_is_collection()
mi_typeid_is_complex()
mi_typeid_is_distinct()
mi_typeid_is_list()
mi_typeid_is_multiset()
mi_typeid_is_row()
mi_typeid_is_set()
mi_type_length()
mi_type_maxlength()
mi_typename_to_id()
mi_typename_to_typedesc()
mi_type_owner()
mi_type_precision()
mi_type_scale()
mi_typestring_to_id()
mi_typestring_to_typedesc()
mi_type_typedesc()
mi_type_typename()
Parameterized Queries and Cursors
mi_close_statement()
mi_drop_prepared_statement()
mi_exec_prepared_statement()
mi_open_prepared_statement()
mi_fetch_statement()
mi_get_statement_row_desc()
mi_parameter_precision()
mi_parameter_count()
mi_parameter_type_id()
mi_parameter_nullable()
mi_parameter_scale()
mi_parameter_type_name()
mi_prepare()
Function Execution
The DataBlade API provides the following functions for executing functions:
mi_fp_funcstate()
mi_fp_setfuncstate()
mi_fp_request()
mi_fp_nrets()
mi_fp_setnrets()
mi_fp_returnisnull()
mi_fp_setreturnisnull()
mi_fp_setisdone()
mi_fp_nargs()
mi_fp_setnargs()
mi_fp_arglen()
mi_fp_setarglen()
mi_fp_argprec()
mi_fp_setargprec()
mi_fp_argscale()
mi_fp_setargscale()
mi_fp_argisnull()
mi_fp_setargisnull()
mi_fp_retlen()
mi_fp_setretlen()
mi_fp_retprec()
mi_fp_setretprec()
mi_fp_retscale()
mi_fp_setretscale()
mi_fp_rettype()
mi_fp_setrettype()
mi_fp_argtype()
mi_fp_setargtype()
mi_fp_argtype()
mi_fp_setargtype()
mi_fp_setfuncid()
mi_fp_getcolid()
mi_fp_getrow()
mi_fp_usr_fparam()
mi_fparam_allocate()
mi_fparam_free()
mi_fparam_copy()
mi_fparam_get()
mi_cast_get()
mi_td_cast_get()
mi_routine_exec()
mi_routine_end()
mi_routine_get()
mi_routine_get_by_typeid()
mi_routine_id_get()
Memory Management
The DataBlade API provides the following functions for managing memory.
mi_alloc()
mi_call()
mi_dalloc()
mi_free()
mi_switch_mem_duration()
mi_zalloc()
Save Sets
The DataBlade API provides the following functions for save sets.
mi_save_set_count()
mi_save_set_create()
mi_save_set_delete()
mi_save_set_destroy()
mi_save_set_get_first()
mi_save_set_get_last()
mi_save_set_get_next()
mi_save_set_get_previous()
mi_save_set_insert()
mi_save_set_member()
Exception Handling
The DataBlade API provides the following functions for handling exceptions.
mi_db_error_raise()
mi_errmsg()
mi_error_desc_copy()
mi_error_desc_destroy()
mi_error_desc_is_copy()
mi_error_level()
mi_error_sql_state()
mi_error_sqlcode()
Callbacks
The DataBlade API provides the following functions for callbacks.
mi_default_callback()
mi_disable_callback()
mi_enable_callback()
mi_register_callback()
mi_retrieve_callback()
mi_unregister_callback()
Smart-Large-Object Interface
The DataBlade API provides the following functions for handling smart large objects.
Important: In these reference pages, the term "smart large object" refers to either a BLOB or CLOB object. References to a single type of smart large object use the data type specification.
Smart-Large-Object Creation
mi_lo_copy()
mi_lo_create()
mi_lo_expand()
mi_lo_from_file()
Smart-Large-Object I/O
mi_lo_open()
mi_lo_close
mi_lo_seek()
mi_lo_tell()
mi_lo_read()
mi_lo_write()
mi_lo_readwithseek()
mi_lo_writewithseek()
mi_lo_stat()
mi_lo_truncate()
Moving Smart Large Objects to and from Operating-System Files
mi_lo_to_file()
mi_lo_from_file()
mi_lo_from_file_by_lofd()
mi_file_to_file()
Manipulating Smart-Large-Object Handles
mi_lo_validate()
mi_lo_invalidate()
mi_lo_filename()
mi_lo_alter()
mi_lo_decrefcount()
mi_lo_increfcount()
mi_lo_to_string()
mi_lo_from_string()
mi_lo_lolist_create()
Handling Smart-Large-Object Specifications
mi_lo_spec_init()
mi_lo_spec_free()
mi_lo_colinfo_by_name()
mi_lo_colinfo_by_ids()
mi_lo_specget_estbytes()
mi_lo_specget_extsz()
mi_lo_specget_flags()
mi_lo_specget_maxbytes()
mi_lo_specget_sbspace()
mi_lo_specset_estbytes()
mi_lo_specset_extsz()
mi_lo_specset_flags()
mi_lo_specset_maxbytes()
mi_lo_specset_sbspace()
Handling Smart-Large-Object Statistics
mi_lo_stat()
mi_lo_stat_free()
mi_lo_stat_size()
mi_lo_stat_uid()
mi_lo_stat_atime()
mi_lo_stat_mtime_sec()
mi_lo_stat_mtime_usec()
mi_lo_stat_ctime()
mi_lo_stat_refcnt()
mi_lo_stat_cspec()
Illustra Large-Object Interface (for Backward Compatibility)
mi_file_to_large_object()
mi_large_object_close()
mi_large_object_copy()
mi_large_object_copy_opts()
mi_large_object_create()
mi_large_object_create_opts()
mi_large_object_decrefcount()
mi_large_object_expand()
mi_large_object_filename()
mi_large_object_increfcount()
mi_large_object_info()
mi_large_object_map()
mi_large_object_open()
mi_large_object_pin()
mi_large_object_read()
mi_large_object_readwithseek()
mi_large_object_seek()
mi_large_object_stat()
mi_large_object_tell()
mi_large_object_to_file()
mi_large_object_unmap()
mi_large_object_unpin()
mi_large_object_write()
Multirepresentational ADT Support
The DataBlade API provides the following functions for multirepresentational
ADT
support.
mi_issmall_data()
mi_lo_expand()
mi_set_large()
Operating-System File Interface
The DataBlade API provides the following functions for the operating-system file interface.
mi_file_allocate()
mi_file_close()
mi_file_open()
mi_file_read()
mi_file_seek()
mi_file_sync()
mi_file_tell()
mi_file_write()
mi_file_unlink()
Tracing (Server Only)
The DataBlade API provides the following functions for tracing.
mi_tracefile_set()
mi_tracelevel_set()
Database Management (Client Only)
The DataBlade API provides the following functions for managing databases.
mi_dbcreate()
mi_dbdrop()
mi_get_dbnames()
Miscellaneous
The DataBlade API provides the following miscellaneous functions.
mi_client()
mi_client_locale()
mi_get_client_home()
mi_library_version()
DataBlade API Programmer's Manual
, version 9.1
Copyright © 1998, Informix Software, Inc. All rights reserved.
