sp_remote_pcols system procedure

Produces a list of the columns in a remote table, and a description of their data types.

The server must be defined with the CREATE SERVER statement to use this system procedure.

Syntax

sp_remote_pcols(
@server_name
, @sp_name
[, @sp_owner
[, @sp_qualifier ] ]
)

Arguments

@server_name Use this CHAR(128) parameter to specify a string containing the server name as specified by the CREATE SERVER statement.
@sp_name Use this CHAR(128) parameter to specify the name of the remote table.
@sp_owner Use this optional CHAR(128) parameter to specify the owner of sp_name. The default is '%'.
@sp_qualifier Use this optional CHAR(128) parameter to specify the name of the database in which sp_name is located. The default is '%'.

Result set

Column name	Data type	Description
database	CHAR(128)	The database name.
owner	CHAR(128)	The database owner name.
proc_name	CHAR(128)	The stored procedure name.
parm_name	CHAR(128)	The name of the parameter or result set column.
parm_mode	CHAR(10)	The mode of the parameter or result set column (IN, OUT, INOUT, RESULT).
domain_id	SMALLINT	An INTEGER which indicates the data type of the parameter or result set column.
width	INTEGER	The meaning of this column depends on the data type. For character types width represents the number of characters.
scale	SMALLINT	The meaning of this column depends on the data type. For NUMERIC data types scale is the number of digits after the decimal point.
nullable	SMALLINT	If NULL parameter values are allowed, the value is 1. Otherwise the value is 0.

If you are entering a CREATE PROCEDURE ... AT statement and you are specifying a parameter list or want information on any result set that may be returned, it may be helpful to get a list of the parameters and result set columns that are available for a remote stored procedure. sp_remote_pcols produces a list of the parameters and result set columns of a remote stored procedure and a description of their data types. If you specify a database, you must either specify an owner or provide the value NULL.

Privileges

Side effects

Standards and compatibility

Example

The following example returns information about the parameters and result set columns of the ULOrderDownload stored procedure in the remote SQL Anywhere database server named RemoteSA. The stored procedure owner is DBA.

CALL sp_remote_pcols('RemoteSA', 'ULOrderDownload', 'DBA');

The following example returns information about the parameters and result set columns of the col_name stored procedure in the Adaptive Server Enterprise database Production using the remote server named RemoteASE. The remote procedure owner is unspecified.

CALL sp_remote_pcols( 'RemoteASE', 'col_name', null, 'Production' );

Discuss this page in DocCommentXchange.