C-LANG Statements › ARGS Statement—Specify a Parameter Passed to a Stored Procedure (Database Jobs)

ARGS Statement—Specify a Parameter Passed to a Stored Procedure (Database Jobs)

The ARGS statement specifies a parameter passed to a database stored procedure in a Stored Procedure job.

Supported Job Type

This statement is optional for the Database Stored Procedure job type.

Syntax

This statement has the following format:

ARGS [IGNORE] parm_name [IN|OUT|INOUT] data_type[,value]

IGNORE

(Optional) Specifies that the value is not returned.

Note: This operand only applies to output parameters.

parm_name

Specifies the name of the parameter.

IN|OUT|INOUT

(Optional) Specifies the parameter type. Options are the following:

• IN—Specifies that the parameter is an input parameter.
• OUT—Specifies that the parameter is an output parameter.
• INOUT—Specifies that the parameter is an input-output parameter. Alternatively, you can specify IN OUT.

data_type

Specifies the database data type of the parameter.

The following data types are supported:

• CHAR
• VARCHAR
• LONGVARCHAR
• NUMERIC
• DECIMAL
• BIT
• BOOLEAN
• TINYINT
• SMALLINT
• INTEGER
• BIGINT
• REAL
• FLOAT
• DOUBLE
• DATE
• TIME
• TIMESTAMP

value

(Optional) Specifies the value of the parameter.

Limits: Up to 100 characters; case-sensitive

Note: This value applies to input parameters only.

Notes:

• To specify multiple parameters to pass to a stored procedure, define a separate ARGS statement for each parameter.
• The value of each statement can be up to 4070 characters.

Example: Pass Parameter to a Stored Procedure

This example defines a Stored Procedure job. The agent runs the stored procedure PAYROLL, passing in the parameter 'ename INOUT VARCHAR,John Evans'. Success is determined by whether ename begins with the string John when PAYROLL completes.

AGENT CYBDB1
SPNAME PAYROLL
ARGS ename INOUT VARCHAR,John Evans
JOB_CRITERIA ename=John.*