Click here to Skip to main content
Click here to Skip to main content

Tagged as

Go to top

Exposing a Stored Procedure in WCF Data Service

, 25 Oct 2010
Rate this:
Please Sign up or sign in to vote.
Exposing a Stored Procedure in WCF Data Service Today I answered a question in the data platform development forums. The question was simple – how to expose a stored procedure which is mapped to an Entity Framework model through a WCF Data Service. This post will show you exactly how to do this. T

Today I answered a question in the data platform development forums. The question was simple – how to expose a stored procedure which is mapped to an Entity Framework model through a WCF Data Service. This post will show you exactly how to do this.

The Stored Procedure

First I’ve created a the following stored procedure:

CREATE PROCEDURE dbo.GetCoursesOrderByTitle
AS

BEGIN
    SET NOCOUNT ON 

    SELECT CourseID, Title, Days, [Time], Location, Credits, DepartmentID
    FROM Course

    ORDER BY Title ASC
END

The procedure is simple and returns all the courses ordered by title. Of course this could be achieved by the use of LINQ to Data Services but I wanted to show the concept of exposing SP in your WCF Data Service.

The Model

After creating the stored procedure I’ve created the Entity Framework model which for simplicity holds only a course entity and also map the stored procedure as a FunctionImport in the model. If you want to understand how to create this sort of mapping go to a old post I wrote about it. The model will look like:

Entity Designer Diagram   Model Browser

Creating the WCF Data Service

After we have our model lets create the WCF Data Service. In order to expose the stored procedure we will have to create a service operation method. Service operations are endpoints that you can create in WCF Data Services in order to add business logic that can’t be supported by the service RESTful interface. These endpoints are consumed like any other endpoints in the REST interface that the WCF Data Service exposes. For further reading about Service Operations I recommend these two posts:

Lets look at the service:

public class SchoolDataService : DataService<SchoolEntities>
{

  public static void InitializeService(DataServiceConfiguration config)
  {

    config.SetEntitySetAccessRule("Courses", EntitySetRights.AllRead);
    config.SetServiceOperationAccessRule("GetCoursesOrderByTitle", ServiceOperationRights.AllRead);

    config.DataServiceBehavior.MaxProtocolVersion = DataServiceProtocolVersion.V2;
  }

 
  [WebGet]

  public IQueryable<Course> GetCoursesOrderByTitle()
  {

    return CurrentDataSource
      .GetCoursesOrderByTitle()

      .AsQueryable();
  }

}

As you can see I use the CurrentDataSource in order to get the Entity Framework ObjectContext and then to execute the stored procedure using its FunctionImport. I also need to set the service operation access rule in order to expose the operation. If I want to consume the service operation right now and not from a client I can view the service in browser and then create the following link for example in order to call the operation:

http://localhost:43054/SchoolDataService.svc/GetCoursesOrderByTitle  

And the result will be:
Runing Service Operation

Summary

Exposing a stored procedure through WCF Data Services can be achieved by providing service endpoints using the service operation feature. In the post I showed how you can do that by using Entity Framework.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Gil Fink
Technical Lead sparXys
Israel Israel
Gil Fink is a web development expert and ASP.Net/IIS Microsoft MVP. He is the founder and owner of sparXys. He is currently consulting for various enterprises and companies, where he helps to develop Web and RIA-based solutions. He conducts lectures and workshops for individuals and enterprises who want to specialize in infrastructure and web development. He is also co-author of several Microsoft Official Courses (MOCs) and training kits, co-author of "Pro Single Page Application Development" book (Apress) and the founder of Front-End.IL Meetup. You can read his publications at his website: http://www.gilfink.net
Follow on   Twitter   Google+   LinkedIn

Comments and Discussions

 
QuestionHow to consume the result in PHP PinmemberMember 79208638-Aug-12 7:59 
QuestionParameters PinmemberObeleh5-Jul-12 4:42 
AnswerRe: Parameters PinmemberObeleh5-Jul-12 5:08 
GeneralMy vote of 2 Pinmembersnehaljogiya2-May-12 17:09 
GeneralRe: My vote of 2 PinmemberRajinder Singh17-Jan-13 9:09 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web01 | 2.8.140916.1 | Last Updated 25 Oct 2010
Article Copyright 2010 by Gil Fink
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid