Csharp Code Samples

For almost every Nhibernate beginner the most challenging thing to do is implement a parent child or one to many relation. There are many articles about this on the net some very basic and some highly detailed. But most samples available do not run when you download them giving all sorts of Nhibernate errors, which well obviously make no sense to someone who is using Nhibernate for the first time.

So this is my attempt at building a small Nhibernate one to many sample that will hopefully run without any issues and help in implementing basic relations using Nhibernate.

The Database Structure

The database structure I have chosen is a one to many relation between Department and User, where one department can have multiple users. The entity relation diagram is as shown below.

Building the ORM

We will be building a new class library which may be considered as a data layer using Nhibernate. The object relation mapping for Nhibernate needs to be defined as shown below.

The class structure is exactly similar to the database entity diagram shown above. Each property in the class maps to a column in the database. However you may notice that there is no Department Id column in User class. Instead the foreign key relation is established by the user list defined in Department class. This collection is similar to a foreign key relation in the database.

The next step is to define the Database to Class mapping in XML files. For the user class create a new XML file and name it User.hbm.xml. The .hbm is required for Nhibernate to compile it.

Show Code

<?xml version="1.0" encoding="utf-8" ?>
<hibernate-mapping xmlns="urn:nhibernate-mapping-2.2"
        namespace="NHibernateSample" assembly="NHibernateSample">
	<class name="User" table="USER_DATA">
		<id name="UserId" column="USER_ID">
			<generator class="native" />
		</id>
		<property name="UserName">
			<column name="USER_NAME" not-null="true" />
		</property>
		<property name="Email">
			<column name="EMAIL" not-null="true" />
		</property>
	</class>
</hibernate-mapping>

Similarly for the department class define an Department.hbm.xml file as shown below.

Show Code

<?xml version="1.0" encoding="utf-8" ?>
<hibernate-mapping xmlns="urn:nhibernate-mapping-2.2"
        namespace="NHibernateSample" assembly="NHibernateSample">
	<class name="Department" table="DEPARTMENT">
		<id name="DepartmentId" column="DEPARTMENT_ID">
			<generator class="native" />
		</id>
		<property name="DepartmentName">
			<column name="DEPARTMENT_NAME" not-null="true" />
		</property>
		<bag name="UserList" cascade="all" lazy="false">
			<key column="DEPARTMENT_ID"/>
			<one-to-many class="User"/>
		</bag>
	</class>
</hibernate-mapping>

For the collection we use a tag called bag which defines relation between the two classes.

Now one at a time right click the hbm files and in their properties set the Build Action as Embedded Resource. This will embed the xml files in the dll.

Building A Session Factory

For Nhibernate to connect to a database we need to declare a Session Factory which will build an Nhibernate session.

Show Code

class SessionFactory
{
    private static Configuration config;

    static SessionFactory()
    {
        if (config == null)
        {
            config = new Configuration();
            config.Configure();
            config.AddAssembly("NHibernateSample");
        }
    }

    public static ISession Session
    {
        get { return config.BuildSessionFactory().OpenSession(); }
    }
}

Performing Operations

Create a new session object for performing operations on database. For example to create a new department declare a department object and save it using ISession.Save(object).

Show Code

public static void Add(Department department)
{
    using (ISession session = SessionFactory.Session)
    {
        using (ITransaction transaction = session.BeginTransaction())
        {
            session.Save(department);
            transaction.Commit();
        }
    }
}

Refer the attached sample for more operations.

Running the Sample

The sample contains a SQL 2008 database mdf file which contains the table structure required to test the sample. Open the App.config file in TestProject and modify the connection string and give the exact location of that file on your file system. Also provide the user name password for your local sql server instance.

Show Code

<property name="connection.connection_string">
  Server=.\SQLExpress;
  AttachDbFilename=C:\NHibernateSample\TestDatabase\TestDatabase.mdf;
  user=username;password=password;
</property>

If you have an instance of SQL server 2005 installed, modify the dialect tag as shown below.

Show Code

<property name="dialect">
  NHibernate.Dialect.MsSql2005Dialect
</property>

Download Sample
NHibernateSample.zip