Click here to Skip to main content
65,938 articles
CodeProject is changing. Read more.
Articles / database / SQL-Server

NHibernate Helper Kit

3.59/5 (39 votes)
19 Aug 2006GPL32 min read 4   5.7K  
Here is a tool to help you build your NHibernate ORM applications.

Screenshot - figure6.gif

Introduction

Here is a tool for the use of your own applications that NHibernate. You can easily install and use this helper kit. To download, please click the link at the top of the page. If you are using NHibernate, you need to write a lot of persistent classes and XML mapping for each persistent class. Also, you need to write the NHibernate config file. At this point, using this tool, you can automatically create all these files in a few seconds.

Installing

After you download the installation files, unzip the file and open the folder. Then, you will see the following:

  • Setup.exe (shortcut): You can install the add-in via this installer.
  • Files (folder): All the needed files are here.

Open setup.exe and you will see the following interface:

Screenshot - figure1.gif

Click Run, and it will install itself; it will take a few seconds.

Using

After the installation, run Visual Studio 2005 and go to the Tools menu. You will see an add-in that is named Avva Mobile NHibernate Helper Kit BETA. There are four tab screens on the tool.

  1. Connection: This screen allows you to connect your database with connection parameters. It looks like the Visual Studio connection wizard. You need to set some parameters to connect to your database.
  2. Screenshot - figure2.gif

  3. Tables & Columns: This screen allows you to browse a selected database's tables and select them to create files. Also, if you want, you can see a table's column information by selecting from a table from a list and clicking "Preview Columns".
  4. Screenshot - figure3.gif

    Screenshot - figure4.gif

  5. Settings: This screen allows you to select some features, for example, copy the NHibernate DLL and use dynamic updates. Also, you have to select your project folder to configure the folders, namespaces, and assembly names.
  6. Screenshot - figure5.gif

  7. Generate: At the end of this, we can start the generate process. Just click Run and wait a few seconds. You can view all the process details in this section.
  8. Screenshot - figure6.gif

    After you've successfully completed the generating process, you can see the generated files in the project folder. If you selected "Copy NHibernate DLL to project" and other DLLs, the generator will copy it and create an NHibernate config file in your project's "bin" folder.

    Copies files to bin directory

    Also, the generator creates a folder named App_Code in your project folder to put persistent classes and mapping files in. It directly creates persistent classes to App_Code, and mapping files creates them in the NHMappings folder, as follows:

    App_Code folder for persistent classes

    NHMappings folder for mapping XML files

Let's check it out how it's looking.

Persistent class

Persistent class

Mapping the XML file

Mapping XML file

The next version will have...

  • VB.NET and C# language support
  • Table relationships
  • A sample using application blocks
  • Generic class implementation
  • And more according to your ideas, thoughts, and suggestions...

License

This article, along with any associated source code and files, is licensed under The GNU General Public License (GPLv3)