Overview
A Stored Procedure is a precompiled set of SQL statements stored in a database management system, which can be executed upon request by an application or user.
This section will guide you through the process of creating, configuring, and executing stored procedures within the database. You will also learn how to save the results of a query to a Tag or a .NET variable and test the stored procedure's execution.
On this page:
Table of Contents | ||
---|---|---|
|
Creating a Stored Procedure
The Stored Procedures used in this test can be created by following the description below:
Creating a DatabaseOpenCreating a Stored Procedure consists of the following steps:
- Create a Database in the Database managament system.
- In this Database, Create Tables with primary keys.
- Create a third Table containing these primary keys from the other Databases.
- Execute the Procedure in the Database managament system.
- Save the result of the Query to a tag or .Net variable.
- Execute the Stored Procedures.
The sections below will go over these steps in more detail.
Step 1: Create A Database With SQL Server Management Studio (SSMS).
1.First create a Database in the used managament system, for the purpose of this example will be using SQL Server Managemenet studio. Follow the steps below.
- Connect to the SQL Server instance where you want to create the new database.
- In the Object Explorer pane, right-click
- Databases
- and choose New Query
- .
In the
New Query window, paste the
code
below.
Code Block USE master; CREATE DATABASE test; GO
It tells the SQL Server to switch to the 'master' database and then create a new database called 'test'.
Click the
Execute
button (or press F5) to run the query. The new 'test' database will be created.
In the
Object Explorer
pane, click the "Refresh" button next to
Databases
(or press F5). You should see the new 'test'
Database listed.
Step 2: Create Tables with Primary Keys
After creating the test Database, you need to create a Table with the primary keys (Spec
idId and Char
id)1.Id). Follow the steps below.
- Open SQL Server Management Studio (SSMS) and connect to the SQL Server instance where you created the 'test'
- Database.
- In the Object Explorer pane, expand the Databases folder
- , right-click on the 'test'
- Database and choose New Query
- .
In the
New Query window, paste the
code
below.
Code Block theme Confluence USE test GO CREATE TABLE dbo.Characteristic (Char_Id int PRIMARY KEY NOT NULL, Char_Desc varchar(25) NOT NULL, OptionsChar varchar(25)) GO INSERT dbo.Characteristic (Char_Id, Char_Desc, OptionsChar) VALUES(10,’C010’,’Char1’),(15,’C015’,’Char2’),(19,’C019’,’Char3’),(14,’C014’,’Char4’),(18,’C018’,’Char5’),(17,’C017’,’Char6’),(16,’C016’,’Char7’)GO CREATE TABLE dbo.Specification (Spec_ID int PRIMARY KEY NOT NULL, Spec_Desc varchar(25) NOT NULL, OptionsSpec varchar(25)) GO INSERT dbo.Specification (Spec_ID, Spec_Desc, OptionsSpec) VALUES (30, ’Spec 30’, ’Spec1’), (32, ’Spec 32’, ’Spec2’), (33, ’Spec 33’, ’Spec3’), (37, ’Spec 37’, ’Spec4’), (34, ’Spec 34’, ’Spec5’), (39, ’Spec 39’, ’Spec6’), (35, ’Spec 35’, ’Spec7’) GO
It creates two tables,
dbo.Characteristic
and
dbo.Specification
, with
theprimary keys
Char_Id
and
Spec_ID
, respectively. It also inserts sample data into both tables.
- Click the Execute
- button (or press F5) to run the query. The new tables will be created
- .
- In
- the Object Explorer pane, refresh the
- test
- database by right-clicking it and selecting Refresh (or press F5). Expand the
- test
- database, and you should see the newly created
dbo.Characteristic
- and
dbo.Specification
- tables under
- Tables
- .
Creating a Third Table That Contains the PrimaryKeys from the Other Two Tables
1. OpenStep 3: Create A Table Containing The Primary Keys From The Other Tables
Now you need to create a third table that contains the primary keys from the previously created tables. Follow these steps to do so.
- Open SQL Server Management Studio (SSMS) and connect to the SQL Server instance where the 'test' database was created.
- In the Object Explorer
- pane, expand the Databases folder
- , right-click on the
- test
- Database and choose New Query
- .
In the
New Query window, paste the
code
below.
Code Block CREATE TABLE dbo.Active_Spec (AS_ID int PRIMARY KEY NOT NULL, Char_ID int NOT NULL, Spec_ID int NOT NULL, OptionsAS varchar(25)) GO INSERT dbo.Active_Spec(AS_ID, Spec_ID, Char_ID, OptionsAS) VALUES(1,30,10,’AS1’),(2,37,19,’AS2’),(3,34,19,’AS3’),(7,35,16,’AS7’),(4,34,19,’AS4’),(6,39,18,’AS6’),(5,32,19,’AS5’)GO USE [Test] GO SET ANSI_NULLS ON GO SET QUOTED_IDENTIFIER ON GO CREATE PROCEDURE [dbo].[TestSP] @Char_Desc varChar(50) AS BEGIN SET NOCOUNT ON; Declare @Char_Id int, @Spec_Id int Select @Char_Id = Char_Id from Characteristic where Char_Desc = @Char_Desc Select c.char_Desc, s.Spec_Id, s.Spec_Desc, c.OptionsChar, s.OptionsSpec, asp.OptionsAS From Specification s Join Active_Spec asp on asp.Spec_Id = s.Spec_Id Join Characteristic c on c.Char_Id = asp.Char_Id Where c.Char_Id = @Char_Id GROUP BY c.Char_Desc, s.Spec_Id, s.Spec_Desc, c.OptionsChar, s.OptionsSpec, asp.OptionsAS END
It creates a new
Table
dbo.Active_Spec
containing the
Primary Keys from the other two
Tables
dbo.Characteristic
and
dbo.Specification
.
It also inserts sample data into the
dbo.Active_Spec
table and creates a stored procedure named
dbo.TestSP
.
Click the Execute
button (or press F5) to run the query. The table will be created, populated with the provided data, and the stored procedure will be added.
In the Object Explorer pane,
right-click the
test Database and select Refresh (or press F5). Expand the
test
Database, and you should see the newly created
dbo.Active_Spec
table under
Tables
, and the
dbo.TestSP
stored procedure under the Programmability → Stored Procedures folder.
Step 4: Execute The Procedure in SQL Server Management Studio (SSMS)
1. OpenNow execute the procedure we created before. Follow the steps below to do so:
- Open SQL Server Management Studio (SSMS) and connect to the SQL Server instance where the 'test' database
- was created.
- In the Object Explorer
- pane, expand the Databases folder
- , right-click on the
- test
- Database and choose New Query
- .
In the
New Query window, paste the
code
below.
Code Block EXEC TestSP ’C019’
This code executes the
TestSP
stored procedure with the parameter value
C019
.
Click the Execute button (or press F5) to run the query. The stored procedure will be executed, and the results will be displayed in the Results pane below the query window.
Saving
Step 5: Save the Result of a Query to a Tag or .NET Variable
Suppose your application has a Tag of the type DataTable Data Table named "Test" and a Dataset Query named "Query1". You can populate the "Test" Tag by executing with the following stepscode:
Code Block |
---|
@Tag.Test = @Dataset.Query.Query1.SelectComand() |
Step 6: Executing Stored Procedures
Both Queries and Stored Procedures are defined in the Datasets → Queries table. To execute a Stored Procedure, use the ExecuteCommand()
method. For example : Dataset.Queries.Query1.ExecuteCommand()
When passing parameters, you can use the @null@
syntax to pass a null value as a parameter. See the example code below:.
Code Block |
---|
Exec TestOutput @return_Value = {Tag.ReturnValue} RETURN_VALUE, @vcrPrefix = @null@, @intNextNumber = {Tag.NextNumber} OUTPUT, @vcrFullLicense = {Tag.NextLicense} OUTPUT |
Configuring the Project
1. Go to theTo configure and use stored procedures in the project, follow the steps below:
- Go to the Datasets → DBs page, and create a new DB for
- the SQL Server provider.
For this test, the Stored Procedure was created in the Test catalog.
2.
- On Datasets → Queries, create a new query assigned to this DB connection.
A Data Grid was added in the Draw Environment
, and its
Data Source was set to the Query created above. Next, a button is used to run the script below:
Code Block public void RunSP_Btn(object sender, System.Windows.Input.InputEventArgs e) { string sqlStatement = string.Format("exec TestSP ’{0}’", "C019"); @Dataset.Query.Query_SqlServer.SqlStatement = sqlStatement; string sts = ""; @Dataset.Query.Query_SqlServer.ExecuteCommandWithStatus(out sts); }
- After executing the code above, the result should be the same as in SQL Server Management Studio (SSMS).
Test Results
TestDescription | Results |
Creating Procedure in SQL Server. | OK. |
Running Procedure in SSMS. | OK. |
Running Procedure in fs-9.1.9. | OK. |
In this section...
Page Tree | ||||
---|---|---|---|---|
|