Generate Custom Business Object Properties from SQL Server Tables

-

In the never ending debate between using datasets and using custom business objects (CBOs), one of the main knocks on CBOs is that they take more time to code. You have to write the properties and create getters and setters for each, code the DB calls, etc.

Of course, you could always get yourself a code generator but those cost money. On the other hand, Sql Server 2005 has made this a little easier with some System Views. Look at the Information_Schema views and you’ll find a whole bunch of really nice info. The one we’re going to use today is the Columns view.

The first steps we need is to be able to convert from Sql datatypes to .Net types. This handy little Sql function will do our conversion for us. You can simply delete the function when our done generating.

SET ANSI_NULLS ON
GO
SET QUOTED_IDENTIFIER ON
GO
-- =============================================
-- Create date: 03/15/2007
-- Description: Returns the correct Net datatype
-- from Sql datatype
-- =============================================
CREATE FUNCTION GetNetDataType(
    @SqlDataType nvarchar(128)
)
RETURNS nvarchar(128)
AS
BEGIN
-- Declare the return variable here
    DECLARE @NetDataType nvarchar(128)
    SELECT @NetDataType = CASE
        WHEN @SqlDataType = 'varbinary' THEN 'Byte[]'
        WHEN @SqlDataType = 'binary' THEN 'Byte[]'
        WHEN @SqlDataType = 'varchar' THEN 'String'
        WHEN @SqlDataType = 'char' THEN 'String'
        WHEN @SqlDataType = 'nvarchar' THEN 'String'
        WHEN @SqlDataType = 'nchar' THEN 'String'
        WHEN @SqlDataType = 'text' THEN 'String'
        WHEN @SqlDataType = 'ntext' THEN 'String'
        WHEN @SqlDataType = 'uniqueidentifier' THEN 'Guid'
        WHEN @SqlDataType = 'rowversion' THEN 'Byte[]'
        WHEN @SqlDataType = 'bit' THEN 'Boolean'
        WHEN @SqlDataType = 'tinyint' THEN 'Byte'
        WHEN @SqlDataType = 'smallint' THEN 'Int16'
        WHEN @SqlDataType = 'int' THEN 'Integer'
        WHEN @SqlDataType = 'bigint' THEN 'Int64'
        WHEN @SqlDataType = 'smallmoney' THEN 'Decimal'
        WHEN @SqlDataType = 'money' THEN 'Decimal'
        WHEN @SqlDataType = 'numeric' THEN 'Decimal'
        WHEN @SqlDataType = 'decimal' THEN 'Decimal'
        WHEN @SqlDataType = 'real' THEN 'Single'
        WHEN @SqlDataType = 'float' THEN 'Double'
        WHEN @SqlDataType = 'smalldatetime' THEN 'DateTime'
        WHEN @SqlDataType = 'datetime ' THEN 'DateTime'
        END
        
    RETURN @NetDataType
END
GO

Now we can run a query against Information_Schema.Columns to get the columns of our table and gen the code for the properties. I’ve included VB and C# codes. It may be easier to get the code from the Text (Ctrl-T) of the result window rather than the grid view (Ctrl-D).

DECLARE @CRLF as varchar(2)
Set @CRLF = CHAR(13) + CHAR(10)
DECLARE @TAB as varchar(2)
Set @TAB = CHAR(9)
-- This produces VB code
SELECT 'private m' + Column_Name + ' as ' + dbo.GetNetDataType(data_type) + @CRLF
    + 'Public Property ' + Column_Name + ' as ' + + dbo.GetNetDataType(data_type) + @CRLF
    + 'Get' + @CRLF
    + 'return m' + Column_Name + @CRLF
    + 'End Get' + @CRLF
    + 'Set(value as ' + dbo.GetNetDataType(data_type) + ')' + @CRLF
    + 'm' + Column_Name + ' = value ' + @CRLF
    + 'End Set' + @CRLF
    + 'End Property' + @CRLF + @CRLF
FROM information_schema.columns
WHERE Table_Name = 'MyTable'
ORDER BY Column_Name

-- This produces C# code
SELECT @TAB + 'private ' + dbo.GetNetDataType(data_type) + ' m' + Column_Name + ';' + @CRLF
    + @TAB + 'public ' + dbo.GetNetDataType(data_type) + ' ' + Column_Name + ' {' + @CRLF
    + @TAB + @TAB + 'get {' + @CRLF
    + @TAB + @TAB + @TAB + 'return m' + Column_Name + ';' + @CRLF
    + @TAB + @TAB +  '}' + @CRLF
    + @TAB + @TAB + 'set { ' + @CRLF
    + @TAB + @TAB + @TAB + 'm' + Column_Name + ' = value;' + @CRLF
    + @TAB + @TAB + '}' + @CRLF
    + @TAB + '}' + @CRLF  + @CRLF
FROM information_schema.columns
WHERE Table_Name = 'MyTable'
ORDER BY Column_Name
Next time I’ll look at how to generate the parameters for your stored procedures.

Comments

Post a Comment

Popular posts from this blog

Migrating Legacy Apps to the New SimpleMembership Provider

-
Image
Asp.Net MVC4 uses the new SimpleMembership provider, changes the table structure and adds a new hashing algorithm. The reasons for the changes can be found in this article by Jon Galloway. This article shows how to migrate your existing apps to the new provider. I’m assuming that you stored your passwords in the unrecoverable SHA-1 format. If you didn’t, then you’ll have to change a couple of things. All of my apps are done this way so… I’m also assuming that you have created the basic skeleton of the new app and ran it once so the correct tables will be created. First, we’ll look at the new tables. Previously, we had all of those aspnet_xxxxxx tables. Here’s the new ones. UserProfile Contains all of the elements relevant to the user. This is a combination of the aspnet_Users table and the aspnet_Profiles table. webpages_Membership Stores the password info when not using OAuth, Live, Facebook, etc. This table is somewhat of a match to the aspnet_Membership table. webpage...
Read more

Windows 8 Keyboard Shortcuts

-
Image
There are numerous posts on the keyboard shortcuts in Windows 8. I’m not going to regurgitate those. Here are the common things you’ll want to do. Shut Your Computer Off, Network / Wi-Fi, Volume, Keyboard Press Windows+I which brings up the Settings bar (below left). Search, Change Application Settings, Manage Devices Windows+C which brings up the Charms bar (above right). Want to find a song or artist in Music, use The rest of the story If you want to read about other short-cuts and print a handy-dandy cheat sheet, visit the Windows Experience Blog . IE 10 Want to get the most out of IE10, then How-To Geek’s The Best Tips and Tricks for Getting the Most out of Internet Explorer 10 is exactly what you need. There’s also Internet Explorer 10 Shortcut Keys In Windows 8 which has some Windows 8 stuff also.
Read more

Get Asp.Net Profile properties from Sql

-
Image
Ever wanted to include the profile information from an Asp.Net profile in a query? It’s not that hard once you understand the structure. I’ve written a little function that does all the work. Note: I’m using Sql Server as my repository. First we need to understand how the profile data is stored. Looking at the aspnet_Profile table, we can see that it stores the information in two columns: PropertyNames and PropertyValuesString. Looking at PropertyNames we can see that it has a basic structure of Property Name, Data Type, Starting Position and Length. For example, in the string “FirstName:S:0:4:Phone:S:4:10:LastName:S:14:5:” we can see that FirstName is of type string, starts at position 0 and has a length of 4. Notice the zero base for the starting position, we need to correct for that in our function. This means in the PropertyValuesString “John2175551212Smith”, we would start with the first position and proceed 4 c...
Read more