Stored Procedures |
|
Fundamentals of Stored Procedures |
In Lesson 6, we had an introduction to some types of actions that could be performed on a database. These actions were called functions. The SQL provides another type of action called a stored procedure. If you have developed applications in some other languages such as Pascal or Visual Basic, you are probably familiar with the idea of a procedure. Like a function, a stored procedure is used to perform an action on a database. |
Practical Learning: Introducing Stored Procedures |
-- ============================================= -- Database: WattsALoan -- ============================================= USE master GO -- Drop the database if it already exists IF EXISTS ( SELECT name FROM sys.databases WHERE name = N'WattsALoan' ) DROP DATABASE WattsALoan GO CREATE DATABASE WattsALoan GO -- ========================================= -- Table: Employees -- ========================================= USE WattsALoan GO IF OBJECT_ID('dbo.Employees', 'U') IS NOT NULL DROP TABLE dbo.Employees GO CREATE TABLE dbo.Employees ( EmployeeID int identity(1,1) NOT NULL, EmployeeNumber nchar(10) NULL, FirstName varchar(20) NULL, LastName varchar(10), FullName AS ((LastName+ ', ') + FirstName), Title varchar(100), HourlySalary money, Username varchar(20), Password varchar(20), CONSTRAINT PK_Employees PRIMARY KEY(EmployeeID) ) GO INSERT INTO dbo.Employees(EmployeeNumber, FirstName, LastName, Title, HourlySalary) VALUES('293747', 'Jeanne', 'Tryler', 'Accounts Manager', 22.24); GO INSERT INTO dbo.Employees(EmployeeNumber, FirstName, LastName, Title, HourlySalary) VALUES('492947', 'Helene', 'Gustman', 'Accounts Representative', 14.55); GO INSERT INTO dbo.Employees(EmployeeNumber, FirstName, LastName, Title, HourlySalary) VALUES('804685', 'Ernest', 'Thomas', 'Accounts Representative', 12.75); GO -- ========================================= -- Table: LoanTypes -- ========================================= USE WattsALoan GO IF OBJECT_ID('dbo.LoanTypes', 'U') IS NOT NULL DROP TABLE dbo.LoanTypes GO CREATE TABLE dbo.LoanTypes ( LoanTypeID int identity(1,1) NOT NULL, LoanType varchar(50) NOT NULL, CONSTRAINT PK_LoanTypes PRIMARY KEY(LoanTypeID) ); GO INSERT INTO LoanTypes(LoanType) VALUES('Personal Loan'); GO INSERT INTO LoanTypes(LoanType) VALUES('Car Financing'); GO INSERT INTO LoanTypes(LoanType) VALUES('Credit Card'); GO INSERT INTO LoanTypes(LoanType) VALUES('Furniture Loan'); GO -- ========================================= -- Table: Customers -- ========================================= USE WattsALoan GO IF OBJECT_ID('dbo.Customers', 'U') IS NOT NULL DROP TABLE dbo.Customers GO CREATE TABLE dbo.Customers ( CustomerID int identity(1,1) NOT NULL, DateCreated datetime NULL, FullName varchar(50) NOT NULL, BillingAddress varchar(100), BillingCity varchar(50), BillingState varchar(50), BillingZIPCide varchar(10), EmailAddress varchar(100), CONSTRAINT PK_Customers PRIMARY KEY(CustomerID) ) GO INSERT INTO Customers(DateCreated, FullName, BillingAddress, BillingCity, BillingState, BillingZIPCide, EmailAddress) VALUES('2/26/2004', 'Julius Ramse', '927 Feuler Ave', 'Silver Spring', 'MD', '20904', 'ramses1990@netscape.net'); GO INSERT INTO Customers(DateCreated, FullName, BillingAddress, BillingCity, BillingState, BillingZIPCide) VALUES('06/22/2006', 'Gertrude Vaillant', '10055 Larsenic Rd', 'Takoma Park', 'MD', '20910'); GO INSERT INTO Customers(DateCreated, FullName, BillingAddress, BillingCity, BillingState, BillingZIPCide, EmailAddress) VALUES('12/3/2004', 'James Barrouch', '4204 Fallon Drive', 'Silver Spring', 'MD', '20906', 'barrouchj@hotmail.com'); GO INSERT INTO Customers(DateCreated, FullName, BillingAddress, BillingCity, BillingState, BillingZIPCide) VALUES('08/02/2006', 'Christine Rougher', '825 Manning Street', 'Alexandria', 'VA', '22231'); GO INSERT INTO Customers(DateCreated, FullName, BillingAddress, BillingCity, BillingState, BillingZIPCide, EmailAddress) VALUES('10/08/2006', 'Patrick Heller', '2480 Clarington Drive NW', 'Washington', 'DC', '20006', 'hellerp@yahooo.com'); GO -- ========================================= -- Table: LoanAllocation -- ========================================= USE WattsALoan GO IF OBJECT_ID('dbo.LoanAllocations', 'U') IS NOT NULL DROP TABLE dbo.LoanAllocations GO CREATE TABLE dbo.LoanAllocations ( LoanAllocationID int identity(1,1) NOT NULL, DatePrepared datetime NOT NULL, EmployeeID int NULL CONSTRAINT FK_LoanPreparer FOREIGN KEY REFERENCES Employees(EmployeeID), CustomerID int NOT NULL CONSTRAINT FK_LoanReceiver FOREIGN KEY REFERENCES Customers(CustomerID), AccountNumber char(10), LoanTypeID int NOT NULL CONSTRAINT FK_LoanTypes FOREIGN KEY REFERENCES LoanTypes(LoanTypeID), LoanAmount money NOT NULL, InterestRate decimal(6,2) NOT NULL, Periods decimal(6,2) NOT NULL, InterestAmount AS ((LoanAmount*(InterestRate/(100)))*(Periods/(12))), FutureValue AS (LoanAmount+(LoanAmount*(InterestRate/(100)))*(Periods/(12))), MonthlyPayment AS ((LoanAmount+(LoanAmount*(InterestRate/(100)))*(Periods/(12)))/Periods), Notes Text, CONSTRAINT PK_LoanAllocations PRIMARY KEY(LoanAllocationID) ) GO INSERT INTO LoanAllocations(DatePrepared, EmployeeID, CustomerID, AccountNumber, LoanTypeID, LoanAmount, InterestRate, Periods, Notes) VALUES('2/26/2004', 2, 1, '9171394', 4, 6500.00, 12.65, 36, 'The loan will be delivered by our furniture business partner Helios Furnian'); GO INSERT INTO LoanAllocations(DatePrepared, EmployeeID, CustomerID, AccountNumber, LoanTypeID, LoanAmount, InterestRate, Periods, Notes) VALUES('06/22/2007', 2, 2, '8628064', 2, 16500.00, 10.20, 60, 'For this car loan, our partner Arlington Honda will process and deliver the car.'); GO INSERT INTO LoanAllocations(DatePrepared, EmployeeID, CustomerID, AccountNumber, LoanTypeID, LoanAmount, InterestRate, Periods, Notes) VALUES('12/3/2006', 1, 3, '8468364', 3, 500.00, 18.65, 48, 'This is a regular credit card.'); GO INSERT INTO LoanAllocations(DatePrepared, EmployeeID, CustomerID, AccountNumber, LoanTypeID, LoanAmount, InterestRate, Periods, Notes) VALUES('08/02/2006', 3, 4, '2483047', 1, 3500.00, 12.74, 36, 'This is personal/cash loan allocated to a customer who walked in the store and requested it.'); GO INSERT INTO LoanAllocations(DatePrepared, EmployeeID, CustomerID, AccountNumber, LoanTypeID, LoanAmount, InterestRate, Periods, Notes) VALUES('10/08/2006', 2, 5, '1311804', 4, 22748.36, 12.28, 60, 'This is a regular car financing loan'); GO -- ========================================= -- Table: Payments -- ========================================= USE WattsALoan GO IF OBJECT_ID('dbo.Payments', 'U') IS NOT NULL DROP TABLE dbo.Payments GO CREATE TABLE dbo.Payments ( PaymentID int identity(1, 1) NOT NULL, PaymentDate datetime NOT NULL, EmployeeID int NULL CONSTRAINT FK_Employees FOREIGN KEY REFERENCES Employees(EmployeeID), LoanAllocationID int NOT NULL CONSTRAINT FK_LoanAllocations FOREIGN KEY REFERENCES LoanAllocations(LoanAllocationID), PaymentAmount money NOT NULL, Balance money, Notes Text, CONSTRAINT PK_Payments PRIMARY KEY(PaymentID) ) GO |
To create a procedure:
In SQL, to create a procedure, you start with the CREATE PROCEDURE expression. You can also use CREATE PROC. Both expressions produce the same result. Like everything in your database, you must name your procedure:
After the name of the procedure, type the keyword AS. The section, group of words, or group of lines after the AS keyword is called the body of the procedure. It states what you want the procedure to do or what you want it to produce. Based on this, the simplest syntax of creating a procedure is: CREATE PROCEDURE ProcedureName AS Body of the Procedure It is important to keep in mind that there are many other issues related to creating a procedure but for now, we will consider that syntax. After creating the procedure, you must store it as an object in your database. To do this, on the SQL Editor toolbar, you can click the Execute button . If the code of the procedure is right, it would be created and a new node for its name would be added to the Stored Procedures section of the database.
As a regular SQL Server database object, you can modify a stored procedure without recreating it. To do this:
In each case, a skeleton code would be generated for you. You can then edit it to create a new version of your stored procedure. After editing the code, you can execute the SQL statement to update the stored procedure. In SQL, the basic formula to modify a stored procedure is: ALTER PROCEDURE ProcedureName AS Body of Procedure
One of the biggest characteristics of a stored procedure is that it is treated like an object in its own right. Therefore, after creating it, if you don't need it anymore, you can get rid of it. There are various types of stored procedures, some of which are considered temporary. Those types of procedures delete themselves when not needed anymore, such as when the person who created the stored procedure disconnects from the database or shuts down the computer. Otherwise, to delete a procedure, you can use either the Object Explorer or SQL. As mentioned with tables, even if you create a procedure using the Object Explorer, you can delete it using SQL and vice-versa. To remove a procedure in the Object Explorer, after expanding its database, its Programmability, and its Stored Procedure nodes, you can right-click the stored procedure and click Delete. You can also click it in the Object Explorer to select it and then press Delete. The Delete Object dialog box would come up to let you make a decision. To delete a procedure in SQL, the syntax to use is: DROP PROCEDURE ProcedureName Of course, you should make sure you are in the right database and also that the ProcedureName exists.
Probably the simplest procedure you can write would consist of selecting columns from a table. This is done with the SELECT operator and applying the techniques we reviewed for data analysis. For example, to create a stored procedure that would hold a list of students from a table named Students, you would create the procedure as follows: CREATE PROCEDURE GetStudentIdentification AS BEGIN SELECT FirstName, LastName, DateOfBirth, Gender FROM Students END GO Besides SELECT operations, in a stored procedure, you can perform any of the database operations we have applied so far. These include creating and maintaining records, etc.
To get the results of creating a stored procedure, you must execute it (in other words, to use a stored procedure, you must call it). To execute a procedure, you use the EXECUTE keyword followed by the name of the procedure. Although there are some other issues related to executing a procedure, for now, we will consider that the simplest syntax to call a procedure is: EXECUTE ProcedureName Alternatively, instead of EXECUTE, you can use the EXEC keyword: EXEC ProcedureName For example, if you have a procedure named GetStudentIdentification, to execute it, you would type: EXECUTE GetStudentIdentification You can also precede the name of the procedure with its schema, such as dbo. Here is an example: EXECUTE dbo.GetStudentIdentification; You can also precede the name of the schema with the name of the database. Here is an example: EXECUTE ROSH.dbo.GetStudentIdentification;
One of the advantages of using a stored procedure is that not only can it produce the same expression as we saw during analysis but also it can store such an expression to be recalled any time without having to re-write it (the expression). Based on this, you can create an expression that combines a first and a last name to produce and store a full name. Here is an example: CREATE PROCEDURE GetStudentIdentification AS BEGIN SELECT FullName = FirstName + ' ' + LastName, DateOfBirth, Gender FROM Students END GO A stored procedure can also call a function in its body. To do this, follow the same rules we reviewed for calling functions during data analysis. Here is an example of a stored procedure that calls a function: USE ROSH; GO CREATE PROCEDURE GetStudentsAges AS BEGIN SELECT FullName = FirstName + ' ' + LastName, DATEDIFF(year, DateOfBirth, GETDATE()) AS Age, Gender FROM Students END GO Here is an example of executing the procedure:
All of the stored procedures we have created and used so far assumed that the values they needed were already in a table of the database. In some cases, you may need to create a stored procedure that involves values that are not part of the database. On such a scenario, for the procedure to carry its assignment, you would supply it with one or more values. An external value that is provided to a stored procedure is called a parameter. When you create a stored procedure, you must also create the parameter if you judge it necessary. When a procedure's creation is equipped with a parameter, it is said that the stored procedure takes an argument. A stored procedure can also take more than one argument. When you execute a stored procedure that takes one or more arguments, you must provide a value for each argument. In this case, you are said to pass a value for the argument. There are cases when you don't have to provide an argument.
To create a stored procedure that takes an argument, type the formula CREATE PROCEDURE or CREATE PROC followed by the name of the procedure, then type the name of the argument starting with @. The parameter is created like a column of a table. That is, a parameter must have a name, a data type and an optional length. Here is the syntax you would use: CREATE PROCEDURE ProcedureName @ParameterName DataType AS Body of the Procedure When implementing the stored procedure, you can define what you want to do with the parameter(s), in the body of the procedure. One way you can use a parameter is to run a query whose factor the user would provide. For example, imagine you want to create a procedure that, whenever executed, would be supplied with a gender, then it would display the list of students of that gender. Since you want the user to specify the gender of students to display, you can create a stored procedure that receives the gender. Here is an example: CREATE PROC GetListOfStudentsByGender @Gdr VARCHAR(12) AS SELECT FirstName, LastName, DateOfBirth, HomePhone, Gender FROM Students WHERE Gender = @Gdr
As mentioned already, when executing a stored procedure that takes a parameter, make sure you provide a value for the parameter. The syntax used is: EXEC ProcedureName ParameterValue If the parameter is Boolean or numeric, make sure you provide the value as 0 or for a Boolean value or another number for the numeric type. If the parameter is a character or a string, type its value in single-quotes. Here is an example: EXEC ROSH.dbo.GetListOfStudentsByGender 'Male'; Here is an example of executing it: Notice that we could/should have omitted to include the Gender column in the statement since it would be implied to the user. Another type of stored procedure can be made to take more than one parameter. In this case, create the parameters in the section before the AS keyword, separated by a comma. The syntax you would use is: CREATE PROCEDURE ProcedureName @ParameterName1 DataType, @ParameterName2 DataType, @ParameterName_n DataType AS Body of the Procedure Here is an example: USE ROSH; GO CREATE PROCEDURE IdentifyStudentsByState @Gdr varchar(20), @StateOrProvince char(2) AS BEGIN SELECT FullName = LastName + ', ' + FirstName, DATEDIFF(year, DateOfBirth, GETDATE()) AS Age, Gender FROM Students WHERE (Gender = @Gdr) AND (State = @StateOrProvince) END GO When calling a stored procedure that takes more than one parameter, you must still provide a value for each parameter but you have two alternatives. The simplest technique consists of providing a value for each parameter in the exact order they appear in the stored procedure. Here is an example: USE ROSH; GO EXEC ROSH.dbo.IdentifyStudentsByState 'Female', 'MD'; GO This would produce: Alternatively, you can provide the value for each parameter in the order of your choice. Consider the following procedure that takes 3 arguments: USE ROSH; GO CREATE PROCEDURE IdentifySomeStudents @Gdr varchar(20), @StateOrProvince char(2), @HomeStatus bit AS BEGIN SELECT FullName = LastName + ', ' + FirstName, DATEDIFF(year, DateOfBirth, GETDATE()) AS Age, Gender FROM Students WHERE (Gender = @Gdr) AND (State = @StateOrProvince) AND (SPHome = @HomeStatus) END GO When calling this type of procedure, you can type the name of each parameter and assign it the corresponding value. Here is an example: EXEC IdentifySomeStudents @HomeStatus=1, @StateOrProvince='MD', @Gdr='Female'; Here is an example of executing the procedure:
Imagine you create a database for a department store and a table that holds the list of items sold in the store: Supposed you have filled the table with a few items as follows:
Imagine you want to create a mechanism of calculating the price of an item after a discount has been applied to it. Such a procedure can be created as follows: CREATE PROC CalculateNetPrice @discount Decimal AS SELECT ItemName, UnitPrice - (UnitPrice * @discount / 100) FROM StoreItems This can be executed as follows: If you are planning to create a stored procedure that takes an argument and know that the argument will likely have the same value most of the time, you can provide that value as parameter but leave a room for other values of that argument. A value given to an argument is referred to as default. What this implies is that, when the user calls that stored procedure, if the user doesn't provide a value for the argument, the default value would be used. To create a stored procedure that takes an argument that carries a default value, after declaring the value, on its right side, type = followed by the desired value. Here is an example applied to the above database: CREATE PROC CalculateDiscountedPrice @discount decimal = 10.00 AS SELECT ItemName, UnitPrice - (UnitPrice * @discount / 100) FROM StoreItems; GO When executing a stored procedure that takes a default argument, you don't have to provide a value for the argument if the default value suits you. Based on this, the above stored procedure can be called as follows: If the default value doesn't apply to your current calculation, you can provide a value for the argument. Here is an example: Using this same approach, you can create a stored procedure that takes more than one argument with default values. To provide a default value for each argument, after declaring it, type the desired value to its right side. Here is an example of a stored procedure that takes two arguments, each with a default value: CREATE PROC CalculateSalePrice @Discount decimal = 20.00, @TaxRate decimal = 7.75 AS SELECT ItemName As [Item Description], UnitPrice As [Marked Price], UnitPrice * @Discount / 100 As [Discount Amt], UnitPrice - (UnitPrice * @Discount / 100) As [After Discount], UnitPrice * @TaxRate / 100 As [Tax Amount], (UnitPrice * @TaxRate / 100) + UnitPrice - (UnitPrice * @Discount / 100) + (@TaxRate / 100) As [Net Price] FROM StoreItems; GO Here is an example of executing the procedure: When calling a stored procedure that takes more than one argument and all arguments having default values, you don't need to provide a value for each argument, you can provide a value for only one or some of the arguments. The above procedure can be called with one argument as follows: EXEC CalculateSalePrice2 55.00 In this case, the other argument(s) would use their default value. We saw that, when calling a stored procedure that takes more than one argument, you didn't have to provide the values of the arguments in the exact order they appeared in the procedure, you just had to type the name of each argument and assign it the desired value. In the same way, if a stored procedure takes more than one argument and some of the arguments have default values, when calling it, you can provide the values in the order of your choice, by typing the name of each argument and assigning it the desired value. Based on this, the above stored procedure can be called with only the value of the second argument as follows: EXEC CalculateSalePrice2 @TaxRate = 8.55 In this case, the first argument would use its default value.
Transact-SQL uses the notion of passing an argument by reference. This type of argument is passed to a procedure but it is meant to return a value. In other words, you can create a stored procedure that takes a parameter but the purpose of the parameter is to carry a new value when the procedure ends so you can use that value as you see fit. To create a parameter that will return a value from the stored procedure, after the name of the procedure, if you want the stored procedure to take arguments, type them. Otherwise, omit them. On the other hand, you must pass at least one argument, name it starting with the @ symbol, specify its data type, and enter the OUTPUT keyword on its right. Based on this, the basic syntax you can use is: CREATE PROCEDURE ProcedureName @ParameterName DataType OUTPUT AS Body of the Procedure In the body of the procedure, you can perform the assignment as you see fit. The primary rule you must follow is that, before the end of the procedure, you must have specified a value for the OUTPUT argument. That's the value that the argument will hold when the stored procedure exits. Here is an example: CREATE PROCEDURE dbo.CreateFullName @FName varchar(20), @LName varchar(20), @FullName varchar(42) OUTPUT AS SELECT @FullName = @LName + ', ' + @FName GO When calling the stored procedure, you must pass an argument for the OUTPUT parameter and, once again, you must type OUTPUT to the right side of the argument. Remember that the stored procedure would return the argument. This means that, after calling the procedure, you can get back the OUTPUT argument and use it as you see fit. Here is an example: DECLARE @FirstName varchar(20), @LastName varchar(20), @Full varchar(42) SET @FirstName = 'Melanie'; SET @LastName = 'Johanssen'; EXECUTE dbo.CreateFullName @FirstName, @LastName, @Full OUTPUT SELECT @Full; GO One of the advantages of using a function or a stored procedure is that it has access to the tables and records of its database. This means that you can access the columns and records as long as you specify the table or the view, which is done with a FROM clause associated with a SELECT statement. Consider the following stored procedure created in a database that contains a table named Students: USE ROSH; GO CREATE PROCEDURE ShowStudentsFullNames @FullName varchar(42) OUTPUT AS SELECT @FullName = LastName + ', ' + FirstName FROM Students; GO When you execute this stored procedure, it would work on the records of the table. One of the particularities of a stored procedure that takes an OUTPUT argument is that it can return only one value. Consider the following example of executing the above procedure: When calling such a procedure, if you don't specify a condition to produce one particular result, the SQL interpreter in this case would select the last record. This means that you should always make sure that your stored procedure that takes an OUTPUT parameter would have a way to isolate a result. If the stored procedure processes a SELECT statement, you can use a WHERE condition. Here is an example of such a procedure: USE ROSH; GO CREATE PROCEDURE ShowStudentsFullNames @FullName varchar(42) OUTPUT AS SELECT @FullName = LastName + ', ' + FirstName FROM Students WHERE StudentID = 8; GO When this procedure is executed, it would produce only the record stored in the 8th position of the table.
|
|
||
Previous | Copyright © 2007-2013, FunctionX | Home |
|