Archive for C#

13 Sep 2007

TinySQL Code Generator

4 Comments C#, Code Generation, Programming

TinySQL is small and handy SQL script which can quickly generate consistent code snippet that you can paste in your project. It basically operates by reading schema of provided table and applying template to each column of table in order to generate code snippet.

With TinySQL, you can create complete or specific portion of business class, business service, or data access layer. You can also generate repetitive code snippet like storing all DataReader columns into respective property of business object, or passing all object properties to SqlParameter in data access layer, or creating stored procedures for a table or creating simple update or insert statement in stored procedure etc.

TinySQL is part of my daily development practice. I am using early version of TinySQL for 2 years now and found myself more productive with this tool. I usually keep SQL Management Studio open (like most Microsoft application developers) all the time with a dedicated query pane for TinySQL. Whenever I need to write any repetitive code based on schema of any table, I simply provide table name, tweak template per my requirement and execute the script. I then copy and paste generated code in my project. Yes, I do require making minor changes sometime in generated code to make it usable in my project but still TinySQL serves its purpose.

TinySQL is definitely not a replacement of sophisticated code generation tools like CodeSmith, TierDeveloper, LLBLGen etc. Those tools are very advance and can generate code for whole project including user interface, business layer, data access layers and even store procedures. TinySQL can only generate basic code snippet that you can use in your existing code or project.

Download Link: TinySQL

Implementation of TinySQL is very simple and straight forward. It reads schema definition of all columns of provided table and template; it then render code by rotating loop for each column. Variable you have to take care in TinySQL are:

@TableName: table name for which you want to generate code
@PrintTableName: how above table name should display in generated code. You may have table “tblCategories” but you want “Category” for class name.
@Template: Template for generated code

Open TinySQL in SQL Management Studio, provide table name and template, press F5 to execute TinySQL and you will have generated code in result pane. Now you just have to copy generated code from result pane and paste in your project.

To make customization of template more flexible, I have used few tags as placeholder for rendering respective entity. These tags are:

$table    : TABLE name
$field    : COLUMN Name
$type     : .NET DATA Type
$default  : .NET DEFAULT Value
$sp_type  : SQL DATA Type
$length   : COLUMN Max Length
{loop}    : Start Loop
{/loop}   : End Loop

Suppose I want to generate snippet which has list of all columns of provided table. So value of TinySQL variables will be:

SET @TableName = 'tblCategory'
SET @PrintTableName = 'Category'
SET @Template = '
** generate simple column list /v1.0
$table: {loop}$field, {/loop}
'

It will generate code something like this:

Category: Id, LANGUAGE, ParentId, Name, SafeName, RIGHT, LEFT, IsEnabled, DisplayOrder, Color,

Note: first line of template is comment portion which can be used as template description, author, template version, additional comment etc.

You can play with TinySQL to explorer more about this tool.

Ok, so here are some practical examples of templates which explain the basic usage of TinySQL:

1. Listing all fields of provided table.

$table FIELDS:
{loop}$field, 
{/loop}

This template will generate list of field in separate lines.

2. Creating Simple SELECT statement:

SELECT {loop}$field, {/loop}
FROM $table

As I mentioned before, you may require minor modification sometime in generated code to use it in your project. Like in above case, you have to manual remove last comma from SELECT.

3. Creating UPDATE statement

UPDATE $table
SET {loop}$field = @$field, 
{/loop}

Again, you require removing last comma from generated code.

4. Creating Update Stored Procedure:

** generate DATA Provider: UPDATE/v1.0
CREATE PROCEDURE [dbo].[usp_Update$table]{loop}
	@$field = $sp_type,{/loop}
AS
BEGIN
 
	UPDATE dbo.$table WITH (ROWLOCK)
	SET {loop}
		$field = @$field,{/loop}
	WHERE --TODO
 
	RETURN -1
END

5. Creating simple insert statement:

** generate simple INSERT statement/v1.0
INSERT INTO $table ({loop}[$field],{/loop}
VALUES ({loop}@$field,{/loop}

6. Now, let’s use TinySQL to generate code snippet in C# (or VB.NET) which assign entity values to respective parameters of stored procedure.

** generate DATA Provider: UPDATE FUNCTION/v1.0
SqlDatabase DATABASE = new SqlDatabase(this._connectionString);
DbCommand commandWrapper = StoredProcedureProvider.GetCommandWrapper(DATABASE, "dbo.$table_Update", _useStoredProcedure);
{loop}DATABASE.AddInParameter(commandWrapper, "@$field", DbType.$type, entity.$field );
{/loop}

7. And as last example, here is template to generate business entity in C#.

** generate basic business entity/v1.0
#region Using Directives
 
using System;
using System.ComponentModel;
using System.Collections;
using System.Xml.Serialization;
using System.Runtime.Serialization;
 
#endregion
 
namespace MyNameSpace.Entities
{
    ///<summary>
    /// An object representation of the "$table" table.
    ///</summary>
    [Serializable, DataObject]
    public class $table
    {
        #region Variable Declarations
		{loop}
		private $type _$field;{/loop}
 
        #endregion Variable Declarations
 
        #region Constructors
 
        public $table()
        {
		 {loop}_$field = $default;
		{/loop}
		}
 
        #endregion
 
        #region Properties
		{loop}
		public $type $field
        {
            get
            {
                return this._$field;
            }
            set
            {
                this._$field = value;
            }
		}
		{/loop}
        #endregion
    }
}

Like last example, you can even create complete business service or data access layer using TinySQL.

I hope you will find this tool useful. Please do let me know if you found any bug or feature request.

UPDATE:
Please take latest version from TinySQL v2.0

18 Mar 2007

DOTENET: Favlet To Post Links

No Comments ASP.NET, C#, Web 2.0

Here is the small Favlets which can assist you to post links at DOTENET portal. Simply drag below hyperlink to toolbar of your browser. It will create a bookmark link at toolbar clicking on which can post current page to DOTENET portal.

Favlets: DOTENET: Submit
(drag this link to browser’s toolbar)

Here are small tutorials on installing Favlets in your browser:
How to use favlets
Bookmarklets – Browser Power
About Bookmarklets

How to use this Favlet? It’s just a matter of click now. If you find any article, post or blog useful simply click on the favlet at toolbar, this favlet will then navigate you to the submit page with URL, Title field already entered. Now you only have to provide description and tags. To further reduce navigating between source URL and DOTENET, you can follow these steps:

1. After finding any useful link, select abstract summary of article or post. If you want to provide your own description, skip this step.
2. Click on the “DOTENET: Submit” favlet. You will be redirect to submit page.
3. Provide tags in submit page. And you are done!

Please do let me know if you are facing any issue to submit post.

UPDATE: I have modified this favlet to send selected text of source article/post to DOTENET submit page. You now just have to select text and click on this favlet.

17 Jun 2006

Online C#/VB.NET Compiler!

5 Comments .NET Tools, C#

Yes, you can now compile your C# or VB.NET code online, simply put your code in the provided text box and click “Compile Now” button. Compilr will compile your code and provide you the link as well to download complied version of your code. Any error while compilation will display error message on page.

URL: Compilr

30 May 2006

Automating Your Builds With NAnt

No Comments .NET Tools, C#

NAnt is powerful scripting tool designed for developers, software process engineers, and build specialists to create an automated, repeatable process for building their developed application. Though its do assist developers to automate those same mundane tasks every evening but still most hesitate to use this tool their software developer process. NAnt provides powerful XML-based scripting and some really cool features, as Jean-Paul Boodhoo explains in his series of post “Automating Your Builds With NAnt”, which can streamline your development effort dramatically.

Automating Your Builds With NAnt – Part 1
Automating Your Builds With NAnt – Part 2
Automating Your Builds With NAnt – Part 3
Automating Your Builds With NAnt – Part 4
Automating Your Builds With NAnt – Part 5
Automating Your Builds With NAnt – Part 6
Automating Your Builds With NAnt – Part 7

28 May 2006

Guideline on Object Design

1 Comment C#, Programming

Alan has written a series of some good class design and implementation guidelines post.
URL: Object Design and Implementation

Rule #1: Practice Drawing Make Good Classes
Rule #2: Documation!
Rule #3: Alan’s Class Template (“ACT”)
Rule #4: Never Walk, But Fly!!!
Rule #5: Always evaluate How We Fly!
Rule #6: No Private Variable Shall Have Direct Access to the Class Public Interface
Rule #7 & #8: All about Numbers!!