第26章:连接器 / 26.1. MySQL Connector/ODBC / 26.1.16. MyODBC API引用

在本节中,概要介绍了按功能分类的ODBC子程序。

关于全部ODBC API参考,请参见ODBC程序员参考,http://msdn.microsoft.com/library/en-us/odbc/htm/odbcabout_this_manual.asp

应用程序可以调用SQLGetInfo函数来获得关于MyODBC的一致性信息。为了获得驱动程序对特定函数的支持信息,应用程序可调用SQLGetFunctions

注释: 为了向后兼容,MyODBC 3.51驱动程序支持所有已不使用的函数。

在下面的表各中,按任务分组列出了MyODBC API调用:

连接到数据源:

函数名

MyODBC

MyODBC

一致性

目的

 

2.50

3.51

 

 

SQLAllocHandle

No

Yes

ISO 92

获取环境、连接、语句或描述符句柄。

SQLConnect

Yes

Yes

ISO 92

按数据源名、用户ID和密码连接到特定驱动程序。

SQLDriverConnect

Yes

Yes

ODBC

通过连接字符串,或驱动管理器和驱动显示对话框发出的请求,连接到特定驱动程序。

SQLAllocEnv

Yes

Yes

Deprecated

获得驱动程序分配的环境句柄。

SQLAllocConnect

Yes

Yes

Deprecated

获取连接句柄。

获取关于驱动程序和数据源的信息:

函数名

MyODBC

MyODBC

一致性

目的

 

2.50

3.51

 

 

SQLDataSources

No

No

ISO 92

返回可用数据源的列表,由驱动管理器处理。

SQLDrivers

No

No

ODBC

返回已安装驱动程序和器属性的列表,由驱动管理器处理。

SQLGetInfo

Yes

Yes

ISO 92

返回关于特定驱动程序和数据源的信息。

SQLGetFunctions

Yes

Yes

ISO 92

返回支持的驱动函数。

SQLGetTypeInfo

Yes

Yes

ISO 92

返回关于所支持数据类型的信息。

设置并检索驱动属性:

函数名

MyODBC

MyODBC

一致性

目的

 

2.50

3.51

 

 

SQLSetConnectAttr

No

Yes

ISO 92

设置连接属性。

SQLGetConnectAttr

No

Yes

ISO 92

返回连接属性的值。

SQLSetConnectOption

Yes

Yes

Deprecated

设置连接选项。

SQLGetConnectOption

Yes

Yes

Deprecated

返回连接选项的值。

SQLSetEnvAttr

No

Yes

ISO 92

设置环境属性。

SQLGetEnvAttr

No

Yes

ISO 92

返回环境属性的值。

SQLSetStmtAttr

No

Yes

ISO 92

设置语句属性。

SQLGetStmtAttr

No

Yes

ISO 92

返回语句属性的值。

SQLSetStmtOption

Yes

Yes

Deprecated

设置语句选项。

SQLGetStmtOption

Yes

Yes

Deprecated

返回语句选项的值。

准备SQL请求:

函数名

MyODBC

MyODBC

一致性

目的

 

2.50

3.51

 

 

SQLAllocStmt

Yes

Yes

Deprecated

分配语句句柄。

SQLPrepare

Yes

Yes

ISO 92

准备随后执行的SQL语句。

SQLBindParameter

Yes

Yes

ODBC

为SQL语句中的参数分配存储器。

SQLGetCursorName

Yes

Yes

ISO 92

返回与语句句柄相关的光标名。

SQLSetCursorName

Yes

Yes

ISO 92

指定光标名。

SQLSetScrollOptions

Yes

Yes

ODBC

设置控制光标行为的选项。

提交请求:

函数名

MyODBC

MyODBC

一致性

目的

 

2.50

3.51

 

 

SQLExecute

Yes

Yes

ISO 92

执行准备好的语句。

SQLExecDirect

Yes

Yes

ISO 92

执行语句。

SQLNativeSql

Yes

Yes

ODBC

返回由驱动程序翻译的SQL语句的文本。

SQLDescribeParam

Yes

Yes

ODBC

返回语句中特定参数的描述。

SQLNumParams

Yes

Yes

ISO 92

返回语句中的参数数目。

SQLParamData

Yes

Yes

ISO 92

SQLPutData一起使用,以便在执行时提供参数。(对于长数据值很有用)。

SQLPutData

Yes

Yes

ISO 92

发送某一参数数据值的部分或全部。(对于长数据值很有用)。

检索结果以及关于结果的信息:

函数名

MyODBC

MyODBC

一致性

目的

 

2.50

3.51

 

 

SQLRowCount

Yes

Yes

ISO 92

返回插入、更新或删除请求影响的行数。

SQLNumResultCols

Yes

Yes

ISO 92

返回结果集中的列数。

SQLDescribeCol

Yes

Yes

ISO 92

描述结果集中的列。

SQLColAttribute

No

Yes

ISO 92

描述结果集中的某1列的属性。

SQLColAttributes

Yes

Yes

Deprecated

描述结果集中的某1列的多个属性。

SQLFetch

Yes

Yes

ISO 92

返回多个结果行。

SQLFetchScroll

No

Yes

ISO 92

返回可滚动结果行。

SQLExtendedFetch

Yes

Yes

Deprecated

返回可滚动结果行。

SQLSetPos

Yes

Yes

ODBC

将光标定为在获取的数据块中,允许应用程序更新行集合中的数据,或更新或删除结果集中的数据。

SQLBulkOperations

No

Yes

ODBC

执行批量插入和批量书签操作,包括更新、删除和按书签获取。

检索错误和诊断信息:

函数名

MyODBC

MyODBC

一致性

目的

 

2.50

3.51

 

 

SQLError

Yes

Yes

Deprecated

返回额外的错误或状态信息。

SQLGetDiagField

Yes

Yes

ISO 92

返回额外的诊断信息(诊断性数据结构的单个字段)。

SQLGetDiagRec

Yes

Yes

ISO 92

返回额外的诊断信息(诊断性数据结构的多个字段)。

获取关于数据源的系统表(目录函数)条目的信息:

函数名

MyODBC

MyODBC

一致性

目的

 

2.50

3.51

 

 

SQLColumnPrivileges

Yes

Yes

ODBC

返回关于一个或多个表的列和相关属性的列表。

SQLColumns

Yes

Yes

X/Open

返回指定表中列名的列表。

SQLForeignKeys

Yes

Yes

ODBC

在指定表中如果存在外键,返回构成外键的列名列表。

SQLPrimaryKeys

Yes

Yes

ODBC

返回构成某1表的主键的列名列表。

SQLSpecialColumns

Yes

Yes

X/Open

返回关于最佳列集合的信息,该列集合唯一地指明了指定表中的行,或当某1事务更新了行中的任何值时自动更新的列。

SQLStatistics

Yes

Yes

ISO 92

返回关于单个表的统计信息,以及与表相关的索引列表。

SQLTablePrivileges

Yes

Yes

ODBC

返回表列表,以及与各表相关的权限。

SQLTables

Yes

Yes

X/Open

返回存储在特定数据源内的表名列表。

执行事务:

函数名

MyODBC

MyODBC

一致性

目的

 

2.50

3.51

 

 

SQLTransact

Yes

Yes

Deprecated

提交或回滚事务。

SQLEndTran

No

Yes

ISO 92

提交或回滚事务。

中止语句:

函数名

MyODBC

MyODBC

一致性

目的

 

2.50

3.51

 

 

SQLFreeStmt

Yes

Yes

ISO 92

结束语句处理,舍弃未决结果,并释放与语句句柄相关的所有资源(可选)。

SQLCloseCursor

Yes

Yes

ISO 92

关闭在语句句柄上打开的指针。

SQLCancel

Yes

Yes

ISO 92

取消SQL语句。

中止连接:

函数名

MyODBC

MyODBC

一致性

目的

 

2.50

3.51

 

 

SQLDisconnect

Yes

Yes

ISO 92

关闭连接。

SQLFreeHandle

No

Yes

ISO 92

释放环境、连接、语句或描述符句柄。

SQLFreeConnect

Yes

Yes

Deprecated

释放连接句柄。

SQLFreeEnv

Yes

Yes

Deprecated

释放连接句柄。