VastbaseG100

基于openGauss内核开发的企业级关系型数据库。

Menu

SQLForeignKeys

功能描述

SQLForeignKeys 可以返回:

  • 指定表中的外键列表, (指定表中的列,这些列引用其他表中的主键) 。
  • 引用指定表中主键的其他表中的外键的列表。

驱动程序将每个列表作为指定语句的结果集返回。

接口原型

RETCODE		SQL_API
SQLForeignKeys(HSTMT hstmt,
	                  SQLCHAR *szPkCatalogName,
		              SQLSMALLINT cbPkCatalogName,
		              SQLCHAR *szPkSchemaName,
		              SQLSMALLINT cbPkSchemaName,
		              SQLCHAR *szPkTableName,
	                  SQLSMALLINT cbPkTableName,
		              SQLCHAR *szFkCatalogName,
		              SQLSMALLINT cbFkCatalogName,
		              SQLCHAR *szFkSchemaName,
		              SQLSMALLINT cbFkSchemaName,
		              SQLCHAR *szFkTableName,
		              SQLSMALLINT cbFkTableName)

参数说明

参数名 参数说明
hstmt 语句句柄。
szPkCatalogName Vastbase在实现此接口时没有用到该参数。
cbPkCatalogName Vastbase在实现此接口时没有用到该参数。
szPkSchemaName 主键表模式名。如果驱动程序支持某些表的模式,但不支持其他表的模式,例如当驱动程序从不同的dbms检索数据时,一个空字符串(“”)表示那些没有模式的表。szPkSchemaName不能包含字符串搜索模式。
cbPkSchemaName *szPkSchemaName的字符长度。
szPkTableName 主键表表名。这个参数不能是空指针。szPkTableName不能包含字符串搜索模式。
cbPkTableName *szPkTableName字符长度。
szFkCatalogName 外键表目录名称。 如果驱动程序支持某些目录的名称,但不支持其他目录的名称,例如,当驱动程序从不同的 DBMS 中检索数据时,空字符串 (“”) 表示没有名称的目录。 szFkCatalogName不能包含字符串搜索模式。 Vastbase在实现此接口时没有用到该参数。
cbFkCatalogName *szFkCatalogName字符长度。 Vastbase在实现此接口时没有用到该参数。
szFkSchemaName 外键表模式名。如果驱动程序支持某些表的模式,但不支持其他表的模式,例如当驱动程序从不同的dbms检索数据时,一个空字符串(“”)表示那些没有模式的表。szFkSchemaName不能包含字符串搜索模式。
cbFkSchemaName *szFkSchemaName的字符长度
szFkTableName 外键表表名。这个参数不能是空指针。szFkTableName不能包含字符串搜索模式。
cbFkTableName *szFkTableName字符长度。

返回

  • SQL_SUCCESS:表示调用正确。
  • SQL_ERROR:表示比较严重的错误,如:内存分配失败、建立连接失败等。

其他

无。