sa_describe_cursor 系统过程

sa_describe_cursor( cursor_name )

cursor_name 该 VARCHAR(256) 值标识要说明的打开游标。

列名	数据类型	说明
column_number	INTEGER	此行描述的列的顺序位置，从 1 开始。
name	VARCHAR(128)	列的名称。
domain_id	SMALLINT	列的数据类型。
domain_name	VARCHAR(128)	列的数据类型名称。
domain_name_with_size	VARCHAR(160)	数据类型名称，包括大小和精度（如 CREATE TABLE 或 CAST 函数中所用）。
width	INTEGER	字符串参数的长度、数字参数的精度或任何其它数据类型的存储字节数。
scale	INTEGER	数字数据类型列的小数点后的位数，对于所有其它数据类型该值为零。
declared_width	INTEGER	字符串参数的长度、数字参数的精度或任何其它数据类型的存储字节数。
user_type_id	SMALLINT	用户定义的数据类型（如果适用），否则为 NULL。
user_type_name	VARCHAR(128)	用户定义的数据类型（如果适用），否则为 NULL。
correlation_name	VARCHAR(128)	如果提供了与表达式关联的相关名，则为该相关名，否则为 NULL。
base_table_id	UNSIGNED INTEGER	如果表达式是列，则为 table_id，否则为 NULL。
base_column_id	UNSIGNED INTEGER	如果表达式是列，则为 column_id，否则为 NULL。
base_owner_name	VARCHAR(128)	如果表达式是列，则为所有者名称，否则为 NULL。
base_table_name	VARCHAR(128)	如果表达式是列，则为表名，否则为 NULL。
base_column_name	VARCHAR(128)	如果表达式是列，则为列名，否则为 NULL。
nulls_allowed	BIT	指示表达式是否可以为 NULL (1) 的指示符。
is_autoincrement	BIT	指示表达式是否是 AUTOINCREMENT 列 (1) 的指示符。
is_key_column	BIT	指示表达式是否属于结果集 (1) 主键的指示符。有关详细信息，请参见下面的注释部分。
is_added_key_column	BIT	指示表达式是否是添加的键列 (1) 的指示符。有关详细信息，请参见下面的注释部分。

sa_describe_cursor 系统过程为检索游标返回的列的说明提供独立于 API 的机制。当编写使用动态 SQL 的存储过程时，系统过程非常有用。

sa_describe_cursor 系统过程可在 CALL 语句或 SELECT 语句的 FROM 子句中使用。

cursor_name 必须引用当前连接中的打开游标。使用 sa_list_cursors 系统过程获取该连接的打开游标的列表。

无

sa_describe_cursor 系统过程

语法

参数

结果集

注释

权限

副作用

另请参见