sqlCallStoredProcedure

<ac:structured-macro ac:name="table-plus" ac:schema-version="1" data-layout="default">
<ac:parameter ac:name="applyColStyleToCell">true</ac:parameter>
<ac:parameter ac:name="heading">0</ac:parameter>
<ac:parameter ac:name="columnTypes">s,s,s,s</ac:parameter>
<ac:parameter ac:name="multiple">false</ac:parameter>
<ac:parameter ac:name="columnAttributes">style="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold,</ac:parameter>
<ac:parameter ac:name="enableSorting">false</ac:parameter>
<ac:rich-text-body>
<table data-layout="default">
<colgroup>
<col style="width: 76.0px;" />
<col style="width: 278.0px;" />
<col style="width: 106.0px;" />
<col style="width: 266.0px;" />
</colgroup>
<tbody>
<tr>
<td>
<p><strong>Syntax</strong></p>
</td>
<td>
<p>sqlCallStoredProcedure(datasourceName, procedureName, ...)</p>
</td>
<td>
<p><strong>Package</strong></p>
</td>
<td>
<p>sql</p>
</td>
</tr>
<tr>
<td>
<p><strong>Alias</strong></p>
</td>
<td>
<p></p>
</td>
<td>
<p><strong>Pkg Usage</strong></p>
</td>
<td>
<p>callSP(datasourceName, procedureName, ...)</p>
</td>
</tr>
</tbody>
</table>
</ac:rich-text-body>
</ac:structured-macro>
<h2>Description</h2>
<p><ac:structured-macro ac:name="excerpt" ac:schema-version="1" data-layout="default">
<ac:parameter ac:name="hidden">true</ac:parameter>
<ac:rich-text-body>
Executes the stored procedure over the defined datasource name / JNDI datasource.
</ac:rich-text-body>
</ac:structured-macro>
<p>Executes the stored procedure over the defined datasource name / JNDI datasource.</p></p>
<h2>Parameters</h2>
<ac:structured-macro ac:name="table-plus" ac:schema-version="1">
<ac:parameter ac:name="applyColStyleToCell">true</ac:parameter>
<ac:parameter ac:name="columnTypes">s,s,s,s</ac:parameter>
<ac:parameter ac:name="heading">0</ac:parameter>
<ac:parameter ac:name="multiple">false</ac:parameter>
<ac:parameter ac:name="enableSorting">false</ac:parameter>
<ac:rich-text-body>
<table data-layout="default">
<colgroup>
<col style="width: 170.0px;" />
<col style="width: 97.0px;" />
<col style="width: 108.0px;" />
<col style="width: 305.0px;" />
</colgroup>
<tbody>
<tr>
<th>
<p>Parameter name</p>
</th>
<th>
<p>Type</p>
</th>
<th>
<p>Required</p>
</th>
<th>
<p>Description</p>
</th>
</tr>
<tr>
<td>
<p>datasourceName</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>Yes</p>
</td>
<td>
<p>Datasource name / JNDI name. For Jira database, this is set to "jdbc/JiraDS" by default.</p>
</td>
</tr><tr>
<td>
<p>procedureName</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>Yes</p>
</td>
<td>
<p>Stored procedure name.</p>
</td>
</tr>
</tbody></table></ac:rich-text-body></ac:structured-macro>
<h2>Return Type</h2>
<p><strong>String []</strong></p>

<h2>Examples</h2>
<h3>Example 1</h3>
<p>Where showMessage() is a stored procedure existing in myDB database.</p>
<ac:structured-macro ac:name="code" ac:schema-version="1">
<ac:plain-text-body>
<![CDATA[string [] results = sqlCallStoredProcedure("myDB", "showMessage");]]>
</ac:plain-text-body>
</ac:structured-macro>

<h3>Example 2</h3>
<p>Where addComponent(String id, String name) is a stored procedure existing in myDB database.</p>
<ac:structured-macro ac:name="code" ac:schema-version="1">
<ac:plain-text-body>
<![CDATA[string [] results = sqlCallStoredProcedure("myDB", "addComponent", "componentId", "componentName");]]>
</ac:plain-text-body>
</ac:structured-macro>

<h2>Note</h2>
<p><ac:structured-macro ac:name="note" ac:schema-version="1">
<ac:rich-text-body>
<p>To configure the data source, check the <ac:link><ri:page ri:content-title="SQL data sources" /></ac:link> configuration chapter.</p>
</ac:rich-text-body>
</ac:structured-macro></p>

<h2>See also</h2>
<p><ac:structured-macro ac:name="contentbylabel" ac:schema-version="4">
<ac:parameter ac:name="showLabels">false</ac:parameter>
<ac:parameter ac:name="max">25</ac:parameter>
<ac:parameter ac:name="showSpace">false</ac:parameter>
<ac:parameter ac:name="cql">label = "system_routines" and space = currentSpace ( )</ac:parameter>
<ac:parameter ac:name="labels">array_routines</ac:parameter>
</ac:structured-macro></p>

Availability

This routine is available starting with SIL Engine™ 3.0.3.

Syntax

sqlCallStoredProcedure(datasourceName, procedureName, [...])

Description

Executes the stored procedure over the defined datasource name / JNDI datasource.

Parameters

Parameter name	Type	Required	Description
datasourceName	string	yes	Datasource name / JNDI name. For Jira database, this is set to "jdbc/JiraDS" by default.
procedureName	string	yes	Stored procedure name.

The routine accepts multiple parameters, in this case the sql statement being pushed as prepared to the database. Check Example 2 below for right syntax.

Returns

string []

Example

Example 1

string [] results = sqlCallStoredProcedure("myDB", "showMessage");

Where showMessage() is a stored procedure existing in myDB database.

Example 2

string [] results = sqlCallStoredProcedure("myDB", "addComponent", "componentId", "componentName");

Where addComponent(String id, String name) is a stored procedure existing in myDB database.

Notes

To configure the data source check the SQL Data Source Configuration configuration chapter.