NHibernate 2.0

NHibernate Documentation Structure Proposal

abhishek644 — Wed, 08 Feb 2012 12:25:58 GMT

Current revision posted to NHibernate 2.0 by abhishek644 on 08/02/2012 09:25:58 a.m.

NHibernate Documentation Structure Proposal

Filed under: Nhibernate Documentation

This is a proposal for a new structure of the NHibernate reference documentation. The goal is to discuss it and get some feedback from the community.

Goals

The goals of the restructuring of the documentation are:

move from "feature oriented" to "solution oriented". For instance, instead of having a chapter about the "version" xml element, there is a chapter about "concurrency". So the reader has a problem to solve, and he finds a chapter that explains, how NH solves it. The reader can't know that he needs a version element. Such a chapter should cover all elements of a certain problem, in the given example this are the version xml-element, the optimistic-lock xml-attribute of classes and properties, explicit version increment, locking and so on.
Additionally, there shall be a complete reference of the mappings, configurations and others in an appendix that links to the chapters.
More diagrams for mapping strategies
More best practices and patterns
Fill gaps where the documentation is not complete (enough), for instance special HQL features, user types, interceptors and events, connection factories and other extensions, (new) proxy factories etc.

Structure

Part 1: First Steps

In this part: a high-level overview of the whole picture.

Quick start

simple program that runs "out of the box"
not too much code, not too much explanation (but links to chapters)
includes inheritance, reference, list
includes schema generation
includes some simple hql
includes configuration for sqlserver, oracle, mysql

Architecture and basic concepts

Architecture (diagrams)
"Factory-Chain" Configuration => SessionFactory => Session => Transaction / Query
Instance States
Session Cache (see also "Working with persistent objects")
Application Architectures (referenced assemblies from application layers)

Setting Up

Three ways: nhibernate.cfg.xml, app.config, programmatic
Dialects and Drivers (See also Appendix "full list of Drivers / Dialects")
ProxyFactory configuration (see "lazy loading")
SessionProvider, contextual sessions
Getting a connection (connection provider, user provided, connection release mode)
How to set up a Project, minimal program
- configuration file
- mapping files (see "OR Mapping Basics")

Part 2: Writing and Mapping Classes

In this part: Static view, classes, mappings, db schema

Persistent classes

Example poco, basic rules
Object Identity
- id generators
- best practices
- composite keys (see also "Working with legacy databases")
- component keys (see also "Working with legacy databases")
Overriding Equals and GetHashCode
Optional: Version (see optimistic locking)
lifecycle callbacks
validation
see also: lazy loading (because of virtual)

OR Mapping Basics

Manage mapping files
- as xml files
- as embedded resources
- modular mapping files
- alternatives (attributes, FNH)
Using quoted identifiers
- NH Types (see also: "Extend NH behaviour - user types", Appendix "Full List of Types")
Naming conventions
Property / field (access strategy)

Mapping primitive values and single ended references

properties
references many-to-one
references one-to-one
map several classes to one table: components
dynamic components
map a class to several tables: join
any types

Mapping Collections

persistent collections
set, list, map, bag, array, primitive-array
one-to-many relations
many-to-many relations
composite-elemements
collection performance
Sorted collections

Mapping Inheritance

Table per Hierarchy
Table per Concrete Class
Table per Class
Mixing strategies

Mapping to legacy databases

composite keys
component keys
property-ref

Generating The Database

The schema export tool
not null
foreign keys
indexes
unique keys
Auxiliary Database Objects

mapping file generation from entity

Part 3: Working with Persistent Objects

In this part: Dynamic view, sessions, queries, modifications, transactions etc.

Working with sessions

sessions, session cache, flushing
cascading
detached objects, reattaching

Querying

Introduction, when to use which kind of query

HQL Queries

Syntax
Multi Query

Criteria Queries

API
Multi Criteria

Using NH filters

Lazy loading and fetching strategies

fetching strategies
collections
references (proxies)
load
Utility.Initialize
batch fetching

Updating and deleting

updating, batch-updates, HQL updates
deleting, one-shot-delete, HQL delete

Transactions And Concurrency

Transaction factory (see also: setting up)
Concurrency
- Optimistic Locking
  - Version columns
  - Property level
  - Force version increment
  - application version check
- Pessimistic Locking

Part 4: Enhanced Features

In this part: Features that are not used by everyone. They are not important to understand to work with NH.

Using Native SQL

Sql queries
custom SQL for query/update/insert/delete
precompiled queries
Using SP's, db functions and triggers
- property update/insert
- property generated
- property formula
- see also: "Generating The Database - Auxiliary Database Objects"
Using Database Views

Caches

second level cache
query cache

Meta API

Extend NH behaviour

user types
Interceptors
events
connection provider
transaction factory
session provider

Part 5: Examples

In this part: examples

Appendix

In this part: lists and references. The references (eg. mapping xml elements, dialects etc are important to find the documentation. So there are basically only links to chapters)

Trouble shooting

Configuration Reference

Getting a connection (connection provider, user provided) (setting up)
proxy generator (lazy loading)
cache configuration (optimizing)
Transaction factory (setting up)
Dialects (setting up)
Outer join fetching (lazy loading?)
logging (trouble shooting)
naming strategy (mapping)

Full List of Dialiects

Full List of Drivers

XML-Mapping full reference

Full List of Type

[http://ghrindustries.net/

On the other hand if you intend to produce a large amount of Screen Printing Machine] items, you will have to invest in the industry.

NHibernate Documentation Structure Proposal

abhishek644 — Wed, 08 Feb 2012 12:24:17 GMT

Revision 9 posted to NHibernate 2.0 by abhishek644 on 08/02/2012 09:24:17 a.m.

NHibernate Documentation Structure Proposal

Filed under: Nhibernate Documentation

This is a proposal for a new structure of the NHibernate reference documentation. The goal is to discuss it and get some feedback from the community.

Goals

The goals of the restructuring of the documentation are:

move from "feature oriented" to "solution oriented". For instance, instead of having a chapter about the "version" xml element, there is a chapter about "concurrency". So the reader has a problem to solve, and he finds a chapter that explains, how NH solves it. The reader can't know that he needs a version element. Such a chapter should cover all elements of a certain problem, in the given example this are the version xml-element, the optimistic-lock xml-attribute of classes and properties, explicit version increment, locking and so on.
Additionally, there shall be a complete reference of the mappings, configurations and others in an appendix that links to the chapters.
More diagrams for mapping strategies
More best practices and patterns
Fill gaps where the documentation is not complete (enough), for instance special HQL features, user types, interceptors and events, connection factories and other extensions, (new) proxy factories etc.

Structure

Part 1: First Steps

In this part: a high-level overview of the whole picture.

Quick start

simple program that runs "out of the box"
not too much code, not too much explanation (but links to chapters)
includes inheritance, reference, list
includes schema generation
includes some simple hql
includes configuration for sqlserver, oracle, mysql

Architecture and basic concepts

Architecture (diagrams)
"Factory-Chain" Configuration => SessionFactory => Session => Transaction / Query
Instance States
Session Cache (see also "Working with persistent objects")
Application Architectures (referenced assemblies from application layers)

Setting Up

Three ways: nhibernate.cfg.xml, app.config, programmatic
Dialects and Drivers (See also Appendix "full list of Drivers / Dialects")
ProxyFactory configuration (see "lazy loading")
SessionProvider, contextual sessions
Getting a connection (connection provider, user provided, connection release mode)
How to set up a Project, minimal program
- configuration file
- mapping files (see "OR Mapping Basics")

Part 2: Writing and Mapping Classes

In this part: Static view, classes, mappings, db schema

Persistent classes

Example poco, basic rules
Object Identity
- id generators
- best practices
- composite keys (see also "Working with legacy databases")
- component keys (see also "Working with legacy databases")
Overriding Equals and GetHashCode
Optional: Version (see optimistic locking)
lifecycle callbacks
validation
see also: lazy loading (because of virtual)

OR Mapping Basics

Manage mapping files
- as xml files
- as embedded resources
- modular mapping files
- alternatives (attributes, FNH)
Using quoted identifiers
- NH Types (see also: "Extend NH behaviour - user types", Appendix "Full List of Types")
Naming conventions
Property / field (access strategy)

Mapping primitive values and single ended references

properties
references many-to-one
references one-to-one
map several classes to one table: components
dynamic components
map a class to several tables: join
any types

Mapping Collections

persistent collections
set, list, map, bag, array, primitive-array
one-to-many relations
many-to-many relations
composite-elemements
collection performance
Sorted collections

Mapping Inheritance

Table per Hierarchy
Table per Concrete Class
Table per Class
Mixing strategies

Mapping to legacy databases

composite keys
component keys
property-ref

Generating The Database

The schema export tool
not null
foreign keys
indexes
unique keys
Auxiliary Database Objects

mapping file generation from entity

Part 3: Working with Persistent Objects

In this part: Dynamic view, sessions, queries, modifications, transactions etc.

Working with sessions

sessions, session cache, flushing
cascading
detached objects, reattaching

Querying

Introduction, when to use which kind of query

HQL Queries

Syntax
Multi Query

Criteria Queries

API
Multi Criteria

Using NH filters

Lazy loading and fetching strategies

fetching strategies
collections
references (proxies)
load
Utility.Initialize
batch fetching

Updating and deleting

updating, batch-updates, HQL updates
deleting, one-shot-delete, HQL delete

Transactions And Concurrency

Transaction factory (see also: setting up)
Concurrency
- Optimistic Locking
  - Version columns
  - Property level
  - Force version increment
  - application version check
- Pessimistic Locking

Part 4: Enhanced Features

In this part: Features that are not used by everyone. They are not important to understand to work with NH.

Using Native SQL

Sql queries
custom SQL for query/update/insert/delete
precompiled queries
Using SP's, db functions and triggers
- property update/insert
- property generated
- property formula
- see also: "Generating The Database - Auxiliary Database Objects"
Using Database Views

Caches

second level cache
query cache

Meta API

Extend NH behaviour

user types
Interceptors
events
connection provider
transaction factory
session provider

Part 5: Examples

In this part: examples

Appendix

In this part: lists and references. The references (eg. mapping xml elements, dialects etc are important to find the documentation. So there are basically only links to chapters)

Trouble shooting

Configuration Reference

Getting a connection (connection provider, user provided) (setting up)
proxy generator (lazy loading)
cache configuration (optimizing)
Transaction factory (setting up)
Dialects (setting up)
Outer join fetching (lazy loading?)
logging (trouble shooting)
naming strategy (mapping)

Full List of Dialiects

Full List of Drivers

XML-Mapping full reference

Full List of Type

[http://ghrindustries.net/ Screen Printing Machine]

NHibernate Documentation Structure Proposal

John Davidson — Wed, 16 Nov 2011 12:01:31 GMT

Revision 8 posted to NHibernate 2.0 by John Davidson on 16/11/2011 09:01:31 a.m.

NHibernate Documentation Structure Proposal

Filed under: Nhibernate Documentation

This is a proposal for a new structure of the NHibernate reference documentation. The goal is to discuss it and get some feedback from the community.

Goals

The goals of the restructuring of the documentation are:

move from "feature oriented" to "solution oriented". For instance, instead of having a chapter about the "version" xml element, there is a chapter about "concurrency". So the reader has a problem to solve, and he finds a chapter that explains, how NH solves it. The reader can't know that he needs a version element. Such a chapter should cover all elements of a certain problem, in the given example this are the version xml-element, the optimistic-lock xml-attribute of classes and properties, explicit version increment, locking and so on.
Additionally, there shall be a complete reference of the mappings, configurations and others in an appendix that links to the chapters.
More diagrams for mapping strategies
More best practices and patterns
Fill gaps where the documentation is not complete (enough), for instance special HQL features, user types, interceptors and events, connection factories and other extensions, (new) proxy factories etc.

Structure

Part 1: First Steps

In this part: a high-level overview of the whole picture.

Quick start

simple program that runs "out of the box"
not too much code, not too much explanation (but links to chapters)
includes inheritance, reference, list
includes schema generation
includes some simple hql
includes configuration for sqlserver, oracle, mysql

Architecture and basic concepts

Architecture (diagrams)
"Factory-Chain" Configuration => SessionFactory => Session => Transaction / Query
Instance States
Session Cache (see also "Working with persistent objects")
Application Architectures (referenced assemblies from application layers)

Setting Up

Three ways: nhibernate.cfg.xml, app.config, programmatic
Dialects and Drivers (See also Appendix "full list of Drivers / Dialects")
ProxyFactory configuration (see "lazy loading")
SessionProvider, contextual sessions
Getting a connection (connection provider, user provided, connection release mode)
How to set up a Project, minimal program
- configuration file
- mapping files (see "OR Mapping Basics")

Part 2: Writing and Mapping Classes

In this part: Static view, classes, mappings, db schema

Persistent classes

Example poco, basic rules
Object Identity
- id generators
- best practices
- composite keys (see also "Working with legacy databases")
- component keys (see also "Working with legacy databases")
Overriding Equals and GetHashCode
Optional: Version (see optimistic locking)
lifecycle callbacks
validation
see also: lazy loading (because of virtual)

OR Mapping Basics

Manage mapping files
- as xml files
- as embedded resources
- modular mapping files
- alternatives (attributes, FNH)
Using quoted identifiers
- NH Types (see also: "Extend NH behaviour - user types", Appendix "Full List of Types")
Naming conventions
Property / field (access strategy)

Mapping primitive values and single ended references

properties
references many-to-one
references one-to-one
map several classes to one table: components
dynamic components
map a class to several tables: join
any types

Mapping Collections

persistent collections
set, list, map, bag, array, primitive-array
one-to-many relations
many-to-many relations
composite-elemements
collection performance
Sorted collections

Mapping Inheritance

Table per Hierarchy
Table per Concrete Class
Table per Class
Mixing strategies

Mapping to legacy databases

composite keys
component keys
property-ref

Generating The Database

The schema export tool
not null
foreign keys
indexes
unique keys
Auxiliary Database Objects

mapping file generation from entity

Part 3: Working with Persistent Objects

In this part: Dynamic view, sessions, queries, modifications, transactions etc.

Working with sessions

sessions, session cache, flushing
cascading
detached objects, reattaching

Querying

Introduction, when to use which kind of query

HQL Queries

Syntax
Multi Query

Criteria Queries

API
Multi Criteria

Using NH filters

Lazy loading and fetching strategies

fetching strategies
collections
references (proxies)
load
Utility.Initialize
batch fetching

Updating and deleting

updating, batch-updates, HQL updates
deleting, one-shot-delete, HQL delete

Transactions And Concurrency

Transaction factory (see also: setting up)
Concurrency
- Optimistic Locking
  - Version columns
  - Property level
  - Force version increment
  - application version check
- Pessimistic Locking

Part 4: Enhanced Features

In this part: Features that are not used by everyone. They are not important to understand to work with NH.

Using Native SQL

Sql queries
custom SQL for query/update/insert/delete
precompiled queries
Using SP's, db functions and triggers
- property update/insert
- property generated
- property formula
- see also: "Generating The Database - Auxiliary Database Objects"
Using Database Views

Caches

second level cache
query cache

Meta API

Extend NH behaviour

user types
Interceptors
events
connection provider
transaction factory
session provider

Part 5: Examples

In this part: examples

Appendix

In this part: lists and references. The references (eg. mapping xml elements, dialects etc are important to find the documentation. So there are basically only links to chapters)

Trouble shooting

Configuration Reference

Getting a connection (connection provider, user provided) (setting up)
proxy generator (lazy loading)
cache configuration (optimizing)
Transaction factory (setting up)
Dialects (setting up)
Outer join fetching (lazy loading?)
logging (trouble shooting)
naming strategy (mapping)

Full List of Dialiects

Full List of Drivers

XML-Mapping full reference

Looking for the best Sims 3 cheats PC?We are gonna reveal them to you and get you famous on Sims 3 and Text Twist.

Full List of Types

scrabble word finder cheatType

NHibernate Documentation Structure Proposal

abhishek644 — Wed, 16 Nov 2011 11:50:19 GMT
Revision 7 posted to NHibernate 2.0 by abhishek644 on 16/11/2011 08:50:19 a.m.

NHibernate Documentation Structure Proposal

Filed under: Nhibernate Documentation

This is a proposal for a new structure of the NHibernate reference documentation. The goal is to discuss it and get some feedback from the community.

Goals

The goals of the restructuring of the documentation are:

move from "feature oriented" to "solution oriented". For instance, instead of having a chapter about the "version" xml element, there is a chapter about "concurrency". So the reader has a problem to solve, and he finds a chapter that explains, how NH solves it. The reader can't know that he needs a version element. Such a chapter should cover all elements of a certain problem, in the given example this are the version xml-element, the optimistic-lock xml-attribute of classes and properties, explicit version increment, locking and so on.

Additionally, there shall be a complete reference of the mappings, configurations and others in an appendix that links to the chapters.

More diagrams for mapping strategies

More best practices and patterns

Fill gaps where the documentation is not complete (enough), for instance special HQL features, user types, interceptors and events, connection factories and other extensions, (new) proxy factories etc.

Structure

Part 1: First Steps

In this part: a high-level overview of the whole picture.

Quick start

simple program that runs "out of the box"

not too much code, not too much explanation (but links to chapters)

includes inheritance, reference, list

includes schema generation

includes some simple hql

includes configuration for sqlserver, oracle, mysql

Architecture and basic concepts

Architecture (diagrams)

"Factory-Chain" Configuration => SessionFactory => Session => Transaction / Query

Instance States

Session Cache (see also "Working with persistent objects")

Application Architectures (referenced assemblies from application layers)

Setting Up

Three ways: nhibernate.cfg.xml, app.config, programmatic

Dialects and Drivers (See also Appendix "full list of Drivers / Dialects")

ProxyFactory configuration (see "lazy loading")

SessionProvider, contextual sessions

Getting a connection (connection provider, user provided, connection release mode)

How to set up a Project, minimal program

configuration file

mapping files (see "OR Mapping Basics")

Part 2: Writing and Mapping Classes

In this part: Static view, classes, mappings, db schema

Persistent classes

Example poco, basic rules

Object Identity

id generators

best practices

composite keys (see also "Working with legacy databases")

component keys (see also "Working with legacy databases")

Overriding Equals and GetHashCode

Optional: Version (see optimistic locking)

lifecycle callbacks

validation

see also: lazy loading (because of virtual)

OR Mapping Basics

Manage mapping files

as xml files

as embedded resources

modular mapping files

alternatives (attributes, FNH)

Using quoted identifiers

NH Types (see also: "Extend NH behaviour - user types", Appendix "Full List of Types")

Naming conventions

Property / field (access strategy)

Mapping primitive values and single ended references

properties

references many-to-one

references one-to-one

map several classes to one table: components

dynamic components

map a class to several tables: join

any types

Mapping Collections

persistent collections

set, list, map, bag, array, primitive-array

one-to-many relations

many-to-many relations

composite-elemements

collection performance

Sorted collections

Mapping Inheritance

Table per Hierarchy

Table per Concrete Class

Table per Class

Mixing strategies

Mapping to legacy databases

composite keys

component keys

property-ref

Generating The Database

The schema export tool

not null

foreign keys

indexes

unique keys

Auxiliary Database Objects

mapping file generation from entity

Part 3: Working with Persistent Objects

In this part: Dynamic view, sessions, queries, modifications, transactions etc.

Working with sessions

sessions, session cache, flushing

cascading

detached objects, reattaching

Querying

Introduction, when to use which kind of query

HQL Queries

Syntax

Multi Query

Criteria Queries

API

Multi Criteria

Using NH filters

Lazy loading and fetching strategies

fetching strategies

collections

references (proxies)

load

Utility.Initialize

batch fetching

Updating and deleting

updating, batch-updates, HQL updates

deleting, one-shot-delete, HQL delete

Transactions And Concurrency

Transaction factory (see also: setting up)

Concurrency

Optimistic Locking

Version columns

Property level

Force version increment

application version check

Pessimistic Locking

Part 4: Enhanced Features

In this part: Features that are not used by everyone. They are not important to understand to work with NH.

Using Native SQL

Sql queries

custom SQL for query/update/insert/delete

precompiled queries

Using SP's, db functions and triggers

property update/insert

property generated

property formula

see also: "Generating The Database - Auxiliary Database Objects"

Using Database Views

Caches

second level cache

query cache

Meta API

Extend NH behaviour

user types

Interceptors

events

connection provider

transaction factory

session provider

Part 5: Examples

In this part: examples

Appendix

In this part: lists and references. The references (eg. mapping xml elements, dialects etc are important to find the documentation. So there are basically only links to chapters)

Trouble shooting

Configuration Reference

Getting a connection (connection provider, user provided) (setting up)

proxy generator (lazy loading)

cache configuration (optimizing)

Transaction factory (setting up)

Dialects (setting up)

Outer join fetching (lazy loading?)

logging (trouble shooting)

naming strategy (mapping)

Full List of Dialiects

Full List of Drivers

XML-Mapping full reference

Looking for the best Sims 3 cheats PC?We are gonna reveal them to you and get you famous on Sims 3 and Text Twist.

Full List of Types

scrabble word finder cheat

NHibernate Documentation Structure Proposal

abhishek644 — Thu, 10 Nov 2011 11:34:10 GMT
Revision 6 posted to NHibernate 2.0 by abhishek644 on 10/11/2011 08:34:10 a.m.

NHibernate Documentation Structure Proposal

Filed under: Nhibernate Documentation

This is a proposal for a new structure of the NHibernate reference documentation. The goal is to discuss it and get some feedback from the community.

Goals

The goals of the restructuring of the documentation are:

move from "feature oriented" to "solution oriented". For instance, instead of having a chapter about the "version" xml element, there is a chapter about "concurrency". So the reader has a problem to solve, and he finds a chapter that explains, how NH solves it. The reader can't know that he needs a version element. Such a chapter should cover all elements of a certain problem, in the given example this are the version xml-element, the optimistic-lock xml-attribute of classes and properties, explicit version increment, locking and so on.

Additionally, there shall be a complete reference of the mappings, configurations and others in an appendix that links to the chapters.

More diagrams for mapping strategies

More best practices and patterns

Fill gaps where the documentation is not complete (enough), for instance special HQL features, user types, interceptors and events, connection factories and other extensions, (new) proxy factories etc.

Structure

Part 1: First Steps

In this part: a high-level overview of the whole picture.

Quick start

simple program that runs "out of the box"

not too much code, not too much explanation (but links to chapters)

includes inheritance, reference, list

includes schema generation

includes some simple hql

includes configuration for sqlserver, oracle, mysql

Architecture and basic concepts

Architecture (diagrams)

"Factory-Chain" Configuration => SessionFactory => Session => Transaction / Query

Instance States

Session Cache (see also "Working with persistent objects")

Application Architectures (referenced assemblies from application layers)

Setting Up

Three ways: nhibernate.cfg.xml, app.config, programmatic

Dialects and Drivers (See also Appendix "full list of Drivers / Dialects")

ProxyFactory configuration (see "lazy loading")

SessionProvider, contextual sessions

Getting a connection (connection provider, user provided, connection release mode)

How to set up a Project, minimal program

configuration file

mapping files (see "OR Mapping Basics")

Part 2: Writing and Mapping Classes

In this part: Static view, classes, mappings, db schema

Persistent classes

Example poco, basic rules

Object Identity

id generators

best practices

composite keys (see also "Working with legacy databases")

component keys (see also "Working with legacy databases")

Overriding Equals and GetHashCode

Optional: Version (see optimistic locking)

lifecycle callbacks

validation

see also: lazy loading (because of virtual)

OR Mapping Basics

Manage mapping files

as xml files

as embedded resources

modular mapping files

alternatives (attributes, FNH)

Using quoted identifiers

NH Types (see also: "Extend NH behaviour - user types", Appendix "Full List of Types")

Naming conventions

Property / field (access strategy)

Mapping primitive values and single ended references

properties

references many-to-one

references one-to-one

map several classes to one table: components

dynamic components

map a class to several tables: join

any types

Mapping Collections

persistent collections

set, list, map, bag, array, primitive-array

one-to-many relations

many-to-many relations

composite-elemements

collection performance

Sorted collections

Mapping Inheritance

Table per Hierarchy

Table per Concrete Class

Table per Class

Mixing strategies

Mapping to legacy databases

composite keys

component keys

property-ref

Generating The Database

The schema export tool

not null

foreign keys

indexes

unique keys

Auxiliary Database Objects

mapping file generation from entity

Part 3: Working with Persistent Objects

In this part: Dynamic view, sessions, queries, modifications, transactions etc.

Working with sessions

sessions, session cache, flushing

cascading

detached objects, reattaching

Querying

Introduction, when to use which kind of query

HQL Queries

Syntax

Multi Query

Criteria Queries

API

Multi Criteria

Using NH filters

Lazy loading and fetching strategies

fetching strategies

collections

references (proxies)

load

Utility.Initialize

batch fetching

Updating and deleting

updating, batch-updates, HQL updates

deleting, one-shot-delete, HQL delete

Transactions And Concurrency

Transaction factory (see also: setting up)

Concurrency

Optimistic Locking

Version columns

Property level

Force version increment

application version check

Pessimistic Locking

Part 4: Enhanced Features

In this part: Features that are not used by everyone. They are not important to understand to work with NH.

Using Native SQL

Sql queries

custom SQL for query/update/insert/delete

precompiled queries

Using SP's, db functions and triggers

property update/insert

property generated

property formula

see also: "Generating The Database - Auxiliary Database Objects"

Using Database Views

Caches

second level cache

query cache

Meta API

Extend NH behaviour

user types

Interceptors

events

connection provider

transaction factory

session provider

Part 5: Examples

In this part: examples

Appendix

In this part: lists and references. The references (eg. mapping xml elements, dialects etc are important to find the documentation. So there are basically only links to chapters)

Trouble shooting

Configuration Reference

Getting a connection (connection provider, user provided) (setting up)

proxy generator (lazy loading)

cache configuration (optimizing)

Transaction factory (setting up)

Dialects (setting up)

Outer join fetching (lazy loading?)

logging (trouble shooting)

naming strategy (mapping)

Full List of Dialiects

Full List of Drivers

XML-Mapping full reference

Full List of Types

scrabble word finder cheat

NHibernate Documentation Structure Proposal

Simon Martin — Tue, 02 Jun 2009 18:47:32 GMT
Revision 5 posted to NHibernate 2.0 by Simon Martin on 02/06/2009 03:47:32 p.m.

NHibernate Documentation Structure Proposal

Filed under: Nhibernate Documentation

This is a proposal for a new structure of the NHibernate reference documentation. The goal is to discuss it and get some feedback from the community.

Goals

The goals of the restructuring of the documentation are:

move from "feature oriented" to "solution oriented". For instance, instead of habing having a chapter about the "version" xml element, there is a chapter about "concurrency". So the reader has a problem to solve, and he finds a chapter that explains, how NH solves it. The reader can't know that he needs a version element. Such a chapter should cover all elements of a certain problem, in the given example this are the version xml-element, the optimistic-lock xml-attribute of classes and properties, explicit version increment, locking and so on.

Additionally, there shall be a complete reference of the mappings, configurations and others in an appendix that links to the chapters.

More diagrams for mapping strategies

More best practices and patterns

Fill gaps where the documentation is not complete (enough), for instance special HQL features, user types, interceptors and events, connection factories and other extensions, (new) proxy factories etc.

Structure

Part 1: First Steps

In this part: a high-level overview of the whole picture.

Quick start

simple program that runs "out of the box"

not too much code, not too much explanation (but links to chapters)

includes inheritance, reference, list

includes schema generation

includes some simple hql

includes configuration for sqlserver, orcaleoracle, mysql

Architecture and basic concepts

Architecture (diagrams)

"Factory-Chain" Configuration => SessionFactory => Session => Transaction / Query

Instance States

Session Cache (see also "Working with persistent objects")

Application Architectures (referenced assemblies from application layers)

Setting Up

Three ways: nhibernate.cfg.xml, app.config, programmatic

Dialects and Drivers (See also Appendix "full list of Drivers / Dialects")

ProxyFactory configuration (see "lazy loading")

SessionProvider, contextual sessions

Getting a connection (connection provider, user provided, connection release mode)

How to set up a Project, minimal program

configuration file

mapping files (see "OR Mapping Basics")

Part 2: Writing and Mapping Classes

In this part: Static view, classes, mappings, db schema

Persistent classes

Example poco, basic rules

Object Identity

id generators

best practices

compsite

composite keys (see also "Working with legacy databases")

component keys (see also "Working with legacy databases")

Overriding Equals and GetHashCode

Optional: Version (see optimistic locking)

lifecycle callbacks

validation

see also: lazy loading (because of virtual)

OR Mapping Basics

Manage mapping files

as xml files

as embedded resources

modular mapping files

alternatives (attributes, FNH)

Using quoted identifiers

NH Types (see also: "Extend NH behaviour - user types", Appendix "Full List of Types")

Naming conventions

Property / field (access strategy)

Mapping primitive values and single ended references

properties

references many-to-one

references one-to-one

map several classes to one table: components

dynamic components

map a class to several tables: join

any types

Mapping Collections

persistent collections

set, list, map, bag, array, primitive-array

one-to-many relations

many-to-many relations

composite-elemements

collection performance

Sorted collections

Mapping Inheritance

Table per Hierarchy

Table per Concrete Class

Table per Class

Mixing strategies

Mapping to legacy databases

composite keys

component keys

property-ref

Generating The Database

The schema export tool

not null

foreign keys

indexes

unique keys

Auxiliary Database Objects

mapping file generation from entity

Part 3: Working with Persistent Objects

In this part: Dynamic view, sessions, queries, modifications, transactions etc.

Working with sessions

sessions, session cache, flushing

cascading

detached objects, reattaching

Querying

Introduction, when to use which kind of query

HQL Queries

Syntax

Multi Query

Criteria Queries

API

Multi Criteria

Using NH filters

Lazy loading and fetching strategies

fetching strategies

collections

references (proxies)

load

Utility.Initialize

batch fetching

Updating and deleting

updating, batch-updates, HQL updates

deleting, one-shot-delete, HQL delete

Transactions And Concurrency

Transaction factory (see also: setting up)

Concurrency

Optimistic Locking

Version columns

Property level

Force version increment

application version check

Pessimistic Locking

Part 4: Enhanced Features

In this part: Features that are not used by everyone. They are not important to understand to work with NH.

Using Native SQL

Sql queries

custom SQL for query/update/insert/delete

precompiled queries

Using SP's, db functions and triggers

property update/insert

property generated

property formula

see also: "Generating The Database - Auxiliary Database Objects"

Using Database Views

Caches

second level cache

query cache

Meta API

Extend NH behaviour

user types

Interceptors

events

connection provider

transaction factory

session provider

Part 5: Examples

In this part: examples

Appendix

In this part: lists and references. The references (eg. mapping xml elements, dialects etc are important to find the documentation. So there are basically only links to chapters)

Trouble shooting

Configuration Reference

Getting a connection (connection provider, user provided) (setting up)

proxy generator (lazy loading)

cache configuration (optimizing)

Transaction factory (setting up)

Dialects (setting up)

Outer join fetching (lazy loading?)

logging (trouble shooting)

naming strategy (mapping)

Full List of Dialiects

Full List of Drivers

XML-Mapping full reference

Full List of Types

NHibernate Documentation Structure Proposal

Stefan Steinegger — Tue, 02 Jun 2009 16:51:25 GMT
Revision 4 posted to NHibernate 2.0 by Stefan Steinegger on 02/06/2009 01:51:25 p.m.

NHibernate Documentation Structure Proposal

Filed under: Nhibernate Documentation

This is a proposal for a new structure of the NHibernate reference documentation. The goal is to discuss it and get some feedback from the community.

Goals

The goals of the restructuring of the documentation are:

move from "feature oriented" to "solution oriented". For instance, instead of habing a chapter about the "version" xml element, there is a chapter about "concurrency". So the reader has a problem to solve, and he finds a chapter that explains, how NH solves it. The reader can't know that he needs a version element. Such a chapter should cover all elements of a certain problem, in the given example this are the version xml-element, the optimistic-lock xml-attribute of classes and properties, explicit version increment, locking and so on.

Additionally, there shall be a complete reference of the mappings, configurations and others in an appendix that links to the chapters.

More diagrams for mapping strategies

More best practices and patterns

Fill gaps where the documentation is not complete (enough), for instance special HQL features, user types, interceptors and events, connection factories and other extensions, (new) proxy factories etc.

Structure

Part 1: First Steps

In this part: a high-level overview of the whole picture.

Quick start

simple program that runs "out of the box"

not too much code, not too much explanation (but links to chapters)

includes inheritance, reference, list

includes schema generation

includes some simple hql

includes configuration for sqlserver, orcale, mysql

Architecture and basic concepts

Architecture (diagrams)

"Factory-Chain" Configuration => SessionFactory => Session => Transaction / Query

Instance States

Session Cache (see also "Working with persistent objects")

Application Architectures (referenced assemblies from application layers)

Setting Up

Three ways: nhibernate.cfg.xml, app.config, programmatic

Dialects and Drivers (See also Appendix "full list of Drivers / Dialects")

ProxyFactory configuration (see "lazy loading")

SessionProvider, contextual sessions

Getting a connection (connection provider, user provided, connection release mode)

How to set up a Project, minimal program

configuration file

mapping files (see "OR Mapping Basics")

Part 2: Writing and Mapping Classes

In this part: Static view, classes, mappings, db schema

Persistent classes

Example poco, basic rules

Object Identity

id generators

best practices

compsite keys (see also "Working with legacy databases")

component keys (see also "Working with legacy databases")

Overriding Equals and GetHashCode

Optional: Version (see optimistic locking)

lifecycle callbacks

validation

see also: lazy loading (because of virtual)

OR Mapping Basics

Manage mapping files

as xml files

as embedded resources

modular mapping files

alternatives (attributes, FNH)

Using quoted identifiers

NH Types (see also: "Extend NH behaviour - user types", Appendix "Full List of Types")

Naming conventions

Property / field (access strategy)

Mapping primitive values and single ended references

properties

references many-to-one

references one-to-one

map several classes to one table: components

dynamic components

map a class to several tables: join

any types

Mapping Collections

persistent collections

set, list, map, bag, array, primitive-array

one-to-many relations

many-to-many relations

composite-elemements

collection performance

Sorted collections

Mapping Inheritance

Table per Hierarchy

Table per Concrete Class

Table per Class

Mixing strategies

Mapping to legacy databases

composite keys

component keys

property-ref

Generating The Database

The schema export tool

not null

foreign keys

indexes

unique keys

Auxiliary Database Objects

mapping file generation from entity

Part 3: Working with Persistent Objects

In this part: Dynamic view, sessions, queries, modifications, transactions etc.

Working with sessions

sessions, session cache, flushing

cascading

detached objects, reattaching

Querying

Introduction, when to use which kind of query

HQL Queries

Syntax

Multi Query

Criteria Queries

API

Multi Criteria

Using NH filters

Lazy loading and fetching strategies

fetching strategies

collections

references (proxies)

load

Utility.Initialize

batch fetching

Working with sessions

sessions, session cache, flushing

cascading

detached objects, reattaching

Updating and deleting

updating, batch-updates, HQL updates

deleting, one-shot-delete, HQL delete

Transactions And Concurrency

Transaction factory (see also: setting up)

Concurrency

Optimistic Locking

Version columns

Property level

Force version increment

application version check

Pessimistic Locking

Part 4: Enhanced Features

In this part: Features that are not used by everyone. They are not important to understand to work with NH.

Using Native SQL

Sql queries

custom SQL for query/update/insert/delete

precompiled queries

Using SP's, db functions and triggers

property update/insert

property generated

property formula

see also: "Generating The Database - Auxiliary Database Objects"

Using Database Views

Caches

second level cache

query cache

Meta API

Extend NH behaviour

user types

Interceptors

events

connection provider

transaction factory

session provider

Part 5: Examples

In this part: examples

Appendix

In this part: lists and references. The references (eg. mapping xml elements, dialects etc are important to find the documentation. So there are basically only links to chapters)

Trouble shooting

Configuration Reference

Getting a connection (connection provider, user provided) (setting up)

proxy generator (lazy loading)

cache configuration (optimizing)

Transaction factory (setting up)

Dialects (setting up)

Outer join fetching (lazy loading?)

logging (trouble shooting)

naming strategy (mapping)

Full List of Dialiects

Full List of Drivers

XML-Mapping full reference

Full List of Types

NHibernate Documentation Structure Proposal

Stefan Steinegger — Sat, 30 May 2009 22:16:09 GMT
Revision 3 posted to NHibernate 2.0 by Stefan Steinegger on 30/05/2009 07:16:09 p.m.

NHibernate Documentation Structure Proposal

Filed under: Nhibernate Documentation

This is a proposal for a new structure of the NHibernate reference documentation. The goal is to discuss it and get some feedback from the community.

Goals

The goals of the restructuring of the documentation are:

move from "feature oriented" to "solution oriented". For instance, instead of habing a chapter about the "version" xml element, there is a chapter about "concurrency". So the reader has a problem to solve, and he finds a chapter that explains, how NH solves it. The reader can't know that he needs a version element. Such a chapter should cover all elements of a certain problem, in the given example this are the version xml-element, the optimistic-lock xml-attribute of classes and properties, explicit version increment, locking and so on.

Additionally, there shall be a complete reference of the mappings, configurations and others in an appendix that links to the chapters.

More diagrams for mapping strategies

More best practices and patterns

Fill gaps where the documentation is not complete (enough), for instance special HQL features, user types, interceptors and events, connection factories and other extensions, (new) proxy factories etc.

Structure

Part 1: First Steps

Quick start

simple program that runs "out of the box"

not too much code, not too much explanation (but links to chapters)

includes inheritance, reference, list

includes schema generation

includes some simple hql

includes configuration for sqlserver, orcale, mysql

Architecture and basic concepts

Architecture (diagrams)

"Factory-Chain" Configuration => SessionFactory => Session => Transaction / Query

Instance States

Session Cache (see also "Working with persistent objects")

Application Architectures (referenced assemblies from application layers)

Setting Up

Three ways: nhibernate.cfg.xml, app.config, programmatic

Dialects and Drivers (See also Appendix "full list of Drivers / Dialects")

ProxyFactory configuration (see "lazy loading")

SessionProvider, contextual sessions

Getting a connection (connection provider, user provided, connection release mode)

How to set up a Project, minimal program

configuration file

mapping files (see "OR Mapping Basics")

Part 2: Writing and Mapping Classes

Persistent classes

Example poco, basic rules

Object Identity

id generators

best practices

compsite keys (see also "Working with legacy databases")

component keys (see also "Working with legacy databases")

Overriding Equals and GetHashCode

Optional: Version (see optimistic locking)

lifecycle callbacks

validation

see also: lazy loading (because of virtual)

OR Mapping Basics

Manage mapping files

as xml files

as embedded resources

modular mapping files

alternatives (attributes, FNH)

Using quoted identifiers

NH Types (see also: "Extend NH behaviour - user types", Appendix "Full List of Types")

Naming conventions

Property / field (access strategy)

Mapping primitive values and single ended references

properties

references many-to-one

references one-to-one

map several classes to one table: components

dynamic components

map a class to several tables: join

any types

Mapping Collections

persistent collections

set, list, map, bag, array, primitive-array

one-to-many relations

many-to-many relations

composite-elemements

collection performance

Sorted collections

Mapping Inheritance

Table per Hierarchy

Table per Concrete Class

Table per Class

Mixing strategies

Mapping to legacy databases

composite keys

component keys

property-ref

Generating The Database

The schema export tool

not null

foreign keys

indexes

unique keys

Auxiliary Database Objects

mapping file generation from entity

Part 3: Working with Persistent Objects

Querying

Introduction, when to use which kind of query

HQL Queries

Syntax

Multi Query

Criteria Queries

API

Multi Criteria

Using NH filters

Lazy loading and fetching strategies

fetching strategies

collections

references (proxies)

load

Utility.Initialize

batch fetching

Working with sessions

sessions, session cache, flushing

cascading

detached objects, reattaching

Updating and deleting

updating, batch-updates, HQL updates

deleting, one-shot-delete, HQL delete

Transactions And Concurrency

Transaction factory (see also: setting up)

Concurrency

Optimistic Locking

Version columns

Property level

Force version increment

application version check

Pessimistic Locking

Part 4: Enhanced Features

Using Native SQL

Sql queries

custom SQL for query/update/insert/delete

precompiled queries

Using SP's, db functions and triggers

property update/insert

property generated

property formula

see also: "Generating The Database - Auxiliary Database Objects"

Using Database Views

Caches

second level cache

query cache

Meta API

Extend NH behaviour

user types

Interceptors

events

connection provider

transaction factory

session provider

Part 5: Examples

Appendix

Trouble shooting

Configuration Reference

Getting a connection (connection provider, user provided) (setting up)

proxy generator (lazy loading)

cache configuration (optimizing)

Transaction factory (setting up)

Dialects (setting up)

Outer join fetching (lazy loading?)

logging (trouble shooting)

naming strategy (mapping)

Full List of Dialiects

Full List of Drivers

XML-Mapping full reference

Full List of Types

NHibernate Documentation Structure Proposal

Stefan Steinegger — Sat, 30 May 2009 22:13:14 GMT
Revision 2 posted to NHibernate 2.0 by Stefan Steinegger on 30/05/2009 07:13:14 p.m.

NHibernate Documentation Structure Proposal

Filed under: Nhibernate Documentation

This is a proposal for a new structure of the NHibernate reference documentation. The goal is to discuss it and get some feedback fro from the community.

Goals

The goals of the resturcutring restructuring of the documentation are:

move from "feature oriented" to "solution oriented". For instance, instead of habing a chapter about the "version" xml element, there is a chapter about "concurrency". So the reader has a problem to solve, and he finds a chapter that explains, how NH solves it. The reader can't know that he needs a version element. Such a chapter should cover all elements of a certain problem, in the given example this are the version xml-element, the optimistic-lock xml-attribute of classes and properties, explicit version increment, locking and so on.

Additionally, there shall be a complete reference of the mappings, configurations and others in an appendix that links to the chapters.

More diagrams for mapping strategies

More best practices and patterns

Fill gaps where the documentation is not complete (enough), for instance special HQL features, user types, interceptors and events, connection factories and other extensions, (new) proxy factories etc.

Structure

Part 1: First Steps

Quick start

simple program that runs "out of the box"

not too much code, not too much explanation (but links to chapters)

includes inheritance, reference, list

includes schema generation

includes some simple hql

includes configuration for sqlserver, orcale, mysql

Architecture and basic concepts

Architecture (diagrams)

"Factory-Chain" Configuration => SessionFactory => Session => Transaction / Query

Instance States

Session Cache (see also "Working with persistent objects")

Application Architectures (referenced assemblies from application layers)

Setting Up

Three ways: nhibernate.cfg.xml, app.config, programmatic

Dialects and Drivers (See also Appendix "full list of Drivers / Dialects")

ProxyFactory configuration (see "lazy loading")

SessionProvider, contextual sessions

ConnectionProvider

Getting a connection (see also "extend NH")connection provider, user provided, connection release mode)

How to set up a Project, minimal program

configuration file

mapping files (see "OR Mapping Basics")

Part 2: Writing and Mapping Classes

Persistent classes

Example poco, basic rules

Object Identity

id generators

best practices

compsite keys (see also "Working with legacy databases")

component keys (see also "Working with legacy databases")

Overriding Equals and GetHashCode

Optional: Version (see optimistic locking)

lifecycle callbacks

validation

see also: lazy loading (because of virtual)

OR Mapping Basics

Manage mapping files

as xml files

as embedded resources

modular mapping files

alternatives (attributes, FNH)

Using quoted identifiers

NH Types (see also: "Extend NH behaviour - user types", Appendix "Full List of Types")

Naming conventions

Property / field (access strategy)

Mapping primitive values and single ended references

properties

references many-to-one

references one-to-one

components

dynamic components

any types

Mapping Collections

persistent collections

set, list, map, bag, array, primitive-array

one-to-many relations

many-to-many relations

composite-elemements

collection performance

Sorted collections

Mapping Inheritance

Table per Hierarchy

Table per Concrete Class

Table per Class

Mixing strategies

Mapping to legacy databases

composite keys

component keys

property-ref

Generating The Database

The schema export tool

not null

foreign keys

indexes

unique keys

Auxiliary Database Objects

mapping file generation from entity

Part 3: Working with Persistent Objects

Querying

Introduction, when to use which kind of query

HQL Queries

Syntax

Multi Query

Criteria Queries

API

Multi Criteria

Using NH filters

Lazy loading and fetching strategies

fetching strategies

collections

references (proxies)

load

Utility.Initialize

batch fetching

Working with persistent objectssessions

sessions, session cache, flushing

cascading

detached objects, reattaching

Updating and deleting

updating, batch-updates, HQL updates

deleting, one-shot-delete, HQL delete

Transactions And Concurrency

Getting a connection (see also: setting up, connenction provider, user provided)

connection release mode

Transaction factory (see also: setting up)

Concurrency

Optimistic Locking

Version columns

Property level

Force version increment

application version check

Pessimistic Locking

Querying

HQL

Criteria

NH filters

Updating

cascades

Part 4: Enhanced Features

Using Native SQL

Sql queries

custom SQL for query/update/insert/delete

precompiled queries

Using SP's, db functions and triggers

property update/insert

property generated

property formula

database objects in mapping files

Working with legacy databases

composite keys

component keys

property-ref

Lazy loading and fetching strategies

fetching strategies

collections

references (proxies)

load

Utility.Initialize

batch fetching

see also: "Generating The Database - Auxiliary Database Objects"

Using Database Views

Caches

second level cache

query cache

Batches

Query

Code Generation Tools

DDL : Generating the database from enity and mapping

schema export

not null

foreign keys

indexes

unique keys

Auxiliary Database Objects

Entity Code generation from mapping

mapping file generation from entity

Meta API

Extend NH behaviour

user types

Interceptors

events

connection provider

transaction factory

session provider

Part 5: Examples

Appendix

Trouble shooting

Appendix

Configuration Reference

Getting a connection (connection provider, user provided) (setting up)

proxy generator (lazy loading)

cache configuration (optimizing)

Transaction factory (setting up)

Dialects (setting up)

Outer join fetching (lazy loading?)

logging (trouble shooting)

naming strategy (mapping)

Full List of Dialiects

Full List of Drivers

XML-Mapping full reference

Full List of Types

NHibernate Documentation Structure Proposal

Stefan Steinegger — Thu, 28 May 2009 09:55:28 GMT
Revision 1 posted to NHibernate 2.0 by Stefan Steinegger on 28/05/2009 06:55:28 a.m.

This is a proposal for a new structure of the NHibernate reference documentation. The goal is to discuss it and get some feedback fro the community.

Goals

The goals of the resturcutring of the documentation are:

move from "feature oriented" to "solution oriented". For instance, instead of habing a chapter about the "version" xml element, there is a chapter about "concurrency". So the reader has a problem to solve, and he finds a chapter that explains, how NH solves it. The reader can't know that he needs a version element. Such a chapter should cover all elements of a certain problem, in the given example this are the version xml-element, the optimistic-lock xml-attribute of classes and properties, explicit version increment, locking and so on.

Additionally, there shall be a complete reference of the mappings, configurations and others in an appendix that links to the chapters.

More diagrams for mapping strategies

More best practices and patterns

Fill gaps where the documentation is not complete (enough), for instance special HQL features, user types, interceptors and events, connection factories and other extensions, (new) proxy factories etc.

Structure

Quick start

simple program that runs "out of the box"

not too much code, not too much explanation (but links to chapters)

includes inheritance, reference, list

includes schema generation

includes some simple hql

includes configuration for sqlserver, orcale, mysql

Architecture and basic concepts

Architecture (diagrams)

"Factory-Chain" Configuration => SessionFactory => Session => Transaction / Query

Instance States

Session Cache (see also "Working with persistent objects")

Application Architectures (referenced assemblies from application layers)

Setting Up

Three ways: nhibernate.cfg.xml, app.config, programmatic

Dialects and Drivers (See also Appendix "full list of Drivers / Dialects")

ProxyFactory configuration (see "lazy loading")

SessionProvider, contextual sessions

ConnectionProvider (see also "extend NH")

How to set up a Project, minimal program

configuration file

mapping files (see "OR Mapping Basics")

Persistent classes

Example poco, basic rules

Object Identity

id generators

best practices

compsite keys (see also "Working with legacy databases")

component keys (see also "Working with legacy databases")

Overriding Equals and GetHashCode

Optional: Version (see optimistic locking)

lifecycle callbacks

validation

OR Mapping Basics

Manage mapping files

as xml files

as embedded resources

modular mapping files

alternatives (attributes, FNH)

Using quoted identifiers

NH Types (see also: "Extend NH behaviour - user types", Appendix "Full List of Types")

Naming conventions

Property / field (access strategy)

Mapping primitive values and single ended references

properties

references many-to-one

references one-to-one

components

dynamic components

any types

Mapping Collections

persistent collections

set, list, map, bag, array, primitive-array

one-to-many relations

many-to-many relations

composite-elemements

collection performance

Sorted collections

Mapping Inheritance

Table per Hierarchy

Table per Concrete Class

Table per Class

Mixing strategies

Working with persistent objects

sessions, session cache

cascading

Transactions And Concurrency

Getting a connection (see also: setting up, connenction provider, user provided)

connection release mode

Transaction factory (see also: setting up)

Concurrency

Optimistic Locking

Version columns

Property level

Force version increment

application version check

Pessimistic Locking

Querying

HQL

Criteria

NH filters

Updating

cascades

Using Native SQL

custom SQL for query/update/insert/delete

precompiled queries

Using SP's, db functions and triggers

property update/insert

property generated

property formula

database objects in mapping files

Working with legacy databases

composite keys

component keys

property-ref

Lazy loading and fetching strategies

fetching strategies

collections

references (proxies)

load

Utility.Initialize

batch fetching

Caches

second level cache

query cache

Batches

Query

Code Generation Tools

DDL : Generating the database from enity and mapping

schema export

not null

foreign keys

indexes

unique keys

Auxiliary Database Objects

Entity Code generation from mapping

mapping file generation from entity

Meta API

Extend NH behaviour

user types

Interceptors

events

connection provider

session provider

Examples

Trouble shooting

Appendix

Configuration Reference

Getting a connection (connection provider, user provided) (setting up)

proxy generator (lazy loading)

cache configuration (optimizing)

Transaction factory (setting up)

Dialects (setting up)

Outer join fetching (lazy loading?)

logging (trouble shooting)

naming strategy (mapping)

Full List of Dialiects

Full List of Drivers

XML-Mapping full reference

Full List of Types

Architecture

Groxx — Thu, 24 Feb 2011 00:50:31 GMT
Current revision posted to NHibernate 2.0 by Groxx on 23/02/2011 09:50:31 p.m.

Architecture

Filed under: Session, SessionFactory, Architecture

Wiki extracted from the 2.0 Reference Documentation

Overview

A (very) high-level view of the NHibernate architecture:

This diagram shows NHibernate using the database and configuration data to provide persistence services (and persistent objects) to the application.

We would like to show a more detailed view of the runtime architecture. Unortunately, NHibernate is flexible and supports several approaches. We will show the two extremes. The "lite" architecture has the application provide its own ADO.NET connections and manage its own transactions. This approach uses a minimal subset of NHibernate's APIs:

The "full cream" architecture abstracts the application away from the underlying ADO.NET APIs and lets NHibernate take care of the details.

Here some definitions of the objects in the diagrams:

ISessionFactory (NHibernate.ISessionFactory)

A threadsafe (immutable) cache of compiled mappings for a single database. A factory for ISession and a client of IConnectionProvider. Might hold an optional (second-level) cache of data that is reusable between transactions, at a process- or cluster-level.

ISession (NHibernate.ISession)

A single-threaded, short-lived object representing a conversation between the application and the persistent store. Wraps an ADO.NET connection. Factory for ITransaction. Holds a mandatory (first-level) cache of persistent objects, used when navigating the object graph or looking up objects by identifier.

Persistent Objects and Collection

Short-lived, single threaded objects containing persistent state and business function. These might be ordinary POCOs (Plain Old CLR Objects), the only special thing about them is that they are currently associated with (exactly one) ISession. As soon as the Session is closed, they will be detached and free to use in any application layer (e.g. directly as data transfer objects to and from presentation).

Transient Objects and Collections

Instances of persistent classes that are not currently associated with a ISession. They may have been instantiated by the application and not (yet) persisted or they may have been instantiated by a closed ISession.

ITransaction (NHibernate.ITransaction)

(Optional) A single-threaded, short-lived object used by the application to specify atomic units of work. Abstracts application from underlying ADO.NET transaction. An ISession might span several ITransactions in some cases.

IConnectionProvider (NHibernate.Connection.IConnectionProvider)

(Optional) A factory for ADO.NET connections and commands. Abstracts application from the concrete vendor-specific implementations of IDbConnection and IDbCommand. Not exposed to application, but can be extended/implemented by the developer.

IDriver (NHibernate.Driver.IDriver)

(Optional) An interface encapsulating differences between ADO.NET providers, such as parameter naming conventions and supported ADO.NET features.

ITransactionFactory (NHibernate.Transaction.ITransactionFactory)

(Optional) A factory for ITransaction instances. Not exposed to the application, but can be extended/implemented by the developer.

Given a "lite" architecture, the application bypasses the ITransaction, ITransactionFactory and/or IConnectionProvider APIs to talk to ADO.NET directly.

Architecture

Groxx — Thu, 24 Feb 2011 00:49:12 GMT
Revision 9 posted to NHibernate 2.0 by Groxx on 23/02/2011 09:49:12 p.m.

Architecture

Filed under: Session, SessionFactory, Architecture

Wiki extracted from the 2.0 Reference Documentation

Overview

A (very) high-level view of the NHibernate architecture:

This diagram shows NHibernate using the database and configuration data to provide persistence services (and persistent objects) to the application.

We would like to show a more detailed view of the runtime architecture. FortunatelyUnortunately, NHibernate is flexible and supports several approaches. We will show the two extremes. The "lite" architecture has the application provide its own ADO.NET connections and manage its own transactions. This approach uses a minimal subset of NHibernate's APIs:

The "full cream" architecture abstracts the application away from the underlying ADO.NET APIs and lets NHibernate take care of the details.

Here some definitions of the objects in the diagrams:

ISessionFactory (NHibernate.ISessionFactory)

A threadsafe (immutable) cache of compiled mappings for a single database. A factory for ISession and a client of IConnectionProvider. Might hold an optional (second-level) cache of data that is reusable between transactions, at a process- or cluster-level.

ISession (NHibernate.ISession)

A single-threaded, short-lived object representing a conversation between the application and the persistent store. Wraps an ADO.NET connection. Factory for ITransaction. Holds a mandatory (first-level) cache of persistent objects, used when navigating the object graph or looking up objects by identifier.

Persistent Objects and Collection

Short-lived, single threaded objects containing persistent state and business function. These might be ordinary POCOs, the only special thing about them is that they are currently associated with (exactly one) ISession. As soon as the Session is closed, they will be detached and free to use in any application layer (e.g. directly as data transfer objects to and from presentation).

Transient Objects and Collections

Instances of persistent classes that are not currently associated with a ISession. They may have been instantiated by the application and not (yet) persisted or they may have been instantiated by a closed ISession.

ITransaction (NHibernate.ITransaction)

(Optional) A single-threaded, short-lived object used by the application to specify atomic units of work. Abstracts application from underlying ADO.NET transaction. An ISession might span several ITransactions in some cases.

IConnectionProvider (NHibernate.Connection.IConnectionProvider)

(Optional) A factory for ADO.NET connections and commands. Abstracts application from the concrete vendor-specific implementations of IDbConnection and IDbCommand. Not exposed to application, but can be extended/implemented by the developer.

IDriver (NHibernate.Driver.IDriver)

(Optional) An interface encapsulating differences between ADO.NET providers, such as parameter naming conventions and supported ADO.NET features.

ITransactionFactory (NHibernate.Transaction.ITransactionFactory)

(Optional) A factory for ITransaction instances. Not exposed to the application, but can be extended/implemented by the developer.

Given a "lite" architecture, the application bypasses the ITransaction, ITransactionFactory and/or IConnectionProvider APIs to talk to ADO.NET directly.

Architecture

Groxx — Thu, 24 Feb 2011 00:16:07 GMT
Revision 8 posted to NHibernate 2.0 by Groxx on 23/02/2011 09:16:07 p.m.

Architecture

Filed under: Session, SessionFactory, Architecture

Overview

A (very) high-level view of the NHibernate architecture:

This diagram shows NHibernate using the database and configuration data to provide persistence services (and persistent objects) to the application.

We would like to show a more detailed view of the runtime architecture. UnfortunatelyFortunately, NHibernate is flexible and supports several approaches. We will show the two extremes. The "lite" architecture has the application provide its own ADO.NET connections and manage its own transactions. This approach uses a minimal subset of NHibernate's APIs:

The "full cream" architecture abstracts the application away from the underlying ADO.NET APIs and lets NHibernate take care of the details.

Here some definitions of the objects in the diagrams:

ISessionFactory (NHibernate.ISessionFactory)

A threadsafe (immutable) cache of compiled mappings for a single database. A factory for ISession and a client of IConnectionProvider. Might hold an optional (second-level) cache of data that is reusable between transactions, at a process- or cluster-level.

ISession (NHibernate.ISession)

A single-threaded, short-lived object representing a conversation between the application and the persistent store. Wraps an ADO.NET connection. Factory for ITransaction. Holds a mandatory (first-level) cache of persistent objects, used when navigating the object graph or looking up objects by identifier.

Persistent Objects and Collection

Short-lived, single threaded objects containing persistent state and business function. These might be ordinary POCOs, the only special thing about them is that they are currently associated with (exactly one) ISession. As soon as the Session is closed, they will be detached and free to use in any application layer (e.g. directly as data transfer objects to and from presentation).

Transient Objects and Collections

Instances of persistent classes that are not currently associated with a ISession. They may have been instantiated by the application and not (yet) persisted or they may have been instantiated by a closed ISession.

ITransaction (NHibernate.ITransaction)

(Optional) A single-threaded, short-lived object used by the application to specify atomic units of work. Abstracts application from underlying ADO.NET transaction. An ISession might span several ITransactions in some cases.

IConnectionProvider (NHibernate.Connection.IConnectionProvider)

(Optional) A factory for ADO.NET connections and commands. Abstracts application from the concrete vendor-specific implementations of IDbConnection and IDbCommand. Not exposed to application, but can be extended/implemented by the developer.

IDriver (NHibernate.Driver.IDriver)

(Optional) An interface encapsulating differences between ADO.NET providers, such as parameter naming conventions and supported ADO.NET features.

ITransactionFactory (NHibernate.Transaction.ITransactionFactory)

(Optional) A factory for ITransaction instances. Not exposed to the application, but can be extended/implemented by the developer.

Given a "lite" architecture, the application bypasses the ITransaction, ITransactionFactory and/or IConnectionProvider APIs to talk to ADO.NET directly.

Architecture

Fabio Maulo — Fri, 05 Sep 2008 23:28:53 GMT
Revision 7 posted to NHibernate 2.0 by Fabio Maulo on 05/09/2008 08:28:53 p.m.

Architecture

Filed under: Session, SessionFactory, Architecture

Overview

A (very) high-level view of the NHibernate architecture:

This diagram shows NHibernate using the database and configuration data to provide persistence services (and persistent objects) to the application.

We would like to show a more detailed view of the runtime architecture. Unfortunately, NHibernate is flexible and supports several approaches. We will show the two extremes. The "lite" architecture has the application provide its own ADO.NET connections and manage its own transactions. This approach uses a minimal subset of NHibernate's APIs:

The "full cream" architecture abstracts the application away from the underlying ADO.NET APIs and lets NHibernate take care of the details.

Here some definitions of the objects in the diagrams:

ISessionFactory (NHibernate.ISessionFactory)

A threadsafe (immutable) cache of compiled mappings for a single database. A factory for ISession and a client of IConnectionProvider. Might hold an optional (second-level) cache of data that is reusable between transactions, at a process- or cluster-level.

ISession (NHibernate.ISession)

A single-threaded, short-lived object representing a conversation between the application and the persistent store. Wraps an ADO.NET connection. Factory for ITransaction. Holds a mandatory (first-level) cache of persistent objects, used when navigating the object graph or looking up objects by identifier.

Persistent Objects and Collection

Short-lived, single threaded objects containing persistent state and business function. These might be ordinary POCOs, the only special thing about them is that they are currently associated with (exactly one) ISession. As soon as the Session is closed, they will be detached and free to use in any application layer (e.g. directly as data transfer objects to and from presentation).

Transient Objects and Collections

Instances of persistent classes that are not currently associated with a ISession. They may have been instantiated by the application and not (yet) persisted or they may have been instantiated by a closed ISession.

ITransaction (NHibernate.ITransaction)

(Optional) A single-threaded, short-lived object used by the application to specify atomic units of work. Abstracts application from underlying ADO.NET transaction. An ISession might span several ITransactions in some cases.

IConnectionProvider (NHibernate.Connection.IConnectionProvider)

(Optional) A factory for ADO.NET connections and commands. Abstracts application from the concrete vendor-specific implementations of IDbConnection and IDbCommand. Not exposed to application, but can be extended/implemented by the developer.

IDriver (NHibernate.Driver.IDriver)

(Optional) An interface encapsulating differences between ADO.NET providers, such as parameter naming conventions and supported ADO.NET features.

ITransactionFactory (NHibernate.Transaction.ITransactionFactory)

(Optional) A factory for ITransaction instances. Not exposed to the application, but can be extended/implemented by the developer.

Given a "lite" architecture, the application bypasses the ITransaction, ITransactionFactory and/or IConnectionProvider APIs to talk to ADO.NET directly.

Architecture

Fabio Maulo — Fri, 05 Sep 2008 23:28:53 GMT
Revision 6 posted to NHibernate 2.0 by Fabio Maulo on 05/09/2008 08:28:53 p.m.

Architecture

Overview

A (very) high-level view of the NHibernate architecture:

This diagram shows NHibernate using the database and configuration data to provide persistence services (and persistent objects) to the application.

We would like to show a more detailed view of the runtime architecture. Unfortunately, NHibernate is flexible and supports several approaches. We will show the two extremes. The "lite" architecture has the application provide its own ADO.NET connections and manage its own transactions. This approach uses a minimal subset of NHibernate's APIs:

The "full cream" architecture abstracts the application away from the underlying ADO.NET APIs and lets NHibernate take care of the details.

Here some definitions of the objects in the diagrams:

ISessionFactory (NHibernate.ISessionFactory)

A threadsafe (immutable) cache of compiled mappings for a single database. A factory for ISession and a client of IConnectionProvider. Might hold an optional (second-level) cache of data that is reusable between transactions, at a process- or cluster-level.

ISession (NHibernate.ISession)

A single-threaded, short-lived object representing a conversation between the application and the persistent store. Wraps an ADO.NET connection. Factory for ITransaction. Holds a mandatory (first-level) cache of persistent objects, used when navigating the object graph or looking up objects by identifier.

Persistent Objects and Collection

Short-lived, single threaded objects containing persistent state and business function. These might be ordinary POCOs, the only special thing about them is that they are currently associated with (exactly one) ISession. As soon as the Session is closed, they will be detached and free to use in any application layer (e.g. directly as data transfer objects to and from presentation).

Transient Objects and Collections

Instances of persistent classes that are not currently associated with a ISession. They may have been instantiated by the application and not (yet) persisted or they may have been instantiated by a closed ISession.

ITransaction (NHibernate.ITransaction)

(Optional) A single-threaded, short-lived object used by the application to specify atomic units of work. Abstracts application from underlying ADO.NET transaction. An ISession might span several ITransactions in some cases.

IConnectionProvider (NHibernate.Connection.IConnectionProvider)

(Optional) A factory for ADO.NET connections and commands. Abstracts application from the concrete vendor-specific implementations of IDbConnection and IDbCommand. Not exposed to application, but can be extended/implemented by the developer.

IDriver (NHibernate.Driver.IDriver)

(Optional) An interface encapsulating differences between ADO.NET providers, such as parameter naming conventions and supported ADO.NET features.

ITransactionFactory (NHibernate.Transaction.ITransactionFactory)

(Optional) A factory for ITransaction instances. Not exposed to the application, but can be extended/implemented by the developer.

Given a "lite" architecture, the application bypasses the ITransaction, ITransactionFactory and/or IConnectionProvider APIs to talk to ADO.NET directly.

Architecture

Fabio Maulo — Sun, 31 Aug 2008 23:25:03 GMT
Revision 5 posted to NHibernate 2.0 by Fabio Maulo on 31/08/2008 08:25:03 p.m.

Architecture

Overview

A (very) high-level view of the NHibernate architecture:

This diagram shows NHibernate using the database and configuration data to provide persistence services (and persistent objects) to the application.

We would like to show a more detailed view of the runtime architecture. Unfortunately, NHibernate is flexible and supports several approaches. We will show the two extremes. The "lite" architecture has the application provide its own ADO.NET connections and manage its own transactions. This approach uses a minimal subset of NHibernate's APIs:

The "full cream" architecture abstracts the application away from the underlying ADO.NET APIs and lets NHibernate take care of the details.

Here some definitions of the objects in the diagrams:

ISessionFactory (NHibernate.ISessionFactory)

A threadsafe (immutable) cache of compiled mappings for a single database. A factory for ISession and a client of IConnectionProvider. Might hold an optional (second-level) cache of data that is reusable between transactions, at a process- or cluster-level.

ISession (NHibernate.ISession)

A single-threaded, short-lived object representing a conversation between the application and the persistent store. Wraps an ADO.NET connection. Factory for ITransaction. Holds a mandatory (first-level) cache of persistent objects, used when navigating the object graph or looking up objects by identifier.

Persistent Objects and Collection

Short-lived, single threaded objects containing persistent state and business function. These might be ordinary POCOs, the only special thing about them is that they are currently associated with (exactly one) ISession. As soon as the Session is closed, they will be detached and free to use in any application layer (e.g. directly as data transfer objects to and from presentation).

Transient Objects and Collections

Instances of persistent classes that are not currently associated with a ISession. They may have been instantiated by the application and not (yet) persisted or they may have been instantiated by a closed ISession.

ITransaction (NHibernate.ITransaction)

(Optional) A single-threaded, short-lived object used by the application to specify atomic units of work. Abstracts application from underlying ADO.NET transaction. An ISession might span several ITransactions in some cases.

IConnectionProvider (NHibernate.Connection.IConnectionProvider)

(Optional) A factory for ADO.NET connections and commands. Abstracts application from the concrete vendor-specific implementations of IDbConnection and IDbCommand. Not exposed to application, but can be extended/implemented by the developer.

IDriver (NHibernate.Driver.IDriver)

(Optional) An interface encapsulating differences between ADO.NET providers, such as parameter naming conventions and supported ADO.NET features.

ITransactionFactory (NHibernate.Transaction.ITransactionFactory)

(Optional) A factory for ITransaction instances. Not exposed to the application, but can be extended/implemented by the developer.

Given a "lite" architecture, the application bypasses the ITransaction, ITransactionFactory and/or IConnectionProvider APIs to talk to ADO.NET directly.

Architecture

Fabio Maulo — Sun, 31 Aug 2008 23:25:03 GMT
Revision 4 posted to NHibernate 2.0 by Fabio Maulo on 31/08/2008 08:25:03 p.m.

Architecture

Overview

A (very) high-level view of the NHibernate architecture:

This diagram shows NHibernate using the database and configuration data to provide persistence services (and persistent objects) to the application.

We would like to show a more detailed view of the runtime architecture. Unfortunately, NHibernate is flexible and supports several approaches. We will show the two extremes. The "lite" architecture has the application provide its own ADO.NET connections and manage its own transactions. This approach uses a minimal subset of NHibernate's APIs:

The "full cream" architecture abstracts the application away from the underlying ADO.NET APIs and lets NHibernate take care of the details.

Here some definitions of the objects in the diagrams:

ISessionFactory (NHibernate.ISessionFactory)

A threadsafe (immutable) cache of compiled mappings for a single database. A factory for ISession and a client of IConnectionProvider. Might hold an optional (second-level) cache of data that is reusable between transactions, at a process- or cluster-level.

ISession (NHibernate.ISession)

A single-threaded, short-lived object representing a conversation between the application and the persistent store. Wraps an ADO.NET connection. Factory for ITransaction. Holds a mandatory (first-level) cache of persistent objects, used when navigating the object graph or looking up objects by identifier.

Persistent Objects and Collection

Short-lived, single threaded objects containing persistent state and business function. These might be ordinary POCOs, the only special thing about them is that they are currently associated with (exactly one) ISession. As soon as the Session is closed, they will be detached and free to use in any application layer (e.g. directly as data transfer objects to and from presentation).

Transient Objects and Collections

Instances of persistent classes that are not currently associated with a ISession. They may have been instantiated by the application and not (yet) persisted or they may have been instantiated by a closed ISession.

ITransaction (NHibernate.ITransaction)

(Optional) A single-threaded, short-lived object used by the application to specify atomic units of work. Abstracts application from underlying ADO.NET transaction. An ISession might span several ITransactions in some cases.

IConnectionProvider (NHibernate.Connection.IConnectionProvider)

(Optional) A factory for ADO.NET connections and commands. Abstracts application from the concrete vendor-specific implementations of IDbConnection and IDbCommand. Not exposed to application, but can be extended/implemented by the developer.

IDriver (NHibernate.Driver.IDriver)

(Optional) An interface encapsulating differences between ADO.NET providers, such as parameter naming conventions and supported ADO.NET features.

ITransactionFactory (NHibernate.Transaction.ITransactionFactory)

(Optional) A factory for ITransaction instances. Not exposed to the application, but can be extended/implemented by the developer.

Given a "lite" architecture, the application bypasses the ITransaction, ITransactionFactory and/or IConnectionProvider APIs to talk to ADO.NET directly.

Architecture

Fabio Maulo — Sun, 31 Aug 2008 23:25:03 GMT
Revision 3 posted to NHibernate 2.0 by Fabio Maulo on 31/08/2008 08:25:03 p.m.

Architecture

Overview

A (very) high-level view of the NHibernate architecture:

This diagram shows NHibernate using the database and configuration data to provide persistence services (and persistent objects) to the application.

We would like to show a more detailed view of the runtime architecture. Unfortunately, NHibernate is flexible and supports several approaches. We will show the two extremes. The "lite" architecture has the application provide its own ADO.NET connections and manage its own transactions. This approach uses a minimal subset of NHibernate's APIs:

The "full cream" architecture abstracts the application away from the underlying ADO.NET APIs and lets NHibernate take care of the details.

Here some definitions of the objects in the diagrams:

ISessionFactory (NHibernate.ISessionFactory)

A threadsafe (immutable) cache of compiled mappings for a single database. A factory for ISession and a client of IConnectionProvider. Might hold an optional (second-level) cache of data that is reusable between transactions, at a process- or cluster-level.

ISession (NHibernate.ISession)

A single-threaded, short-lived object representing a conversation between the application and the persistent store. Wraps an ADO.NET connection. Factory for ITransaction. Holds a mandatory (first-level) cache of persistent objects, used when navigating the object graph or looking up objects by identifier.

Persistent Objects and Collection

Short-lived, single threaded objects containing persistent state and business function. These might be ordinary POCOs, the only special thing about them is that they are currently associated with (exactly one) ISession. As soon as the Session is closed, they will be detached and free to use in any application layer (e.g. directly as data transfer objects to and from presentation).

Transient Objects and Collections

Instances of persistent classes that are not currently associated with a ISession. They may have been instantiated by the application and not (yet) persisted or they may have been instantiated by a closed ISession.

ITransaction (NHibernate.ITransaction)

(Optional) A single-threaded, short-lived object used by the application to specify atomic units of work. Abstracts application from underlying ADO.NET transaction. An ISession might span several ITransactions in some cases.

IConnectionProvider (NHibernate.Connection.IConnectionProvider)

(Optional) A factory for ADO.NET connections and commands. Abstracts application from the concrete vendor-specific implementations of IDbConnection and IDbCommand. Not exposed to application, but can be extended/implemented by the developer.

IDriver (NHibernate.Driver.IDriver)

(Optional) An interface encapsulating differences between ADO.NET providers, such as parameter naming conventions and supported ADO.NET features.

ITransactionFactory (NHibernate.Transaction.ITransactionFactory)

(Optional) A factory for ITransaction instances. Not exposed to the application, but can be extended/implemented by the developer.

Given a "lite" architecture, the application bypasses the ITransaction, ITransactionFactory and/or IConnectionProvider APIs to talk to ADO.NET directly.

Architecture

Fabio Maulo — Sun, 31 Aug 2008 23:24:38 GMT
Revision 2 posted to NHibernate 2.0 by Fabio Maulo on 31/08/2008 08:24:38 p.m.

Architecture

Overview

A (very) high-level view of the NHibernate architecture:

This diagram shows NHibernate using the database and configuration data to provide persistence services (and persistent objects) to the application.

We would like to show a more detailed view of the runtime architecture. Unfortunately, NHibernate is flexible and supports several approaches. We will show the two extremes. The "lite" architecture has the application provide its own ADO.NET connections and manage its own transactions. This approach uses a minimal subset of NHibernate's APIs:

The "full cream" architecture abstracts the application away from the underlying ADO.NET APIs and lets NHibernate take care of the details.

Here some definitions of the objects in the diagrams:
<dl> <dt>

ISessionFactory (<tt>NHibernate.ISessionFactory</tt>) </dt><dd> NHibernate.ISessionFactory)

A threadsafe (immutable) cache of compiled mappings for a single database. A factory for <tt>ISession</tt> ISession and a client of <tt>IConnectionProvider</tt>. IConnectionProvider. Might hold an optional (second-level) cache of data that is reusable between transactions, at a process- or cluster-level.

</dd><dt>

ISession (<tt>NHibernate.ISession</tt>) </dt><dd> NHibernate.ISession)

A single-threaded, short-lived object representing a conversation between the application and the persistent store. Wraps an ADO.NET connection. Factory for <tt>ITransaction</tt>. ITransaction. Holds a mandatory (first-level) cache of persistent objects, used when navigating the object graph or looking up objects by identifier.

</dd><dt>

Persistent Objects and Collections </dt><dd> Collection

Short-lived, single threaded objects containing persistent state and business function. These might be ordinary POCOs, the only special thing about them is that they are currently associated with (exactly one) <tt>ISession</tt>. ISession. As soon as the <tt>Session</tt> Session is closed, they will be detached and free to use in any application layer (e.g. directly as data transfer objects to and from presentation).

</dd><dt>

Transient Objects and Collections </dt><dd>

Instances of persistent classes that are not currently associated with a <tt>ISession</tt>. ISession. They may have been instantiated by the application and not (yet) persisted or they may have been instantiated by a closed <tt>ISession</tt>.

</dd><dt>ISession.

ITransaction (<tt>NHibernate.ITransaction</tt>) </dt><dd> NHibernate.ITransaction)

(Optional) A single-threaded, short-lived object used by the application to specify atomic units of work. Abstracts application from underlying ADO.NET transaction. An <tt>ISession</tt> ISession might span several <tt>ITransaction</tt>s ITransactions in some cases.

</dd><dt>

IConnectionProvider (<tt>NHibernate.Connection.IConnectionProvider</tt>) </dt><dd> NHibernate.Connection.IConnectionProvider)

(Optional) A factory for ADO.NET connections and commands. Abstracts application from the concrete vendor-specific implementations of <tt>IDbConnection</tt> IDbConnection and <tt>IDbCommand</tt>. IDbCommand. Not exposed to application, but can be extended/implemented by the developer.

</dd><dt>

IDriver (<tt>NHibernate.Driver.IDriver</tt>) </dt><dd> NHibernate.Driver.IDriver)

(Optional) An interface encapsulating differences between ADO.NET providers, such as parameter naming conventions and supported ADO.NET features.

</dd><dt>

ITransactionFactory (<tt>NHibernate.Transaction.ITransactionFactory</tt>) </dt><dd> NHibernate.Transaction.ITransactionFactory)

(Optional) A factory for <tt>ITransaction</tt> ITransaction instances. Not exposed to the application, but can be extended/implemented by the developer.
</dd></dl>

Given a "lite" architecture, the application bypasses the <tt>ITransaction</tt>/<tt>ITransactionFactory</tt> ITransaction, ITransactionFactory and/or <tt>IConnectionProvider</tt> IConnectionProvider APIs to talk to ADO.NET directly.

Architecture

Fabio Maulo — Sun, 31 Aug 2008 23:18:37 GMT
Revision 1 posted to NHibernate 2.0 by Fabio Maulo on 31/08/2008 08:18:37 p.m.

Overview

A (very) high-level view of the NHibernate architecture:

This diagram shows NHibernate using the database and configuration data to provide persistence services (and persistent objects) to the application.

We would like to show a more detailed view of the runtime architecture. Unfortunately, NHibernate is flexible and supports several approaches. We will show the two extremes. The "lite" architecture has the application provide its own ADO.NET connections and manage its own transactions. This approach uses a minimal subset of NHibernate's APIs:

The "full cream" architecture abstracts the application away from the underlying ADO.NET APIs and lets NHibernate take care of the details.

Here some definitions of the objects in the diagrams:
<dl> <dt>ISessionFactory (<tt>NHibernate.ISessionFactory</tt>) </dt><dd>
A threadsafe (immutable) cache of compiled mappings for a single database. A factory for <tt>ISession</tt> and a client of <tt>IConnectionProvider</tt>. Might hold an optional (second-level) cache of data that is reusable between transactions, at a process- or cluster-level.

</dd><dt>ISession (<tt>NHibernate.ISession</tt>) </dt><dd>
A single-threaded, short-lived object representing a conversation between the application and the persistent store. Wraps an ADO.NET connection. Factory for <tt>ITransaction</tt>. Holds a mandatory (first-level) cache of persistent objects, used when navigating the object graph or looking up objects by identifier.

</dd><dt>Persistent Objects and Collections </dt><dd>
Short-lived, single threaded objects containing persistent state and business function. These might be ordinary POCOs, the only special thing about them is that they are currently associated with (exactly one) <tt>ISession</tt>. As soon as the <tt>Session</tt> is closed, they will be detached and free to use in any application layer (e.g. directly as data transfer objects to and from presentation).

</dd><dt>Transient Objects and Collections </dt><dd>
Instances of persistent classes that are not currently associated with a <tt>ISession</tt>. They may have been instantiated by the application and not (yet) persisted or they may have been instantiated by a closed <tt>ISession</tt>.

</dd><dt>ITransaction (<tt>NHibernate.ITransaction</tt>) </dt><dd>
(Optional) A single-threaded, short-lived object used by the application to specify atomic units of work. Abstracts application from underlying ADO.NET transaction. An <tt>ISession</tt> might span several <tt>ITransaction</tt>s in some cases.

</dd><dt>IConnectionProvider (<tt>NHibernate.Connection.IConnectionProvider</tt>) </dt><dd>
(Optional) A factory for ADO.NET connections and commands. Abstracts application from the concrete vendor-specific implementations of <tt>IDbConnection</tt> and <tt>IDbCommand</tt>. Not exposed to application, but can be extended/implemented by the developer.

</dd><dt>IDriver (<tt>NHibernate.Driver.IDriver</tt>) </dt><dd>
(Optional) An interface encapsulating differences between ADO.NET providers, such as parameter naming conventions and supported ADO.NET features.

</dd><dt>ITransactionFactory (<tt>NHibernate.Transaction.ITransactionFactory</tt>) </dt><dd>
(Optional) A factory for <tt>ITransaction</tt> instances. Not exposed to the application, but can be extended/implemented by the developer.
</dd></dl>
Given a "lite" architecture, the application bypasses the <tt>ITransaction</tt>/<tt>ITransactionFactory</tt> and/or <tt>IConnectionProvider</tt> APIs to talk to ADO.NET directly.

Known "Breaking Changes"

Stefan Steinegger — Mon, 18 May 2009 11:08:53 GMT
Current revision posted to NHibernate 2.0 by Stefan Steinegger on 18/05/2009 08:08:53 a.m.

Knows Known "Breaking Changes"

In this section we will try to document all known "Breaking changes".

Knows "Breaking Changes"

Fabio Maulo — Mon, 11 May 2009 15:00:53 GMT
Revision 1 posted to NHibernate 2.0 by Fabio Maulo on 11/05/2009 12:00:53 p.m.

In this section we will try to document all known "Breaking changes".

from NH1.2.1GA to NH2.0.0

Fabio Maulo — Mon, 11 May 2009 15:09:53 GMT
Current revision posted to NHibernate 2.0 by Fabio Maulo on 11/05/2009 12:09:53 p.m.

Infrastructure

* .NET 1.1 is no longer supported

* Nullables.NHibernate is no longer supported (use nullable types of .NET 2.0)

* Contrib projects moved to http://sourceforge.net/projects/nhcontrib

Compile time

* NHibernate.Expression namespace was renamed to NHibernate.Criterion

* IInterceptor have additional methods. (IsUnsaved was renamed IsTransient)

* INamingStrategy

* IType

* IEntityPersister

* IVersionType

* IBatcher

* IUserCollectionType

* IEnhancedUserType

* IPropertyAccessor

* ValueTypeType renamed to PrimitiveType

Possible Breaking Changes for external frameworks

* Various classes were moved between namespaces

* Various classes have been renamed (to match Hibernate 3.2 names)

* ISession interface have additional methods

* ICacheProvider

* ICriterion

* CriteriaQueryTranslator

Initialization time

* <nhibernate> section, in App.config, is no longer supported and will be ignored. Configuration schema for configuration file and App.config is now identical, and the App.config section name is: <hibernate-configuration>

* <hibernate-configuration> have a different schema and all properties names are cheked

* configuration properties are no longer prefixed by "hibernate.", if before you would specify "hibernate.dialect", now you specify just "dialect"

* All named queries will be validated at initialization time, an exception will be thrown if any is not valid (can be disabled if needed)

* Stricter checks for proxying classes (all public methods must be virtual)

Run time

* SaveOrUpdateCopy() returns a new instance of the entity without changing the original

* AutoFlush will not occur outside a transaction - Database transactions are never optional, all communication with the database must occur inside a transaction, whatever you read or write data.

* NHibernate will return long for count(*) queries on SQL Server

* <formula> must contain parenthesis when needed

* The HQL functions names may cause conflic in your HQL (reserved names are: substring,locate,trim,length,bit_length,coalesce,nullif,abs,mod,sqrt,upper,lower,cast,extract,concat,current_timestamp,sysdate,second,minute,hour,day,month,year,str)

* <any> when meta-type="class" the persistent type is a string containing the Class.FullName (In order to set a parameter in a query you must use SetParameter("paraName", typeof(YourClass).FullName, NHibernateUtil.ClassMetaType) )

Mapping

* <any> : default meta-type is "string" (was "class")

From 1.0 to 1.2

Fabio Maulo — Mon, 11 May 2009 15:01:40 GMT
Current revision posted to NHibernate 2.0 by Fabio Maulo on 11/05/2009 12:01:40 p.m.

NHibernate 1.2

NHibernate 1.2 is mostly source-compatible with NHibernate 1.0. However, it is not intended as a drop-in replacement for 1.0.

This document describes the changes between NHibernate 1.0 and NHibernate 1.2 that will affect existing applications, and mentions certain new features of NHibernate 1.2 that might be useful to existing applications.

Changes are classified into API changes (affecting source code), metadata changes (affecting the XML O/R mapping metadata), query language changes (affecting HQL queries), runtime behavior changes, and security-related changes.

API Changes

ISession interface

Redundant query execution methods were deprecated in ISession interface. These methods are:

Find(),

Enumerable(),

Filter()

NHibernate 1.2 applications should use CreateQuery() for all query execution. Existing applications may continue to use the deprecated methods.

ISession.CreateSQLQuery()

The overloaded forms of CreateSQLQuery() which took arrays have been deprecated. There is a new ISQLQuery interface (returned by CreateSQLQuery(String)) which provides equivalent functionality (and more). Existing applications may continue to use the deprecated methods.

ILifecycle and IValidatable interfaces

The ILifecycle and IValidatable interfaces were deprecated in NHibernate 1.2 and moved to the NHibernate.Classic namespace. The Hibernate team does not consider it good practice to have domain model classes depend upon persistence-specific APIs. NHibernate 1.2 applications should use IInterceptor interface. Existing applications may continue to use ILifecycle and IValidatable.

IInterceptor interface

Several new methods were added to the IInterceptor interface. Existing interceptors will need to be ugraded to provide empty implementations of the two new methods.

To avoid issues with interceptor migration (whether 1.0.x -> 1.2.x, or moving forward), just extend the new EmptyInterceptor class instead of writing your own empty implementation for all methods you don't need.

IUserType and ICompositeUserType interfaces

Both IUserType and ICompositeUserType had several methods added, to support new functionality of NHibernate 1.2. They were moved to the namespaceNHibernate.UserTypes. Existing user type classes will need to be upgraded to implement the new methods.

Note: NHibernate 1.2 provides IParameterizedType interface to allow better re-useability of user type implementations.

FetchMode

FetchMode.Lazy and FetchMode.Eager were deprecated. The more accurately named FetchMode.Select and FetchMode.Join have the same effect.

Changes to extension APIs

The NHibernate.Expression, NHibernate.Mapping, NHibernate.Persister and NHibernate.Collection namespaces feature heavy refactoring. Most NHibernate 1.0 applications do not depend upon these namespaces, and will not be affected. If your application does extend classes in these namespaces, you will need to carefully migrate the affected code.

Metadata Changes

Association fetching strategies

Since it is best practice to map almost all classes and collections using lazy="true", that is now the default. Existing applications will need to explicitly specify lazy="false"on all non-lazy class and collection mappings. For the lazy classes to function correctly, all their public and protected members must be virtual (overridable). Since this is a very significant potential source of errors when developing on .NET, NHibernate 1.2 will check at configuration time that all lazy classes fulfill the requirements.

The outer-join attribute is deprecated. Use fetch="join" and fetch="select" instead of outer-join="true" and outer-join="false". Existing applications may continue to use theouter-join attribute, or may use a text search/replace to migrate to use of the fetch attribute.

Beware, this means you have to put lazy="false" on all collection mappings and classes which previously did not have a "lazy"-attribute.

A quick and dirty alternative for migration is also to put default-lazy="false" on all your hibernate-mapping elements.

Schema namespace

Update the XML schema reference in your hbm XML files. Change urn:nhibernate-mapping-2.0 to urn:nhibernate-mapping-2.2 in the hibernate-mapping element. If you get "XML validation error: Could not find schema information for the element 'urn:nhibernate-mapping-2.0:hibernate-mapping'", you forgot to change the namespace.

One-to-many association to a subclass requires explicit where attribute.

If you have a one-to-many association to a class that is part of a subclass hierarchy (i.e. using table-per-class-hierarchy strategy), you may need to add a where attribute to the collection element since NHibernate no longer adds the discriminator restriction automatically.

This is probably best explained in code. The mapping below will no longer work as intended:

<class name="Person"> ...  <bag name="Cats"> <one-to-many class="Cat" /> </bag> <bag name="Dogs"> <one-to-many class="Dog" /> </bag> </class>

To make it work again, add explicit where attributes:

<class name="Person"> ... <bag name="Cats" where="discriminator = 'CAT'"> <one-to-many class="Cat" /> </bag> <bag name="Dogs" where="discriminator = 'DOG'"> <one-to-many class="Dog" /> </bag> </class>

Runtime Changes

Database connection release mode

In NHibernate 1.0 a session acquired a database connection when needed and then held onto to it until closed. As of 1.2, however, the session will release the connection after the database transaction completes. If you are not using NHibernate transactions, the session assumes it is in auto-commit mode, and will release the connection after every operation. The session will automatically re-acquire connection the next time it is needed.

This behavior can be overridden, but typically it is best to not override this default (unless you are using NHibernate with distributed transactions, in which case the default behavior is inappropriate). If your application depends on some quirk of the old behavior (like having the same connection available beyond transaction boundaries, etc) then you may need to tweak this; but you should view this as a problem with your application logic and fix that. Or, if you believe that you can "read data without or outside of a transaction", you will likely face problems in the future versions of NHibernate. Of course, there can be no data access outside of a transaction, be it read or write access, and NHibernate will make it much more difficult to write bad code that relies on auto-commit side effects. See section "Connection Release Modes" in the documentation for more details.

Version numbers start with 1

The version property of a transient entity will be set to 1 when the entity is persisted (NHibernate 1.0 set the version number to 0). This was done to allow using a non-nullable type for the version property (such as Int32 or Int64), so that 0 could be used as unsaved-value for the property.

ISession.Get() will never return an unitialized proxy

Previously, calling ISession.Get() could return an uninitialized proxy if the session contained the proxy as a result of some earlier operations. In NHibernate 1.2, Get() will initialize the proxy in this case before returning it.

ISession.Transaction is always active

ISession.Transaction property gives access to the current transaction associated with a session. Unlike previous NHibernate versions, as soon as this transaction is committed, a new transaction is associated with the session. Thus, ISession.Transaction.WasCommitted and WasRolledBack will always return false.

To be able to check the status of a particular transaction, assign it to a local variable:

ITransaction myTransaction = ISession.Transaction; ISession.Transaction.Commit(); // ISession.Transaction.WasCommitted is false here, // myTransaction.WasCommitted is true.

Changes in ADO.NET provider assembly loading

NHibernate 1.2 now uses Assembly.Load() instead of Assembly.LoadWithPartialName() to load driver assemblies. This means that it will no longer look for the highest-versioned assembly in the Global Assembly Cache (GAC), which was sometimes undesirable. Instead, it is now your responsibility to either put the provider assembly into the application directory, or add a qualifyAssembly element to the application configuration file, specifying the full name of the assembly.

For example, if you are using MySQL Connector/.NET, you should either put MySql.Data.dll into the application directory (or some other directory from whereAssembly.Load() can pick it up), or put it in the GAC and add a qualifyAssembly element to the configuration file:

<qualifyAssembly partialName="MySql.Data" fullName="MySql.Data, Version=..., PublicKeyToken=..."/>

Query Language Changes

Changed aggregation (count, sum, avg) function return types

In alignment with Hibernate, the count, sum and avg functions now default to return types as specified by the JPA specification. This can result in InvalidCastException 's at runtime if you used aggregation in HQL queries.

The new type rules are as follows:

COUNT returns Int64.

MAX, MIN return the type of the property to which they are applied.

AVG returns Double.

SUM returns Int64 when applied to properties of integral types; Double when applied to properties of floating point types; and Decimal when applied to state-fields of type Decimal.

If you cannot change to the new type handling the following code can be used to provide "classic" NHibernate behavior for HQL aggregation.

Configuration classicCfg = new Configuration(); classicCfg.AddSqlFunction( "count", new ClassicCountFunction()); classicCfg.AddSqlFunction( "avg", new ClassicAvgFunction()); classicCfg.AddSqlFunction( "sum", new ClassicSumFunction()); ISessionFactory classicSf = classicCfg.BuildSessionFactory();

Empty Disjunction evaluates to false

A Disjunction with no added conditions will always evaluate to false. This is a change from 1.0 and Hibernate, where an empty disjunction evaluates to true, but we feel it is more correct.

Security-Related Changes

Strong name key is now public

NHibernate now uses a publicly available strong name key pair (NHibernate.snk) to strong-name binary .NET assemblies. If you relied on the key being kept private for security, you should switch to other means of assuring assembly integrity, such as using a cryptographic hash.

The original key pair used to sign NHibernate 1.0.x assemblies is still kept private.

Assemblies are marked with AllowPartiallyTrustedCallersAttribute

Several assemblies have AllowPartiallyTrustedCallersAttribute (APTCA) applied to them, to make it easier to use NHibernate under Medium Trust Level. This attribute may potentially introduce security issues. To recompile NHibernate without APTCA, use this NAnt command:

nant -D:assembly.allow-partially-trusted-callers=false build

NHibernate 2.0 Reference Documentation

Tobin Harris — Sun, 08 Feb 2009 00:57:31 GMT
Current revision posted to NHibernate 2.0 by Tobin Harris on 07/02/2009 09:57:31 p.m.

PrefaceNHibernate 2.0 Reference Documentation

Here static reference
View the NHibernate 2.0 Reference Manual (opens single HTML page in a new window)

Note that if you're new to NHibernate, the remainder of this article may provide an easier way to learn to understand NHibernate.

Working with object-oriented software and a relational database can be cumbersome and time consuming in today's enterprise environments. NHibernate is an object/relational mapping tool for .NET environments. The term object/relational mapping (ORM) refers to the technique of mapping a data representation from an object model to a relational data model with a SQL-based schema.

NHibernate not only takes care of the mapping from .NET classes to database tables (and from .NET data types to SQL data types), but also provides data query and retrieval facilities and can significantly reduce development time otherwise spent with manual data handling in SQL and ADO.NET.

NHibernate's goal is to relieve the developer from 95 percent of common data persistence related programming tasks. NHibernate may not be the best solution for data-centric applications that only use stored-procedures to implement the business logic in the database, it is most useful with object-oriented domain models and business logic in the .NET-based middle-tier. However, NHibernate can certainly help you to remove or encapsulate vendor-specific SQL code and will help with the common task of result set translation from a tabular representation to a graph of objects.

If you are new to NHibernate and Object/Relational Mapping or even .NET Framework, please follow these steps:

Read Your first NHibernate based application for a 30 minutes tutorial.

Read Architecture to understand the environments where NHibernate can be used.

FAQs are answered on the NHibernate community blog.

If you have questions, use the NHibernate group. We also provide a JIRA issue trackings system for bug reports and feature requests. If you are interested in the development of NHibernate, join the developer mailing list.

Preface

Ken Egozi — Wed, 24 Sep 2008 14:25:37 GMT
Revision 7 posted to NHibernate 2.0 by Ken Egozi on 24/09/2008 11:25:37 a.m.

Preface

Here static reference

Working with object-oriented software and a relational database can be cumbersome and time consuming in today's enterprise environments. NHibernate is an object/relational mapping tool for .NET environments. The term object/relational mapping (ORM) refers to the technique of mapping a data representation from an object model to a relational data model with a SQL-based schema.

NHibernate not only takes care of the mapping from .NET classes to database tables (and from .NET data types to SQL data types), but also provides data query and retrieval facilities and can significantly reduce development time otherwise spent with manual data handling in SQL and ADO.NET.

NHibernate's goal is to relieve the developer from 95 percent of common data persistence related programming tasks. NHibernate may not be the best solution for data-centric applications that only use stored-procedures to implement the business logic in the database, it is most useful with object-oriented domain models and business logic in the .NET-based middle-tier. However, NHibernate can certainly help you to remove or encapsulate vendor-specific SQL code and will help with the common task of result set translation from a tabular representation to a graph of objects.

If you are new to NHibernate and Object/Relational Mapping or even .NET Framework, please follow these steps:

Read Your first NHibernate based application for a 30 minute minutes tutorial.

Read Architecture to understand the environments where NHibernate can be used.

FAQs are answered on the NHibernate community blog.

If you have questions, use the NHibernate group. We also provide a JIRA issue trackings system for bug reports and feature requests. If you are interested in the development of NHibernate, join the developer mailing list.

Preface

Fabio Maulo — Sat, 06 Sep 2008 17:02:42 GMT
Revision 6 posted to NHibernate 2.0 by Fabio Maulo on 06/09/2008 02:02:42 p.m.

Preface

Static
Here static reference

Working with object-oriented software and a relational database can be cumbersome and time consuming in today's enterprise environments. NHibernate is an object/relational mapping tool for .NET environments. The term object/relational mapping (ORM) refers to the technique of mapping a data representation from an object model to a relational data model with a SQL-based schema.

NHibernate not only takes care of the mapping from .NET classes to database tables (and from .NET data types to SQL data types), but also provides data query and retrieval facilities and can significantly reduce development time otherwise spent with manual data handling in SQL and ADO.NET.

NHibernate's goal is to relieve the developer from 95 percent of common data persistence related programming tasks. NHibernate may not be the best solution for data-centric applications that only use stored-procedures to implement the business logic in the database, it is most useful with object-oriented domain models and business logic in the .NET-based middle-tier. However, NHibernate can certainly help you to remove or encapsulate vendor-specific SQL code and will help with the common task of result set translation from a tabular representation to a graph of objects.

If you are new to NHibernate and Object/Relational Mapping or even .NET Framework, please follow these steps:

Read Your first NHibernate based application for a 30 minute tutorial.

ReadChapter 2, Architecture to understand the environments where NHibernate can be used.

FAQs are answered on the NHibernate community blog.

If you have questions, use the NHibernate group. We also provide a JIRA issue trackings system for bug reports and feature requests. If you are interested in the development of NHibernate, join the developer mailing list.

Preface

Fabio Maulo — Thu, 04 Sep 2008 05:10:39 GMT
Revision 5 posted to NHibernate 2.0 by Fabio Maulo on 04/09/2008 02:10:39 a.m.

Preface

Static reference

Working with object-oriented software and a relational database can be cumbersome and time consuming in today's enterprise environments. NHibernate is an object/relational mapping tool for .NET environments. The term object/relational mapping (ORM) refers to the technique of mapping a data representation from an object model to a relational data model with a SQL-based schema.

NHibernate not only takes care of the mapping from .NET classes to database tables (and from .NET data types to SQL data types), but also provides data query and retrieval facilities and can significantly reduce development time otherwise spent with manual data handling in SQL and ADO.NET.

NHibernate's goal is to relieve the developer from 95 percent of common data persistence related programming tasks. NHibernate may not be the best solution for data-centric applications that only use stored-procedures to implement the business logic in the database, it is most useful with object-oriented domain models and business logic in the .NET-based middle-tier. However, NHibernate can certainly help you to remove or encapsulate vendor-specific SQL code and will help with the common task of result set translation from a tabular representation to a graph of objects.

If you are new to NHibernate and Object/Relational Mapping or even .NET Framework, please follow these steps:

Read Your first NHibernate based application for a 30 minute tutorial.

Read Chapter 2, Architecture to understand the environments where NHibernate can be used.

FAQs are answered on the NHibernate community blog.

If you have questions, use the NHibernate group. We also provide a JIRA issue trackings system for bug reports and feature requests. If you are interested in the development of NHibernate, join the developer mailing list.

Preface

Fabio Maulo — Mon, 01 Sep 2008 05:51:55 GMT
Revision 4 posted to NHibernate 2.0 by Fabio Maulo on 01/09/2008 02:51:55 a.m.

Preface

Staic
Static reference

Working with object-oriented software and a relational database can be cumbersome and time consuming in today's enterprise environments. NHibernate is an object/relational mapping tool for .NET environments. The term object/relational mapping (ORM) refers to the technique of mapping a data representation from an object model to a relational data model with a SQL-based schema.

NHibernate not only takes care of the mapping from .NET classes to database tables (and from .NET data types to SQL data types), but also provides data query and retrieval facilities and can significantly reduce development time otherwise spent with manual data handling in SQL and ADO.NET.

NHibernate's goal is to relieve the developer from 95 percent of common data persistence related programming tasks. NHibernate may not be the best solution for data-centric applications that only use stored-procedures to implement the business logic in the database, it is most useful with object-oriented domain models and business logic in the .NET-based middle-tier. However, NHibernate can certainly help you to remove or encapsulate vendor-specific SQL code and will help with the common task of result set translation from a tabular representation to a graph of objects.

If you are new to NHibernate and Object/Relational Mapping or even .NET Framework, please follow these steps:

Read Your first NHibernate based application for a 30 minute tutorial.

Read Chapter 2, Architecture to understand the environments where NHibernate can be used.

FAQs are answered on the NHibernate community blog.

If you have questions, use the NHibernate group. We also provide a JIRA issue trackings system for bug reports and feature requests. If you are interested in the development of NHibernate, join the developer mailing list.

Preface

Fabio Maulo — Mon, 01 Sep 2008 05:50:43 GMT
Revision 3 posted to NHibernate 2.0 by Fabio Maulo on 01/09/2008 02:50:43 a.m.

Preface

Staic reference

Working with object-oriented software and a relational database can be cumbersome and time consuming in today's enterprise environments. NHibernate is an object/relational mapping tool for .NET environments. The term object/relational mapping (ORM) refers to the technique of mapping a data representation from an object model to a relational data model with a SQL-based schema.

NHibernate not only takes care of the mapping from .NET classes to database tables (and from .NET data types to SQL data types), but also provides data query and retrieval facilities and can significantly reduce development time otherwise spent with manual data handling in SQL and ADO.NET.

NHibernate's goal is to relieve the developer from 95 percent of common data persistence related programming tasks. NHibernate may not be the best solution for data-centric applications that only use stored-procedures to implement the business logic in the database, it is most useful with object-oriented domain models and business logic in the .NET-based middle-tier. However, NHibernate can certainly help you to remove or encapsulate vendor-specific SQL code and will help with the common task of result set translation from a tabular representation to a graph of objects.

If you are new to NHibernate and Object/Relational Mapping or even .NET Framework, please follow these steps:

Read Your first NHibernate based application for a 30 minute tutorial.

Read Chapter 2, Architecture to understand the environments where NHibernate can be used.

FAQs are answered on the NHibernate community blog.

If you have questions, use the NHibernate group. We also provide a JIRA issue trackings system for bug reports and feature requests. If you are interested in the development of NHibernate, join the developer mailing list.

Preface

Fabio Maulo — Sun, 31 Aug 2008 23:02:02 GMT
Revision 2 posted to NHibernate 2.0 by Fabio Maulo on 31/08/2008 08:02:02 p.m.

Preface

Working with object-oriented software and a relational database can be cumbersome and time consuming in today's enterprise environments. NHibernate is an object/relational mapping tool for .NET environments. The term object/relational mapping (ORM) refers to the technique of mapping a data representation from an object model to a relational data model with a SQL-based schema.

NHibernate not only takes care of the mapping from .NET classes to database tables (and from .NET data types to SQL data types), but also provides data query and retrieval facilities and can significantly reduce development time otherwise spent with manual data handling in SQL and ADO.NET.

NHibernate's goal is to relieve the developer from 95 percent of common data persistence related programming tasks. NHibernate may not be the best solution for data-centric applications that only use stored-procedures to implement the business logic in the database, it is most useful with object-oriented domain models and business logic in the .NET-based middle-tier. However, NHibernate can certainly help you to remove or encapsulate vendor-specific SQL code and will help with the common task of result set translation from a tabular representation to a graph of objects.

If you are new to NHibernate and Object/Relational Mapping or even .NET Framework, please follow these steps:

Read Your first NHibernate based application for a 30 minute tutorial.

Read Chapter 2, Architecture to understand the environments where NHibernate can be used.

FAQs are answered on the NHibernate community blog.

Google "NHibernate", is a good source for design patterns and various integration solutions (ASP.NET, Windows Forms).

If you have questions, use the NHibernate group. We also provide a JIRA issue trackings system for bug reports and feature requests. If you are interested in the development of NHibernate, join the developer mailing list.

Preface

Fabio Maulo — Sun, 31 Aug 2008 22:59:22 GMT
Revision 1 posted to NHibernate 2.0 by Fabio Maulo on 31/08/2008 07:59:22 p.m.

Working with object-oriented software and a relational database can be cumbersome and time consuming in today's enterprise environments. NHibernate is an object/relational mapping tool for .NET environments. The term object/relational mapping (ORM) refers to the technique of mapping a data representation from an object model to a relational data model with a SQL-based schema.

NHibernate not only takes care of the mapping from .NET classes to database tables (and from .NET data types to SQL data types), but also provides data query and retrieval facilities and can significantly reduce development time otherwise spent with manual data handling in SQL and ADO.NET.

NHibernate's goal is to relieve the developer from 95 percent of common data persistence related programming tasks. NHibernate may not be the best solution for data-centric applications that only use stored-procedures to implement the business logic in the database, it is most useful with object-oriented domain models and business logic in the .NET-based middle-tier. However, NHibernate can certainly help you to remove or encapsulate vendor-specific SQL code and will help with the common task of result set translation from a tabular representation to a graph of objects.

If you are new to NHibernate and Object/Relational Mapping or even .NET Framework, please follow these steps:

Read Your first NHibernate based application for a 30 minute tutorial.

Read Chapter 2, Architecture to understand the environments where NHibernate can be used.

FAQs are answered on the NHibernate community blog.

Google "NHibernate", is a good source for design patterns and various integration solutions (ASP.NET, Windows Forms).

If you have questions, use the NHibernate group. We also provide a JIRA issue trackings system for bug reports and feature requests. If you are interested in the development of NHibernate, join the developer mailing list.

Query Syntax

Diego Jancic — Thu, 08 Jan 2009 00:01:48 GMT
Current revision posted to NHibernate 2.0 by Diego Jancic on 07/01/2009 09:01:48 p.m.

Query Syntax

Below is the HQL full sintax, based on the latest Hibernate version, and which is being implemented in NHibernate. However, some statements or expressions might be not yet valid for NHibernate.

Syntax

<Query> ::= <SelectStatement>

| <DeleteStatement>

| <UpdateStatement>

| <InsertStatement>

<DeleteStatement> ::= DELETE <AliasedEntityName> <WhereClause>

| DELETE FROM <AliasedEntityName> <WhereClause>

<UpdateStatement> ::= UPDATE <AliasedEntityName> SET <AssignList> <WhereClause>

| UPDATE VERSIONED <AliasedEntityName> SET <AssignList> <WhereClause>

| UPDATE FROM <AliasedEntityName> SET <AssignList> <WhereClause>

| UPDATE VERSIONED FROM <AliasedEntityName> SET <AssignList> <WhereClause>

<AssignList> ::= <EntityName> '=' <Expression> ',' <AssignList>

| <EntityName> '=' <Expression>

<InsertStatement> ::= INSERT INTO <EntityName> '(' <EntityNameList> ')' <SelectStatement>

<SelectStatement> ::= <SelectClause> <FromClause>

| <FromClause>

<SelectClause> ::= SELECT <Restriction> <AliasedExpressionList>

| SELECT NEW <EntityName> '(' <ExpressionList> ')'

<FromClause> ::= FROM <AliasedEntityNameList> <JoinClauseChain> <WhereClause> <GroupByClause> <HavingClause> <OrderByClause>

<JoinClauseChain> ::= <JoinClause> <JoinClauseChain>

| <JoinClause> ',' <AliasedEntityNameList> <JoinClauseChain>

|

<JoinClause> ::= <JoinDefinition> <WithClause>

<JoinDefinition> ::= LEFT JOIN <AliasedEntityName>

| RIGHT JOIN <AliasedEntityName>

| LEFT OUTER JOIN <AliasedEntityName>

| RIGHT OUTER JOIN <AliasedEntityName>

| FULL JOIN <AliasedEntityName>

| INNER JOIN <AliasedEntityName>

| LEFT JOIN FETCH <AliasedEntityName>

| LEFT OUTER JOIN FETCH <AliasedEntityName>

| INNER JOIN FETCH <AliasedEntityName>

| JOIN <AliasedEntityName>

| JOIN FETCH <AliasedEntityName>

<WithClause> ::= WITH <Expression>

|

<WhereClause> ::= WHERE <Expression>

|

<GroupByClause> ::= 'GROUP BY' <ExpressionList>

|

<HavingClause> ::= HAVING <Expression>

|

<OrderByClause> ::= 'ORDER BY' <OrderList>

|

<OrderList> ::= <OrderItem> ',' <OrderList>

| <OrderItem>

<OrderItem> ::= <Expression> <OrderType>

<OrderType> ::= ASC

| DESC

| ASCENDING

| DESCENDING

|

<Restriction> ::= ALL

| DISTINCT

|

<AggregateExpression> ::= COUNT '(' '*' ')'

| COUNT '(' <Restriction> <EntityName> ')'

| COUNT '(' <Restriction> <CollectionExpression> ')'

| AVG '(' <MathAddExpression> ')'

| MIN '(' <MathAddExpression> ')'

| MAX '(' <MathAddExpression> ')'

<FunctionExpression> ::= Identifier '(' ')'

| Identifier '(' <ExpressionList> ')'

| CAST '(' <Expression> AS Identifier ')'

| <TrimFunctionExpression>

| <ExtractFunctionExpression>

| YEAR '(' <Expression> ')'

| MONTH '(' <Expression> ')'

| DAY '(' <Expression> ')'

| HOUR '(' <Expression> ')'

| MINUTE '(' <Expression> ')'

| SECOND '(' <Expression> ')'

<TrimFunctionExpression> ::= TRIM '(' <StringValueExpression> ')'

| TRIM '(' <TrimOperands> <StringValueExpression> ')'

<TrimOperands> ::= <StringValueExpression> FROM

| <TrimSpecification> <StringValueExpression> FROM

| <TrimSpecification> FROM

| FROM

<TrimSpecification> ::= LEADING

| TRAILING

| BOTH

<ExtractFunctionExpression> ::= EXTRACT '(' <ExtractField> FROM <Expression> ')'

<ExtractField> ::= YEAR

| MONTH

| DAY

| HOUR

| MINUTE

| SECOND

| 'TIMEZONE_HOUR'

| 'TIMEZONE_MINUTE'

<CollectionExpression> ::= <ElementsExpression>

| INDICES '(' Path ')'

<ElementsExpression> ::= ELEMENTS '(' Path ')'

<EntityName> ::= Identifier

| Path

<EntityNameList> ::= <EntityName> ',' <EntityNameList>

| <EntityName>

<AliasedEntityName> ::= <EntityName> Identifier

| <EntityName> AS Identifier

| Identifier IN CLASS <EntityName>

| Identifier IN <ElementsExpression>

| <EntityName>

<AliasedEntityNameList> ::= <AliasedEntityName> ',' <AliasedEntityNameList>

| <AliasedEntityName>

<AliasedExpression> ::= <Expression> AS Identifier

| <Expression>

<AliasedExpressionList> ::= <AliasedExpression> ',' <AliasedExpressionList>

| <AliasedExpression>

<Expression> ::= <OrExpression>

| <AndExpression>

<OrExpression> ::= <AndExpression> OR <Expression>

<AndExpression> ::= <NotExpression> AND <AndExpression>

| <NotExpression>

<NotExpression> ::= NOT <PredicateExpression>

| <PredicateExpression>

<QuantifiedExpression> ::= SOME Path

| ALL Path

| ANY Path

| SOME <CollectionExpression>

| ALL <CollectionExpression>

| ANY <CollectionExpression>

| SOME '(' <SelectStatement> ')'

| ALL '(' <SelectStatement> ')'

| ANY '(' <SelectStatement> ')'

<PredicateExpression> ::= <MathAddExpression> BETWEEN <MathAddExpression> AND <MathAddExpression>

| <MathAddExpression> NOT BETWEEN <MathAddExpression> AND <MathAddExpression>

| <Value> IS NOT NULL

| <Value> IS NULL

| <Value> IS EMPTY

| <Value> IS NOT EMPTY

| <MathAddExpression> LIKE <ConcatenationExpression> <LikeEscape>

| <MathAddExpression> NOT LIKE <ConcatenationExpression> <LikeEscape>

| <MathAddExpression> IN <Tuple>

| <MathAddExpression> NOT IN <Tuple>

| <MathAddExpression> IN <CollectionExpression>

| <MathAddExpression> NOT IN <CollectionExpression>

| <MemberPredicate>

| <ExistsPredicate>

| <MathAddExpression> '>' <MathAddExpression>

| <MathAddExpression> '<' <MathAddExpression>

| <MathAddExpression> '=' <MathAddExpression>

| <MathAddExpression> '>=' <MathAddExpression>

| <MathAddExpression> '<=' <MathAddExpression>

| <MathAddExpression> NotEqualOperator <MathAddExpression>

| <MathAddExpression> '>' <QuantifiedExpression>

| <MathAddExpression> '<' <QuantifiedExpression>

| <MathAddExpression> '=' <QuantifiedExpression>

| <MathAddExpression> '>=' <QuantifiedExpression>

| <MathAddExpression> '<=' <QuantifiedExpression>

| <MathAddExpression> NotEqualOperator <QuantifiedExpression>

| <MathAddExpression>

<LikeEscape> ::= ESCAPE StringLiteral

|

<ExistsPredicate> ::= EXISTS Path

| EXISTS <CollectionExpression>

| EXISTS '(' <SelectStatement> ')'

<MemberPredicate> ::= Path MEMBER OF Path

| Path MEMBER Path

<MathAddExpression> ::= <MathAddExpression> '+' <MathMultExpression>

| <MathAddExpression> '-' <MathMultExpression>

| <MathMultExpression>

<MathMultExpression> ::= <MathMultExpression> '*' <MathNegateExpression>

| <MathMultExpression> '/' <MathNegateExpression>

| <MathNegateExpression>

<MathNegateExpression> ::= '-' <Value>

| <Value>

<CaseExpression> ::= <SimpleCaseExpression>

| <SearchedCaseExpression>

<SimpleCaseExpression> ::= CASE <Value> <SimpleWhenClause> <ElseClause> END

<SearchedCaseExpression> ::= CASE <SearchedWhenClause> <ElseClause> END

<SimpleWhenClause> ::= WHEN <Value> THEN <CaseResult>

| WHEN <Value> THEN <CaseResult> <SimpleWhenClause>

<SearchedWhenClause> ::= WHEN <Expression> THEN <CaseResult>

| WHEN <Expression> THEN <CaseResult> <SearchedWhenClause>

<CaseResult> ::= <MathAddExpression>

<ElseClause> ::= ELSE <CaseResult>

|

<IndexedExpression> ::= Path '[' <Expression> ']' '.' Path

| Path '[' <Expression> ']' '.' Identifier

| Path '[' <Expression> ']'

<StringValueExpression> ::= Identifier

| Path

| StringLiteral

| Parameter

| <IndexedExpression>

| <FunctionExpression>

| <CaseExpression>

<ConcatenationExpression> ::= <StringValueExpression> '||' <ConcatenationExpression>

| <StringValueExpression>

<Value> ::= <ConcatenationExpression>

| IntegerLiteral

| FloatLiteral

| HexLiteral

| NULL

| BooleanLiteral

| <Tuple>

| <AggregateExpression>

| <CollectionExpression>

<Tuple> ::= '(' <SelectStatement> ')'

| '(' <ExpressionList> ')'

<ExpressionList> ::= <Expression> ',' <ExpressionList>

| <Expression>

Query Syntax

Diego Jancic — Wed, 07 Jan 2009 23:57:38 GMT
Revision 2 posted to NHibernate 2.0 by Diego Jancic on 07/01/2009 08:57:38 p.m.

Query Syntax

Below is the HQL full sintax, based on the latest Hibernate version, and which is being implemented in NHibernate. However, some statements or expressions might be not yet valid for NHibernate.

Syntax

<Query> ::= <SelectStatement>

| <DeleteStatement>

| <UpdateStatement>

| <InsertStatement>

<DeleteStatement> ::= DELETE <AliasedEntityName> <WhereClause>

| DELETE FROM <AliasedEntityName> <WhereClause>

<UpdateStatement> ::= UPDATE <AliasedEntityName> SET <AssignList> <WhereClause>

| UPDATE VERSIONED <AliasedEntityName> SET <AssignList> <WhereClause>

| UPDATE FROM <AliasedEntityName> SET <AssignList> <WhereClause>

| UPDATE VERSIONED FROM <AliasedEntityName> SET <AssignList> <WhereClause>

<AssignList> ::= <EntityName> '=' <Expression> ',' <AssignList>

| <EntityName> '=' <Expression>

<InsertStatement> ::= INSERT INTO <EntityName> '(' <EntityNameList> ')' <SelectStatement>

<SelectStatement> ::= <SelectClause> <FromClause>

| <FromClause>

<SelectClause> ::= SELECT <Restriction> <AliasedExpressionList>

| SELECT NEW <EntityName> '(' <ExpressionList> ')'

<FromClause> ::= FROM <AliasedEntityNameList> <JoinClauseChain> <WhereClause> <GroupByClause> <HavingClause> <OrderByClause>

<JoinClauseChain> ::= <JoinClause> <JoinClauseChain>

| <JoinClause> ',' <AliasedEntityNameList> <JoinClauseChain>

|

<JoinClause> ::= <JoinDefinition> <WithClause>

<JoinDefinition> ::= LEFT JOIN <AliasedEntityName>

| RIGHT JOIN <AliasedEntityName>

| LEFT OUTER JOIN <AliasedEntityName>

| RIGHT OUTER JOIN <AliasedEntityName>

| FULL JOIN <AliasedEntityName>

| INNER JOIN <AliasedEntityName>

| LEFT JOIN FETCH <AliasedEntityName>

| LEFT OUTER JOIN FETCH <AliasedEntityName>

| INNER JOIN FETCH <AliasedEntityName>

| JOIN <AliasedEntityName>

| JOIN FETCH <AliasedEntityName>

<WithClause> ::= WITH <Expression>

|

<WhereClause> ::= WHERE <Expression>

|

<GroupByClause> ::= 'GROUP BY' <ExpressionList>

|

<HavingClause> ::= HAVING <Expression>

|

<OrderByClause> ::= 'ORDER BY' <OrderList>

|

<OrderList> ::= <OrderItem> ',' <OrderList>

| <OrderItem>

<OrderItem> ::= <Expression> <OrderType>

<OrderType> ::= ASC

| DESC

| ASCENDING

| DESCENDING

|

<Restriction> ::= ALL

| DISTINCT

|

<AggregateExpression> ::= COUNT '(' '*' ')'

| COUNT '(' <Restriction> <EntityName> ')'

| COUNT '(' <Restriction> <CollectionExpression> ')'

| AVG '(' <MathAddExpression> ')'

| MIN '(' <MathAddExpression> ')'

| MAX '(' <MathAddExpression> ')'

<FunctionExpression> ::= Identifier '(' ')'

| Identifier '(' <ExpressionList> ')'

| CAST '(' <Expression> AS Identifier ')'

| <TrimFunctionExpression>

| <ExtractFunctionExpression>

| YEAR '(' <Expression> ')'

| MONTH '(' <Expression> ')'

| DAY '(' <Expression> ')'

| HOUR '(' <Expression> ')'

| MINUTE '(' <Expression> ')'

| SECOND '(' <Expression> ')'

<TrimFunctionExpression> ::= TRIM '(' <StringValueExpression> ')'

| TRIM '(' <TrimOperands> <StringValueExpression> ')'

<TrimOperands> ::= <StringValueExpression> FROM

| <TrimSpecification> <StringValueExpression> FROM

| <TrimSpecification> FROM

| FROM

<TrimSpecification> ::= LEADING

| TRAILING

| BOTH

<ExtractFunctionExpression> ::= EXTRACT '(' <ExtractField> FROM <Expression> ')'

<ExtractField> ::= YEAR

| MONTH

| DAY

| HOUR

| MINUTE

| SECOND

| 'TIMEZONE_HOUR'

| 'TIMEZONE_MINUTE'

<CollectionExpression> ::= <ElementsExpression>

| INDICES '(' Path ')'

<ElementsExpression> ::= ELEMENTS '(' Path ')'

<EntityName> ::= Identifier

| Path

<EntityNameList> ::= <EntityName> ',' <EntityNameList>

| <EntityName>

<AliasedEntityName> ::= <EntityName> Identifier

| <EntityName> AS Identifier

| Identifier IN CLASS <EntityName>

| Identifier IN <ElementsExpression>

| <EntityName>

<AliasedEntityNameList> ::= <AliasedEntityName> ',' <AliasedEntityNameList>

| <AliasedEntityName>

<AliasedExpression> ::= <Expression> AS Identifier

| <Expression>

<AliasedExpressionList> ::= <AliasedExpression> ',' <AliasedExpressionList>

| <AliasedExpression>

<Expression> ::= <OrExpression>

| <AndExpression>

<OrExpression> ::= <AndExpression> OR <Expression>

<AndExpression> ::= <NotExpression> AND <AndExpression>

| <NotExpression>

<NotExpression> ::= NOT <PredicateExpression>

| <PredicateExpression>

<QuantifiedExpression> ::= SOME Path

| ALL Path

| ANY Path

| SOME <CollectionExpression>

| ALL <CollectionExpression>

| ANY <CollectionExpression>

| SOME '(' <SelectStatement> ')'

| ALL '(' <SelectStatement> ')'

| ANY '(' <SelectStatement> ')'

<PredicateExpression> ::= <MathAddExpression> BETWEEN <MathAddExpression> AND <MathAddExpression>

| <MathAddExpression> NOT BETWEEN <MathAddExpression> AND <MathAddExpression>

| <Value> IS NOT NULL

| <Value> IS NULL

| <Value> IS EMPTY

| <Value> IS NOT EMPTY

| <MathAddExpression> LIKE <ConcatenationExpression> <LikeEscape>

| <MathAddExpression> NOT LIKE <ConcatenationExpression> <LikeEscape>

| <MathAddExpression> IN <Tuple>

| <MathAddExpression> NOT IN <Tuple>

| <MathAddExpression> IN <CollectionExpression>

| <MathAddExpression> NOT IN <CollectionExpression>

| <MemberPredicate>

| <ExistsPredicate>

| <MathAddExpression> '>' <MathAddExpression>

| <MathAddExpression> '<' <MathAddExpression>

| <MathAddExpression> '=' <MathAddExpression>

| <MathAddExpression> '>=' <MathAddExpression>

| <MathAddExpression> '<=' <MathAddExpression>

| <MathAddExpression> NotEqualOperator <MathAddExpression>

| <MathAddExpression> '>' <QuantifiedExpression>

| <MathAddExpression> '<' <QuantifiedExpression>

| <MathAddExpression> '=' <QuantifiedExpression>

| <MathAddExpression> '>=' <QuantifiedExpression>

| <MathAddExpression> '<=' <QuantifiedExpression>

| <MathAddExpression> NotEqualOperator <QuantifiedExpression>

| <MathAddExpression>

<LikeEscape> ::= ESCAPE StringLiteral

|

<ExistsPredicate> ::= EXISTS Path

| EXISTS <CollectionExpression>

| EXISTS '(' <SelectStatement> ')'

<MemberPredicate> ::= Path MEMBER OF Path

| Path MEMBER Path

<MathAddExpression> ::= <MathAddExpression> '+' <MathMultExpression>

| <MathAddExpression> '-' <MathMultExpression>

| <MathMultExpression>

<MathMultExpression> ::= <MathMultExpression> '*' <MathNegateExpression>

| <MathMultExpression> '/' <MathNegateExpression>

| <MathNegateExpression>

<MathNegateExpression> ::= '-' <Value>

| <Value>

<CaseExpression> ::= <SimpleCaseExpression>

| <SearchedCaseExpression>

<SimpleCaseExpression> ::= CASE <Value> <SimpleWhenClause> <ElseClause> END

<SearchedCaseExpression> ::= CASE <SearchedWhenClause> <ElseClause> END

<SimpleWhenClause> ::= WHEN <Value> THEN <CaseResult>

| WHEN <Value> THEN <CaseResult> <SimpleWhenClause>

<SearchedWhenClause> ::= WHEN <Expression> THEN <CaseResult>

| WHEN <Expression> THEN <CaseResult> <SearchedWhenClause>

<CaseResult> ::= <MathAddExpression>

<ElseClause> ::= ELSE <CaseResult>

|

<IndexedExpression> ::= Path '[' <Expression> ']' '.' Path

| Path '[' <Expression> ']' '.' Identifier

| Path '[' <Expression> ']'

<StringValueExpression> ::= Identifier

| Path

| StringLiteral

| Parameter

| <IndexedExpression>

| <FunctionExpression>

| <CaseExpression>

<ConcatenationExpression> ::= <StringValueExpression> '||' <ConcatenationExpression>

| <StringValueExpression>

<Value> ::= <ConcatenationExpression>

| IntegerLiteral

| FloatLiteral

| HexLiteral

| NULL

| BooleanLiteral

| <Tuple>

| <AggregateExpression>

| <CollectionExpression>

<Tuple> ::= '(' <SelectStatement> ')'

| '(' <ExpressionList> ')'

<ExpressionList> ::= <Expression> ',' <ExpressionList>

| <Expression>

Query Syntax

Diego Jancic — Wed, 07 Jan 2009 23:55:34 GMT
Revision 1 posted to NHibernate 2.0 by Diego Jancic on 07/01/2009 08:55:34 p.m.

Below is the HQL full sintax, based on the latest Hibernate version, and which is being implemented in NHibernate. However, some statements or expressions might be not yet valid for NHibernate.

Syntax

<Query> ::= <SelectStatement>

| <DeleteStatement>

| <UpdateStatement>

| <InsertStatement>

<DeleteStatement> ::= DELETE <AliasedEntityName> <WhereClause>

| DELETE FROM <AliasedEntityName> <WhereClause>

<UpdateStatement> ::= UPDATE <AliasedEntityName> SET <AssignList> <WhereClause>

| UPDATE VERSIONED <AliasedEntityName> SET <AssignList> <WhereClause>

| UPDATE FROM <AliasedEntityName> SET <AssignList> <WhereClause>

| UPDATE VERSIONED FROM <AliasedEntityName> SET <AssignList> <WhereClause>

<AssignList> ::= <EntityName> '=' <Expression> ',' <AssignList>

| <EntityName> '=' <Expression>

<InsertStatement> ::= INSERT INTO <EntityName> '(' <EntityNameList> ')' <SelectStatement>

<SelectStatement> ::= <SelectClause> <FromClause>

| <FromClause>

<SelectClause> ::= SELECT <Restriction> <AliasedExpressionList>

| SELECT NEW <EntityName> '(' <ExpressionList> ')'

<FromClause> ::= FROM <AliasedEntityNameList> <JoinClauseChain> <WhereClause> <GroupByClause> <HavingClause> <OrderByClause>

<JoinClauseChain> ::= <JoinClause> <JoinClauseChain>

| <JoinClause> ',' <AliasedEntityNameList> <JoinClauseChain>

|

<JoinClause> ::= <JoinDefinition> <WithClause>

<JoinDefinition> ::= LEFT JOIN <AliasedEntityName>

| RIGHT JOIN <AliasedEntityName>

| LEFT OUTER JOIN <AliasedEntityName>

| RIGHT OUTER JOIN <AliasedEntityName>

| FULL JOIN <AliasedEntityName>

| INNER JOIN <AliasedEntityName>

| LEFT JOIN FETCH <AliasedEntityName>

| LEFT OUTER JOIN FETCH <AliasedEntityName>

| INNER JOIN FETCH <AliasedEntityName>

| JOIN <AliasedEntityName>

| JOIN FETCH <AliasedEntityName>

<WithClause> ::= WITH <Expression>

|

<WhereClause> ::= WHERE <Expression>

|

<GroupByClause> ::= 'GROUP BY' <ExpressionList>

|

<HavingClause> ::= HAVING <Expression>

|

<OrderByClause> ::= 'ORDER BY' <OrderList>

|

<OrderList> ::= <OrderItem> ',' <OrderList>

| <OrderItem>

<OrderItem> ::= <Expression> <OrderType>

<OrderType> ::= ASC

| DESC

| ASCENDING

| DESCENDING

|

<Restriction> ::= ALL

| DISTINCT

|

<AggregateExpression> ::= COUNT '(' '*' ')'

| COUNT '(' <Restriction> <EntityName> ')'

| COUNT '(' <Restriction> <CollectionExpression> ')'

| AVG '(' <MathAddExpression> ')'

| MIN '(' <MathAddExpression> ')'

| MAX '(' <MathAddExpression> ')'

<FunctionExpression> ::= Identifier '(' ')'

| Identifier '(' <ExpressionList> ')'

| CAST '(' <Expression> AS Identifier ')'

| <TrimFunctionExpression>

| <ExtractFunctionExpression>

| YEAR '(' <Expression> ')'

| MONTH '(' <Expression> ')'

| DAY '(' <Expression> ')'

| HOUR '(' <Expression> ')'

| MINUTE '(' <Expression> ')'

| SECOND '(' <Expression> ')'

<TrimFunctionExpression> ::= TRIM '(' <StringValueExpression> ')'

| TRIM '(' <TrimOperands> <StringValueExpression> ')'

<TrimOperands> ::= <StringValueExpression> FROM

| <TrimSpecification> <StringValueExpression> FROM

| <TrimSpecification> FROM

| FROM

<TrimSpecification> ::= LEADING

| TRAILING

| BOTH

<ExtractFunctionExpression> ::= EXTRACT '(' <ExtractField> FROM <Expression> ')'

<ExtractField> ::= YEAR

| MONTH

| DAY

| HOUR

| MINUTE

| SECOND

| 'TIMEZONE_HOUR'

| 'TIMEZONE_MINUTE'

<CollectionExpression> ::= <ElementsExpression>

| INDICES '(' Path ')'

<ElementsExpression> ::= ELEMENTS '(' Path ')'

<EntityName> ::= Identifier

| Path

<EntityNameList> ::= <EntityName> ',' <EntityNameList>

| <EntityName>

<AliasedEntityName> ::= <EntityName> Identifier

| <EntityName> AS Identifier

| Identifier IN CLASS <EntityName>

| Identifier IN <ElementsExpression>

| <EntityName>

<AliasedEntityNameList> ::= <AliasedEntityName> ',' <AliasedEntityNameList>

| <AliasedEntityName>

<AliasedExpression> ::= <Expression> AS Identifier

| <Expression>

<AliasedExpressionList> ::= <AliasedExpression> ',' <AliasedExpressionList>

| <AliasedExpression>

<Expression> ::= <OrExpression>

| <AndExpression>

<OrExpression> ::= <AndExpression> OR <Expression>

<AndExpression> ::= <NotExpression> AND <AndExpression>

| <NotExpression>

<NotExpression> ::= NOT <PredicateExpression>

| <PredicateExpression>

<QuantifiedExpression> ::= SOME Path

| ALL Path

| ANY Path

| SOME <CollectionExpression>

| ALL <CollectionExpression>

| ANY <CollectionExpression>

| SOME '(' <SelectStatement> ')'

| ALL '(' <SelectStatement> ')'

| ANY '(' <SelectStatement> ')'

<PredicateExpression> ::= <MathAddExpression> BETWEEN <MathAddExpression> AND <MathAddExpression>

| <MathAddExpression> NOT BETWEEN <MathAddExpression> AND <MathAddExpression>

| <Value> IS NOT NULL

| <Value> IS NULL

| <Value> IS EMPTY

| <Value> IS NOT EMPTY

| <MathAddExpression> LIKE <ConcatenationExpression> <LikeEscape>

| <MathAddExpression> NOT LIKE <ConcatenationExpression> <LikeEscape>

| <MathAddExpression> IN <Tuple>

| <MathAddExpression> NOT IN <Tuple>

| <MathAddExpression> IN <CollectionExpression>

| <MathAddExpression> NOT IN <CollectionExpression>

| <MemberPredicate>

| <ExistsPredicate>

| <MathAddExpression> '>' <MathAddExpression>

| <MathAddExpression> '<' <MathAddExpression>

| <MathAddExpression> '=' <MathAddExpression>

| <MathAddExpression> '>=' <MathAddExpression>

| <MathAddExpression> '<=' <MathAddExpression>

| <MathAddExpression> NotEqualOperator <MathAddExpression>

| <MathAddExpression> '>' <QuantifiedExpression>

| <MathAddExpression> '<' <QuantifiedExpression>

| <MathAddExpression> '=' <QuantifiedExpression>

| <MathAddExpression> '>=' <QuantifiedExpression>

| <MathAddExpression> '<=' <QuantifiedExpression>

| <MathAddExpression> NotEqualOperator <QuantifiedExpression>

| <MathAddExpression>

<LikeEscape> ::= ESCAPE StringLiteral

|

<ExistsPredicate> ::= EXISTS Path

| EXISTS <CollectionExpression>

| EXISTS '(' <SelectStatement> ')'

<MemberPredicate> ::= Path MEMBER OF Path

| Path MEMBER Path

<MathAddExpression> ::= <MathAddExpression> '+' <MathMultExpression>

| <MathAddExpression> '-' <MathMultExpression>

| <MathMultExpression>

<MathMultExpression> ::= <MathMultExpression> '*' <MathNegateExpression>

| <MathMultExpression> '/' <MathNegateExpression>

| <MathNegateExpression>

<MathNegateExpression> ::= '-' <Value>

| <Value>

<CaseExpression> ::= <SimpleCaseExpression>

| <SearchedCaseExpression>

<SimpleCaseExpression> ::= CASE <Value> <SimpleWhenClause> <ElseClause> END

<SearchedCaseExpression> ::= CASE <SearchedWhenClause> <ElseClause> END

<SimpleWhenClause> ::= WHEN <Value> THEN <CaseResult>

| WHEN <Value> THEN <CaseResult> <SimpleWhenClause>

<SearchedWhenClause> ::= WHEN <Expression> THEN <CaseResult>

| WHEN <Expression> THEN <CaseResult> <SearchedWhenClause>

<CaseResult> ::= <MathAddExpression>

<ElseClause> ::= ELSE <CaseResult>

|

<IndexedExpression> ::= Path '[' <Expression> ']' '.' Path

| Path '[' <Expression> ']' '.' Identifier

| Path '[' <Expression> ']'

<StringValueExpression> ::= Identifier

| Path

| StringLiteral

| Parameter

| <IndexedExpression>

| <FunctionExpression>

| <CaseExpression>

<ConcatenationExpression> ::= <StringValueExpression> '||' <ConcatenationExpression>

| <StringValueExpression>

<Value> ::= <ConcatenationExpression>

| IntegerLiteral

| FloatLiteral

| HexLiteral

| NULL

| BooleanLiteral

| <Tuple>

| <AggregateExpression>

| <CollectionExpression>

<Tuple> ::= '(' <SelectStatement> ')'

| '(' <ExpressionList> ')'

<ExpressionList> ::= <Expression> ',' <ExpressionList>

| <Expression>

NHibernate provided ADO.NET connection

Dario Quintana — Tue, 09 Sep 2008 04:34:22 GMT
Current revision posted to NHibernate 2.0 by Dario Quintana on 09/09/2008 01:34:22 a.m.

NHibernate provided ADO.NET connection

Alternatively, you can have the ISessionFactory open connections for you. The ISessionFactory must be provided with ADO.NET connection properties in one of the following ways:

Pass an instance of IDictionary<string, string> (property name, property value) to Configuration.SetProperties(IDictionary<string, string>).

Include <property> elements in a configuration section in the application configuration file. The section should be named hibernate-configuration and its handler set to NHibernate.Cfg.ConfigurationSectionHandler. The XML namespace of the section should be set to urn:nhibernate-configuration-2.2.

Include <property> elements in hibernate.cfg.xml (discussed later).

If you take this approach, opening an ISession is as simple as:

ISession session = sessions.OpenSession(); // open a new Session
/* do some data access work, an ADO.NET connection will be used on demand */

All NHibernate property names and semantics are defined on the class NHibernate.Cfg.Environment. We will now describe the most important settings for ADO.NET connection configuration.

NHibernate will obtain (and pool) connections using an ADO.NET data provider if you set the following properties:

NHibernate ADO.NET Properties

<tbody> </tbody>
Property name Purpose

connection.provider_class
The type of a custom IConnectionProvider.

eg. full.classname.of.ConnectionProvider if the Provider is built into NHibernate, or full.classname.of.ConnectionProvider, assembly if using an implementation of IConnectionProvider not included in NHibernate.

connection.driver_class
The type of a custom IDriver, if using DriverConnectionProvider.

full.classname.of.Driver if the driver is built into NHibernate, or full.classname.of.Driver, assembly if using an implementation of IDriver not included in NHibernate.

This is usually not needed, most of the time the dialect will take care of setting the IDriver using a sensible default. See the API documentation of the specific dialect for the defaults.

connection.connection_string Connection string to use to obtain the connection.

connection.connection_string_name The name of the connection string (defined in <connectionStrings> configuration file element) to use to obtain the connection.

connection.isolation
Set the ADO.NET transaction isolation level. Check System.Data.IsolationLevel for meaningful values and the database's documentation to ensure that level is supported.

eg. Chaos, ReadCommitted, ReadUncommitted, RepeatableRead, Serializable, Unspecified

connection.release_mode
Specify when NHibernate should release ADO.NET connections. See Connection Release Modes.

eg. auto (default) | on_close |after_transaction

Note that this setting only affects ISessions returned from ISessionFactory.OpenSession. For ISessions obtained through ISessionFactory.GetCurrentSession, the ICurrentSessionContext implementation configured for use controls the connection release mode for those ISessions. See Contextual Sessions.

command_timeout Specify the default timeout of IDbCommands generated by NHibernate.

adonet.batch_size Specify the batch size to use when batching update statements. Setting this to 0 (the default) disables the functionality. See Batch updates.

This is an example of how to specify the database connection properties inside a web.config:

<configuration>
<configSections>
<section name="hibernate-configuration"
type="NHibernate.Cfg.ConfigurationSectionHandler, NHibernate" />
</configSections>

<hibernate-configuration xmlns="urn:nhibernate-configuration-2.2">
<session-factory>
<property name="connection.provider">
NHibernate.Connection.DriverConnectionProvider, NHibernate
</property>
<property name="connection.connection_string">
Server=127.0.0.1; Initial Catalog=thedatabase; Integrated Security=SSPI
</property>
<property name="dialect">NHibernate.Dialect.MsSql2000Dialect</property>
<property name="current_session_context_class">managed_web</property>
</session-factory>
</hibernate-configuration>


</configuration>

NHibernate relies on the ADO.NET data provider implementation of connection pooling.

You may define your own plugin strategy for obtaining ADO.NET connections by implementing the interface NHibernate.Connection.IConnectionProvider. You may select a custom implementation by setting connection.provider_class.

NHibernate provided ADO.NET connection

Dario Quintana — Tue, 09 Sep 2008 04:34:22 GMT
Revision 12 posted to NHibernate 2.0 by Dario Quintana on 09/09/2008 01:34:22 a.m.

NHibernate provided ADO.NET connection

Alternatively, you can have the ISessionFactory open connections for you. The ISessionFactory must be provided with ADO.NET connection properties in one of the following ways:

Pass an instance of IDictionary<string, string> (property name, property value) to Configuration.SetProperties(IDictionary<string, string>).

Include <property> elements in a configuration section in the application configuration file. The section should be named hibernate-configuration and its handler set to NHibernate.Cfg.ConfigurationSectionHandler. The XML namespace of the section should be set to urn:nhibernate-configuration-2.2.

Include <property> elements in hibernate.cfg.xml (discussed later).

If you take this approach, opening an ISession is as simple as:

ISession session = sessions.OpenSession(); // open a new Session
/* do some data access work, an ADO.NET connection will be used on demand */

All NHibernate property names and semantics are defined on the class NHibernate.Cfg.Environment. We will now describe the most important settings for ADO.NET connection configuration.

NHibernate will obtain (and pool) connections using an ADO.NET data provider if you set the following properties:

NHibernate ADO.NET Properties

<tbody> </tbody>
Property name Purpose

connection.provider_class
The type of a custom IConnectionProvider.

eg. full.classname.of.ConnectionProvider if the Provider is built into NHibernate, or full.classname.of.ConnectionProvider, assembly if using an implementation of IConnectionProvider not included in NHibernate.

connection.driver_class
The type of a custom IDriver, if using DriverConnectionProvider.

full.classname.of.Driver if the driver is built into NHibernate, or full.classname.of.Driver, assembly if using an implementation of IDriver not included in NHibernate.

This is usually not needed, most of the time the dialect will take care of setting the IDriver using a sensible default. See the API documentation of the specific dialect for the defaults.

connection.connection_string Connection string to use to obtain the connection.

connection.connection_string_name The name of the connection string (defined in <connectionStrings> configuration file element) to use to obtain the connection.

connection.isolation
Set the ADO.NET transaction isolation level. Check System.Data.IsolationLevel for meaningful values and the database's documentation to ensure that level is supported.

eg. Chaos, ReadCommitted, ReadUncommitted, RepeatableRead, Serializable, Unspecified

connection.release_mode
Specify when NHibernate should release ADO.NET connections. See Connection Release Modes.

eg. auto (default) | on_close |after_transaction

Note that this setting only affects ISessions returned from ISessionFactory.OpenSession. For ISessions obtained through ISessionFactory.GetCurrentSession, the ICurrentSessionContext implementation configured for use controls the connection release mode for those ISessions. See Contextual Sessions.

command_timeout Specify the default timeout of IDbCommands generated by NHibernate.

adonet.batch_size Specify the batch size to use when batching update statements. Setting this to 0 (the default) disables the functionality. See Batch updates.

This is an example of how to specify the database connection properties inside a web.config:

<configuration>
<configSections>
<section name="hibernate-configuration"
type="NHibernate.Cfg.ConfigurationSectionHandler, NHibernate" />
</configSections>

<hibernate-configuration xmlns="urn:nhibernate-configuration-2.2">
<session-factory>
<property name="connection.provider">
NHibernate.Connection.DriverConnectionProvider, NHibernate
</property>
<property name="connection.connection_string">
Server=127.0.0.1; Initial Catalog=thedatabase; Integrated Security=SSPI
</property>
<property name="dialect">NHibernate.Dialect.MsSql2000Dialect</property>
<property name="current_session_context_class">managed_web</property>
</session-factory>
</hibernate-configuration>


</configuration>

NHibernate relies on the ADO.NET data provider implementation of connection pooling.

You may define your own plugin strategy for obtaining ADO.NET connections by implementing the interface NHibernate.Connection.IConnectionProvider. You may select a custom implementation by setting connection.provider_class.

NHibernate provided ADO.NET connection

Dario Quintana — Tue, 09 Sep 2008 04:34:22 GMT
Revision 11 posted to NHibernate 2.0 by Dario Quintana on 09/09/2008 01:34:22 a.m.

NHibernate provided ADO.NET connection

Alternatively, you can have the ISessionFactory open connections for you. The ISessionFactory must be provided with ADO.NET connection properties in one of the following ways:

Pass an instance of IDictionary<string, string> (property name, property value) to Configuration.SetProperties(IDictionary<string, string>).

Include <property> elements in a configuration section in the application configuration file. The section should be named hibernate-configuration and its handler set to NHibernate.Cfg.ConfigurationSectionHandler. The XML namespace of the section should be set to urn:nhibernate-configuration-2.2.

Include <property> elements in hibernate.cfg.xml (discussed later).

If you take this approach, opening an ISession is as simple as:

ISession session = sessions.OpenSession(); // open a new Session
/* do some data access work, an ADO.NET connection will be used on demand */

All NHibernate property names and semantics are defined on the class NHibernate.Cfg.Environment. We will now describe the most important settings for ADO.NET connection configuration.

NHibernate will obtain (and pool) connections using an ADO.NET data provider if you set the following properties:

NHibernate ADO.NET Properties

<tbody> </tbody>
Property name Purpose

connection.provider_class
The type of a custom IConnectionProvider.

eg. full.classname.of.ConnectionProvider if the Provider is built into NHibernate, or full.classname.of.ConnectionProvider, assembly if using an implementation of IConnectionProvider not included in NHibernate.

connection.driver_class
The type of a custom IDriver, if using DriverConnectionProvider.

full.classname.of.Driver if the driver is built into NHibernate, or full.classname.of.Driver, assembly if using an implementation of IDriver not included in NHibernate.

This is usually not needed, most of the time the dialect will take care of setting the IDriver using a sensible default. See the API documentation of the specific dialect for the defaults.

connection.connection_string Connection string to use to obtain the connection.

connection.connection_string_name The name of the connection string (defined in <connectionStrings> configuration file element) to use to obtain the connection.

connection.isolation
Set the ADO.NET transaction isolation level. Check System.Data.IsolationLevel for meaningful values and the database's documentation to ensure that level is supported.

eg. Chaos, ReadCommitted, ReadUncommitted, RepeatableRead, Serializable, Unspecified

connection.release_mode
Specify when NHibernate should release ADO.NET connections. See Connection Release Modes.

eg. auto (default) | on_close |after_transaction

Note that this setting only affects ISessions returned from ISessionFactory.OpenSession. For ISessions obtained through ISessionFactory.GetCurrentSession, the ICurrentSessionContext implementation configured for use controls the connection release mode for those ISessions. See Contextual Sessions.

command_timeout Specify the default timeout of IDbCommands generated by NHibernate.

adonet.batch_size Specify the batch size to use when batching update statements. Setting this to 0 (the default) disables the functionality. See Batch updates.

This is an example of how to specify the database connection properties inside a web.config:

<configuration>
<configSections>
<section name="hibernate-configuration"
type="NHibernate.Cfg.ConfigurationSectionHandler, NHibernate" />
</configSections>

<hibernate-configuration xmlns="urn:nhibernate-configuration-2.2">
<session-factory>
<property name="connection.provider">
NHibernate.Connection.DriverConnectionProvider, NHibernate
</property>
<property name="connection.connection_string">
Server=127.0.0.1; Initial Catalog=thedatabase; Integrated Security=SSPI
</property>
<property name="dialect">NHibernate.Dialect.MsSql2000Dialect</property>
<property name="current_session_context_class">managed_web</property>
</session-factory>
</hibernate-configuration>


</configuration>

NHibernate relies on the ADO.NET data provider implementation of connection pooling.

You may define your own plugin strategy for obtaining ADO.NET connections by implementing the interface NHibernate.Connection.IConnectionProvider. You may select a custom implementation by setting connection.provider_class.

NHibernate provided ADO.NET connection

Dario Quintana — Tue, 09 Sep 2008 04:34:22 GMT
Revision 10 posted to NHibernate 2.0 by Dario Quintana on 09/09/2008 01:34:22 a.m.

NHibernate provided ADO.NET connection

Alternatively, you can have the ISessionFactory open connections for you. The ISessionFactory must be provided with ADO.NET connection properties in one of the following ways:

Pass an instance of IDictionary<string, string> (property name, property value) to Configuration.SetProperties(IDictionary<string, string>).

Include <property> elements in a configuration section in the application configuration file. The section should be named hibernate-configuration and its handler set to NHibernate.Cfg.ConfigurationSectionHandler. The XML namespace of the section should be set to urn:nhibernate-configuration-2.2.

Include <property> elements in hibernate.cfg.xml (discussed later).

If you take this approach, opening an ISession is as simple as:

ISession session = sessions.OpenSession(); // open a new Session
/* do some data access work, an ADO.NET connection will be used on demand */

All NHibernate property names and semantics are defined on the class NHibernate.Cfg.Environment. We will now describe the most important settings for ADO.NET connection configuration.

NHibernate will obtain (and pool) connections using an ADO.NET data provider if you set the following properties:

NHibernate ADO.NET Properties

<tbody> </tbody>
Property name Purpose

connection.provider_class
The type of a custom IConnectionProvider.

eg. full.classname.of.ConnectionProvider if the Provider is built into NHibernate, or full.classname.of.ConnectionProvider, assembly if using an implementation of IConnectionProvider not included in NHibernate.

connection.driver_class
The type of a custom IDriver, if using DriverConnectionProvider.

full.classname.of.Driver if the driver is built into NHibernate, or full.classname.of.Driver, assembly if using an implementation of IDriver not included in NHibernate.

This is usually not needed, most of the time the dialect will take care of setting the IDriver using a sensible default. See the API documentation of the specific dialect for the defaults.

connection.connection_string Connection string to use to obtain the connection.

connection.connection_string_name The name of the connection string (defined in <connectionStrings> configuration file element) to use to obtain the connection.

connection.isolation
Set the ADO.NET transaction isolation level. Check System.Data.IsolationLevel for meaningful values and the database's documentation to ensure that level is supported.

eg. Chaos, ReadCommitted, ReadUncommitted, RepeatableRead, Serializable, Unspecified

connection.release_mode
Specify when NHibernate should release ADO.NET connections. See Connection Release Modes.

eg. auto (default) | on_close |after_transaction

Note that this setting only affects ISessions returned from ISessionFactory.OpenSession. For ISessions obtained through ISessionFactory.GetCurrentSession, the ICurrentSessionContext implementation configured for use controls the connection release mode for those ISessions. See Contextual Sessions.

command_timeout Specify the default timeout of IDbCommands generated by NHibernate.

adonet.batch_size Specify the batch size to use when batching update statements. Setting this to 0 (the default) disables the functionality. See Batch updates.

This is an example of how to specify the database connection properties inside a web.config:

<configuration>
<configSections>
<section name="hibernate-configuration"
type="NHibernate.Cfg.ConfigurationSectionHandler, NHibernate" />
</configSections>

<hibernate-configuration xmlns="urn:nhibernate-configuration-2.2">
<session-factory>
<property name="connection.provider">
NHibernate.Connection.DriverConnectionProvider, NHibernate
</property>
<property name="connection.connection_string">
Server=127.0.0.1; Initial Catalog=thedatabase; Integrated Security=SSPI
</property>
<property name="dialect">NHibernate.Dialect.MsSql2000Dialect</property>
<property name="current_session_context_class">managed_web</property>
</session-factory>
</hibernate-configuration>


</configuration>

NHibernate relies on the ADO.NET data provider implementation of connection pooling.

You may define your own plugin strategy for obtaining ADO.NET connections by implementing the interface NHibernate.Connection.IConnectionProvider. You may select a custom implementation by setting connection.provider_class.

NHibernate provided ADO.NET connection

Dario Quintana — Tue, 09 Sep 2008 04:32:28 GMT
Revision 9 posted to NHibernate 2.0 by Dario Quintana on 09/09/2008 01:32:28 a.m.

NHibernate provided ADO.NET connection

Alternatively, you can have the ISessionFactory open connections for you. The ISessionFactory must be provided with ADO.NET connection properties in one of the following ways:

Pass an instance of IDictionary<string, string> (property name, property value) to Configuration.SetProperties(IDictionary<string, string>).

Include <property> elements in a configuration section in the application configuration file. The section should be named hibernate-configuration and its handler set to NHibernate.Cfg.ConfigurationSectionHandler. The XML namespace of the section should be set to urn:nhibernate-configuration-2.2.

Include <property> elements in hibernate.cfg.xml (discussed later).

If you take this approach, opening an ISession is as simple as:

ISession session = sessions.OpenSession(); // open a new Session
/* do some data access work, an ADO.NET connection will be used on demand */

All NHibernate property names and semantics are defined on the class NHibernate.Cfg.Environment. We will now describe the most important settings for ADO.NET connection configuration.

NHibernate will obtain (and pool) connections using an ADO.NET data provider if you set the following properties:

NHibernate ADO.NET Properties

<tbody> </tbody>
Property name Purpose

connection.provider_class
The type of a custom IConnectionProvider.

eg. full.classname.of.ConnectionProvider if the Provider is built into NHibernate, or full.classname.of.ConnectionProvider, assembly if using an implementation of IConnectionProvider not included in NHibernate.

connection.driver_class
The type of a custom IDriver, if using DriverConnectionProvider.

full.classname.of.Driver if the driver is built into NHibernate, or full.classname.of.Driver, assembly if using an implementation of IDriver not included in NHibernate.

This is usually not needed, most of the time the dialect will take care of setting the IDriver using a sensible default. See the API documentation of the specific dialect for the defaults.

connection.connection_string Connection string to use to obtain the connection.

connection.connection_string_name The name of the connection string (defined in <connectionStrings> configuration file element) to use to obtain the connection.

connection.isolation
Set the ADO.NET transaction isolation level. Check System.Data.IsolationLevel for meaningful values and the database's documentation to ensure that level is supported.

eg. Chaos, ReadCommitted, ReadUncommitted, RepeatableRead, Serializable, Unspecified

connection.release_mode
Specify when NHibernate should release ADO.NET connections. See Connection Release Modes.

eg. auto (default) | on_close |after_transaction

Note that this setting only affects ISessions returned from ISessionFactory.OpenSession. For ISessions obtained through ISessionFactory.GetCurrentSession, the ICurrentSessionContext implementation configured for use controls the connection release mode for those ISessions. See Contextual Sessions.

command_timeout Specify the default timeout of IDbCommands generated by NHibernate.

adonet.batch_size Specify the batch size to use when batching update statements. Setting this to 0 (the default) disables the functionality. See Batch updates.

This is an example of how to specify the database connection properties inside a web.config:

<configuration>
<configSections>
<section name="hibernate-configuration"
type="NHibernate.Cfg.ConfigurationSectionHandler, NHibernate" />
</configSections>

<hibernate-configuration xmlns="urn:nhibernate-configuration-2.2">
<session-factory>
<property name="connection.provider">
NHibernate.Connection.DriverConnectionProvider, NHibernate
</property>
<property name="connection.connection_string">
Server=127.0.0.1; Initial Catalog=thedatabase; Integrated Security=SSPI
</property>
<property name="dialect">NHibernate.Dialect.MsSql2000Dialect</property>
<property name="current_session_context_class">managed_web</property>
</session-factory>
</hibernate-configuration>


</configuration>

NHibernate relies on the ADO.NET data provider implementation of connection pooling.

You may define your own plugin strategy for obtaining ADO.NET connections by implementing the interface NHibernate.Connection.IConnectionProvider. You may select a custom implementation by setting connection.provider_class.

NHibernate provided ADO.NET connection

Fabio Maulo — Sat, 06 Sep 2008 19:16:05 GMT
Revision 8 posted to NHibernate 2.0 by Fabio Maulo on 06/09/2008 04:16:05 p.m.

NHibernate provided ADO.NET connection

Alternatively, you can have the ISessionFactory open connections for you. The ISessionFactory must be provided with ADO.NET connection properties in one of the following ways:

Pass an instance of IDictionary<string, string> (property name, property value) to Configuration.SetProperties(IDictionary<string, string>).

Include <property> elements in a configuration section in the application configuration file. The section should be named hibernate-configuration and its handler set to NHibernate.Cfg.ConfigurationSectionHandler. The XML namespace of the section should be set to urn:nhibernate-configuration-2.2.

Include <property> elements in hibernate.cfg.xml (discussed later).

If you take this approach, opening an ISession is as simple as:

ISession session = sessions.OpenSession(); // open a new Session /* do some data access work, an ADO.NET connection will be used on demand */

All NHibernate property names and semantics are defined on the class NHibernate.Cfg.Environment. We will now describe the most important settings for ADO.NET connection configuration.

NHibernate will obtain (and pool) connections using an ADO.NET data provider if you set the following properties:

NHibernate ADO.NET Properties

<tbody> </tbody>
Property name Purpose

connection.provider_class
The type of a custom IConnectionProvider.

eg. full.classname.of.ConnectionProvider if the Provider is built into NHibernate, or full.classname.of.ConnectionProvider, assembly if using an implementation of IConnectionProvider not included in NHibernate.

connection.driver_class
The type of a custom IDriver, if using DriverConnectionProvider.

full.classname.of.Driver if the driver is built into NHibernate, or full.classname.of.Driver, assembly if using an implementation of IDriver not included in NHibernate.

This is usually not needed, most of the time the dialect will take care of setting the IDriver using a sensible default. See the API documentation of the specific dialect for the defaults.

connection.connection_string Connection string to use to obtain the connection.

connection.connection_string_name The name of the connection string (defined in <connectionStrings> configuration file element) to use to obtain the connection.

connection.isolation
Set the ADO.NET transaction isolation level. Check System.Data.IsolationLevel for meaningful values and the database's documentation to ensure that level is supported.

eg. Chaos, ReadCommitted, ReadUncommitted, RepeatableRead, Serializable, Unspecified

connection.release_mode
Specify when NHibernate should release ADO.NET connections. See Connection Release Modes.

eg. auto (default) | on_close |after_transaction

Note that this setting only affects ISessions returned from ISessionFactory.OpenSession. For ISessions obtained through ISessionFactory.GetCurrentSession, the ICurrentSessionContext implementation configured for use controls the connection release mode for those ISessions. See Contextual Sessions.

command_timeout Specify the default timeout of IDbCommands generated by NHibernate.

adonet.batch_size Specify the batch size to use when batching update statements. Setting this to 0 (the default) disables the functionality. See Batch updates.

This is an example of how to specify the database connection properties inside a web.config:

<configuration> <configSections> <section name="hibernate-configuration" type="NHibernate.Cfg.ConfigurationSectionHandler, NHibernate" /> </configSections> <hibernate-configuration xmlns="urn:nhibernate-configuration-2.2"> <session-factory> <property name="connection.provider"> NHibernate.Connection.DriverConnectionProvider, NHibernate </property> <property name="connection.connection_string"> Server=127.0.0.1; Initial Catalog=thedatabase; Integrated Security=SSPI </property> <property name="dialect">NHibernate.Dialect.MsSql2000Dialect</property> <property name="current_session_context_class">managed_web</property> </session-factory> </hibernate-configuration>  </configuration>

NHibernate relies on the ADO.NET data provider implementation of connection pooling.

You may define your own plugin strategy for obtaining ADO.NET connections by implementing the interface NHibernate.Connection.IConnectionProvider. You may select a custom implementation by setting connection.provider_class.

NHibernate provided ADO.NET connection

Fabio Maulo — Sat, 06 Sep 2008 19:14:36 GMT
Revision 7 posted to NHibernate 2.0 by Fabio Maulo on 06/09/2008 04:14:36 p.m.

NHibernate provided ADO.NET connection

Alternatively, you can have the ISessionFactory open connections for you. The ISessionFactory must be provided with ADO.NET connection properties in one of the following ways:

Pass an instance of IDictionary<string, string> (property name, property value) to Configuration.SetProperties(IDictionary<string, string>).

Include <property> elements in a configuration section in the application configuration file. The section should be named hibernate-configuration and its handler set to NHibernate.Cfg.ConfigurationSectionHandler. The XML namespace of the section should be set to urn:nhibernate-configuration-2.2.

Include <property> elements in hibernate.cfg.xml (discussed later).

If you take this approach, opening an ISession is as simple as:

ISession session = sessions.OpenSession(); // open a new Session /* do some data access work, an ADO.NET connection will be used on demand */

All NHibernate property names and semantics are defined on the class NHibernate.Cfg.Environment. We will now describe the most important settings for ADO.NET connection configuration.

NHibernate will obtain (and pool) connections using an ADO.NET data provider if you set the following properties:

NHibernate ADO.NET Properties

<tbody> </tbody>
Property name Purpose

connection.provider_class
The type of a custom IConnectionProvider.

eg. full.classname.of.ConnectionProvider if the Provider is built into NHibernate, or full.classname.of.ConnectionProvider, assembly if using an implementation of IConnectionProvider not included in NHibernate.

connection.driver_class
The type of a custom IDriver, if using DriverConnectionProvider.

full.classname.of.Driver if the driver is built into NHibernate, or full.classname.of.Driver, assembly if using an implementation of IDriver not included in NHibernate.

This is usually not needed, most of the time the dialect will take care of setting the IDriver using a sensible default. See the API documentation of the specific dialect for the defaults.

connection.connection_string Connection string to use to obtain the connection.

connection.connection_string_name The name of the connection string (defined in <connectionStrings> configuration file element) to use to obtain the connection.

connection.isolation
Set the ADO.NET transaction isolation level. Check System.Data.IsolationLevel for meaningful values and the database's documentation to ensure that level is supported.

eg. Chaos, ReadCommitted, ReadUncommitted, RepeatableRead, Serializable, Unspecified

connection.release_mode
Specify when NHibernate should release ADO.NET connections. See Connection Release Modes.

eg. auto (default) | on_close |after_transaction

Note that this setting only affects ISessions returned from ISessionFactory.OpenSession. For ISessions obtained through ISessionFactory.GetCurrentSession, the ICurrentSessionContext implementation configured for use controls the connection release mode for those ISessions. See Contextual Sessions.

command_timeout Specify the default timeout of IDbCommands generated by NHibernate.

adonet.batch_size Specify the batch size to use when batching update statements. Setting this to 0 (the default) disables the functionality. See Batch updates.

This is an example of how to specify the database connection properties inside a web.config:

<configuration> <configSections> <section name="hibernate-configuration" type="NHibernate.Cfg.ConfigurationSectionHandler, NHibernate" /> </configSections> <hibernate-configuration xmlns="urn:nhibernate-configuration-2.2"> <session-factory> <property name="connection.provider"> NHibernate.Connection.DriverConnectionProvider, NHibernate </property> <property name="connection.connection_string"> Server=127.0.0.1; Initial Catalog=thedatabase; Integrated Security=SSPI </property> <property name="dialect">NHibernate.Dialect.MsSql2000Dialect</property> <property name="current_session_context_class">managed_web</property> </session-factory> </hibernate-configuration>  </configuration>

NHibernate relies on the ADO.NET data provider implementation of connection pooling.

You may define your own plugin strategy for obtaining ADO.NET connections by implementing the interface NHibernate.Connection.IConnectionProvider. You may select a custom implementation by setting connection.provider_class.

NHibernate provided ADO.NET connection

Fabio Maulo — Sat, 06 Sep 2008 19:14:03 GMT
Revision 6 posted to NHibernate 2.0 by Fabio Maulo on 06/09/2008 04:14:03 p.m.

NHibernate provided ADO.NET connection

Alternatively, you can have the ISessionFactory open connections for you. The ISessionFactory must be provided with ADO.NET connection properties in one of the following ways:

Pass an instance of IDictionary<string, string> (property name, property value) to Configuration.SetProperties(IDictionary<string, string>).

Include <property> elements in a configuration section in the application configuration file. The section should be named hibernate-configuration and its handler set to NHibernate.Cfg.ConfigurationSectionHandler. The XML namespace of the section should be set to urn:nhibernate-configuration-2.2.

Include <property> elements in hibernate.cfg.xml (discussed later).

If you take this approach, opening an ISession is as simple as:

ISession session = sessions.OpenSession(); // open a new Session /* do some data access work, an ADO.NET connection will be used on demand */

All NHibernate property names and semantics are defined on the class NHibernate.Cfg.Environment. We will now describe the most important settings for ADO.NET connection configuration.

NHibernate will obtain (and pool) connections using an ADO.NET data provider if you set the following properties:

NHibernate ADO.NET Properties

<tbody> </tbody>
Property name Purpose

connection.provider_class
The type of a custom IConnectionProvider.

eg. full.classname.of.ConnectionProvider if the Provider is built into NHibernate, or full.classname.of.ConnectionProvider, assembly if using an implementation of IConnectionProvider not included in NHibernate.

connection.driver_class
The type of a custom IDriver, if using DriverConnectionProvider.

full.classname.of.Driver if the driver is built into NHibernate, or full.classname.of.Driver, assembly if using an implementation of IDriver not included in NHibernate.

This is usually not needed, most of the time the dialect will take care of setting the IDriver using a sensible default. See the API documentation of the specific dialect for the defaults.

connection.connection_string Connection string to use to obtain the connection.

connection.connection_string_name The name of the connection string (defined in <connectionStrings> configuration file element) to use to obtain the connection.

connection.isolation
Set the ADO.NET transaction isolation level. Check System.Data.IsolationLevel for meaningful values and the database's documentation to ensure that level is supported.

eg. Chaos, ReadCommitted, ReadUncommitted, RepeatableRead, Serializable, Unspecified

connection.release_mode
Specify when NHibernate should release ADO.NET connections. See Connection Release Modes.

eg. auto (default) | on_close |after_transaction

Note that this setting only affects ISessions returned from ISessionFactory.OpenSession. For ISessions obtained through ISessionFactory.GetCurrentSession, the ICurrentSessionContext implementation configured for use controls the connection release mode for those ISessions. See Contextual Sessions.

command_timeout Specify the default timeout of IDbCommands generated by NHibernate.

adonet.batch_size Specify the batch size to use when batching update statements. Setting this to 0 (the default) disables the functionality. See Batch updates.

This is an example of how to specify the database connection properties inside a web.config:

<configuration> <configSections> <section name="hibernate-configuration" type="NHibernate.Cfg.ConfigurationSectionHandler, NHibernate" /> </configSections> <hibernate-configuration xmlns="urn:nhibernate-configuration-2.2"> <session-factory> <property name="connection.provider"> NHibernate.Connection.DriverConnectionProvider, NHibernate </property> <property name="connection.connection_string"> Server=127.0.0.1; Initial Catalog=thedatabase; Integrated Security=SSPI </property> <property name="dialect">NHibernate.Dialect.MsSql2000Dialect</property> <property name="current_session_context_class">managed_web</property> </session-factory> </hibernate-configuration>  </configuration>

NHibernate relies on the ADO.NET data provider implementation of connection pooling.

You may define your own plugin strategy for obtaining ADO.NET connections by implementing the interface NHibernate.Connection.IConnectionProvider. You may select a custom implementation by setting connection.provider_class.

NHibernate provided ADO.NET connection

Fabio Maulo — Sat, 06 Sep 2008 19:13:28 GMT
Revision 5 posted to NHibernate 2.0 by Fabio Maulo on 06/09/2008 04:13:28 p.m.

NHibernate provided ADO.NET connection

Alternatively, you can have the ISessionFactory open connections for you. The ISessionFactory must be provided with ADO.NET connection properties in one of the following ways:

Pass an instance of IDictionary<string, string> (property name, property value) to Configuration.SetProperties(IDictionary<string, string>).

Include <property> elements in a configuration section in the application configuration file. The section should be named hibernate-configuration and its handler set to NHibernate.Cfg.ConfigurationSectionHandler. The XML namespace of the section should be set to urn:nhibernate-configuration-2.2.

Include <property> elements in hibernate.cfg.xml (discussed later).

If you take this approach, opening an ISession is as simple as:

ISession session = sessions.OpenSession(); // open a new Session /* do some data access work, an ADO.NET connection will be used on demand */

All NHibernate property names and semantics are defined on the class NHibernate.Cfg.Environment. We will now describe the most important settings for ADO.NET connection configuration.

NHibernate will obtain (and pool) connections using an ADO.NET data provider if you set the following properties:

NHibernate ADO.NET Properties

<tbody> </tbody>
Property name Purpose

connection.provider_class
The type of a custom IConnectionProvider.

eg. full.classname.of.ConnectionProvider if the Provider is built into NHibernate, or full.classname.of.ConnectionProvider, assembly if using an implementation of IConnectionProvider not included in NHibernate.

connection.driver_class
The type of a custom IDriver, if using DriverConnectionProvider.

full.classname.of.Driver if the driver is built into NHibernate, or full.classname.of.Driver, assembly if using an implementation of IDriver not included in NHibernate.

This is usually not needed, most of the time the dialect will take care of setting the IDriver using a sensible default. See the API documentation of the specific dialect for the defaults.

connection.connection_string Connection string to use to obtain the connection.

connection.connection_string_name The name of the connection string (defined in <connectionStrings> configuration file element) to use to obtain the connection.

connection.isolation
Set the ADO.NET transaction isolation level. Check System.Data.IsolationLevel for meaningful values and the database's documentation to ensure that level is supported.

eg. Chaos, ReadCommitted, ReadUncommitted, RepeatableRead, Serializable, Unspecified

connection.release_mode
Specify when NHibernate should release ADO.NET connections. See Connection Release Modes.

eg. auto (default) | on_close |after_transaction

Note that this setting only affects ISessions returned from ISessionFactory.OpenSession. For ISessions obtained through ISessionFactory.GetCurrentSession, the ICurrentSessionContext implementation configured for use controls the connection release mode for those ISessions. See Contextual Sessions.

command_timeout Specify the default timeout of IDbCommands generated by NHibernate.

adonet.batch_size Specify the batch size to use when batching update statements. Setting this to 0 (the default) disables the functionality. See Batch updates.

This is an example of how to specify the database connection properties inside a web.config:

<configuration> <configSections> <section name="hibernate-configuration" type="NHibernate.Cfg.ConfigurationSectionHandler, NHibernate" /> </configSections> <hibernate-configuration xmlns="urn:nhibernate-configuration-2.2"> <session-factory> <property name="connection.provider"> NHibernate.Connection.DriverConnectionProvider, NHibernate </property> <property name="connection.connection_string"> Server=127.0.0.1; Initial Catalog=thedatabase; Integrated Security=SSPI </property> <property name="dialect">NHibernate.Dialect.MsSql2000Dialect</property> <property name="current_session_context_class">managed_web</property> </session-factory> </hibernate-configuration>  </configuration>

NHibernate relies on the ADO.NET data provider implementation of connection pooling.

You may define your own plugin strategy for obtaining ADO.NET connections by implementing the interface NHibernate.Connection.IConnectionProvider. You may select a custom implementation by setting connection.provider_class.

NHibernate provided ADO.NET connection

Fabio Maulo — Sat, 06 Sep 2008 19:10:05 GMT
Revision 4 posted to NHibernate 2.0 by Fabio Maulo on 06/09/2008 04:10:05 p.m.

NHibernate provided ADO.NET connection

Alternatively, you can have the ISessionFactory open connections for you. The ISessionFactory must be provided with ADO.NET connection properties in one of the following ways:

Pass an instance of IDictionary<string, string> (property name, property value) to Configuration.SetProperties(IDictionary<string, string>).

Include <property> elements in a configuration section in the application configuration file. The section should be named hibernate-configuration and its handler set to NHibernate.Cfg.ConfigurationSectionHandler. The XML namespace of the section should be set to urn:nhibernate-configuration-2.2.

Include <property> elements in hibernate.cfg.xml (discussed later).

If you take this approach, opening an ISession is as simple as:

ISession session = sessions.OpenSession(); // open a new Session /* do some data access work, an ADO.NET connection will be used on demand */

All NHibernate property names and semantics are defined on the class NHibernate.Cfg.Environment. We will now describe the most important settings for ADO.NET connection configuration.

NHibernate will obtain (and pool) connections using an ADO.NET data provider if you set the following properties:

NHibernate ADO.NET Properties

<tbody> </tbody>
Property name Purpose

connection.provider_class
The type of a custom <tt>IConnectionProvider</tt>. .

eg. <tt>full.classname.of.ConnectionProvider</tt> if the Provider is built into NHibernate, or <tt>full.classname.of.ConnectionProvider, assembly</tt> if using an implementation of<tt> IConnectionProvider</tt> not included in NHibernate.

connection.driver_class
The type of a custom <tt>IDriver</tt>, , if using<tt> DriverConnectionProvider</tt>.

<tt>.

full.classname.of.Driver</tt> if the driver is built into NHibernate, or <tt>full.classname.of.Driver, assembly</tt> if using an implementation of IDriver not included in NHibernate.

This is usually not needed, most of the time the<tt> dialect</tt> will take care of setting the <tt>IDriver</tt> using a sensible default. See the API documentation of the specific dialect for the defaults.

connection.connection_string Connection string to use to obtain the connection.

connection.connection_string_name The name of the connection string (defined in<tt> <connectionStrings> </tt>configuration > configuration file element) to use to obtain the connection.

connection.isolation
Set the ADO.NET transaction isolation level. Check <tt>System.Data.System.Data.IsolationLevel</tt> for meaningful values and the database's documentation to ensure that level is supported.

eg. <tt>Chaos, Chaos, ReadCommitted, ReadUncommitted, RepeatableRead, Serializable, Unspecified</tt>

connection.release_mode
Specify when NHibernate should release ADO.NET connections. See Connection Release Modes.

eg. <tt>auto</tt> auto (default) default) | <tt>on_close</tt> on_close |<tt>after_transaction</tt> after_transaction

Note that this setting only affects <tt>ISession</tt>s ISessions returned from<tt> ISessionFactory.OpenSession</tt>. OpenSession. For<tt>ISession</tt>s ISessions obtained through <tt>ISessionFactory.GetCurrentSession</tt>, GetCurrentSession, the<tt> ICurrentSessionContext</tt> implementation configured for use controls the connection release mode for those<tt> ISession</tt>s. s. See Contextual Sessions.

command_timeout Specify the default timeout of <tt>IDbCommands </tt> generated by NHibernate.

adonet.batch_size Specify the batch size to use when batching update statements. Setting this to 0 (the default) disables the functionality. See Batch updates.

This is an example of how to specify the database connection properties inside a web.config:

<configuration> <configSections> <section name="hibernate-configuration" type="NHibernate.Cfg.ConfigurationSectionHandler, NHibernate" /> </configSections> <hibernate-configuration xmlns="urn:nhibernate-configuration-2.2"> <session-factory> <property name="connection.provider"> NHibernate.Connection.DriverConnectionProvider, NHibernate </property> <property name="connection.connection_string"> Server=127.0.0.1; Initial Catalog=thedatabase; Integrated Security=SSPI </property> <property name="dialect">NHibernate.Dialect.MsSql2000Dialect</property> <property name="current_session_context_class">managed_web</property> </session-factory> </hibernate-configuration>  </configuration>

NHibernate relies on the ADO.NET data provider implementation of connection pooling.

You may define your own plugin strategy for obtaining ADO.NET connections by implementing the interface NHibernate.Connection.IConnectionProvider. You may select a custom implementation by setting connection.provider_class.

NHibernate provided ADO.NET connection

Fabio Maulo — Sat, 06 Sep 2008 18:46:31 GMT
Revision 3 posted to NHibernate 2.0 by Fabio Maulo on 06/09/2008 03:46:31 p.m.

NHibernate provided ADO.NET connection

Alternatively, you can have the ISessionFactory open connections for you. The ISessionFactory must be provided with ADO.NET connection properties in one of the following ways:

Pass an instance of IDictionary<string, string> (property name, property value) to Configuration.SetProperties(IDictionary<string, string>).

Include <property> elements in a configuration section in the application configuration file. The section should be named hibernate-configuration and its handler set to NHibernate.Cfg.ConfigurationSectionHandler. The XML namespace of the section should be set to urn:nhibernate-configuration-2.2.

Include <property> elements in hibernate.cfg.xml (discussed later).

If you take this approach, opening an ISession is as simple as:

ISession session = sessions.OpenSession(); // open a new Session /* do some data access work, an ADO.NET connection will be used on demand */

All NHibernate property names and semantics are defined on the class NHibernate.Cfg.Environment. We will now describe the most important settings for ADO.NET connection configuration.

NHibernate will obtain (and pool) connections using an ADO.NET data provider if you set the following properties:

NHibernate ADO.NET Properties
<tbody></tbody>

Property name Purpose

connection.provider_class
The type of a custom <tt>IConnectionProvider</tt>.

eg. <tt>full.classname.of.ConnectionProvider</tt> if the Provider is built into NHibernate, or <tt>full.classname.of.ConnectionProvider, assembly</tt> if using an implementation of <tt>IConnectionProvider</tt> not included in NHibernate.

connection.driver_class
The type of a custom <tt>IDriver</tt>, if using <tt>DriverConnectionProvider</tt>.

<tt>full.classname.of.Driver</tt> if the driver is built into NHibernate, or <tt>full.classname.of.Driver, assembly</tt> if using an implementation of IDriver not included in NHibernate.

This is usually not needed, most of the time the <tt>dialect</tt> will take care of setting the <tt>IDriver</tt> using a sensible default. See the API documentation of the specific dialect for the defaults.

connection.connection_string Connection string to use to obtain the connection.

connection.connection_string_name The name of the connection string (defined in <tt><connectionStrings> </tt>configuration file element) to use to obtain the connection.

connection.isolation
Set the ADO.NET transaction isolation level. Check <tt>System.Data.IsolationLevel</tt> for meaningful values and the database's documentation to ensure that level is supported.

eg. <tt>Chaos, ReadCommitted, ReadUncommitted, RepeatableRead, Serializable, Unspecified</tt>

connection.release_mode
Specify when NHibernate should release ADO.NET connections. See Connection Release Modes.

eg. <tt>auto</tt> (default) | <tt>on_close</tt> | <tt>after_transaction</tt>

Note that this setting only affects <tt>ISession</tt>s returned from <tt>ISessionFactory.OpenSession</tt>. For <tt>ISession</tt>s obtained through <tt>ISessionFactory.GetCurrentSession</tt>, the <tt>ICurrentSessionContext</tt> implementation configured for use controls the connection release mode for those <tt>ISession</tt>s. See Contextual Sessions.

command_timeout Specify the default timeout of <tt>IDbCommands</tt> generated by NHibernate.

adonet.batch_size Specify the batch size to use when batching update statements. Setting this to 0 (the default) disables the functionality. See Batch updates.

NHibernate provided ADO.NET connection

Fabio Maulo — Sat, 06 Sep 2008 18:16:06 GMT
Revision 2 posted to NHibernate 2.0 by Fabio Maulo on 06/09/2008 03:16:06 p.m.

NHibernate provided ADO.NET connection

Alternatively, you can have the ISessionFactory open connections for you. The ISessionFactory must be provided with ADO.NET connection properties in one of the following ways:

Pass an instance of IDictionary<string, string> (property name, property value) to Configuration.SetProperties(IDictionary<string, string>).

Include <property> elements in a configuration section in the application configuration file. The section should be named hibernate-configuration and its handler set to NHibernate.Cfg.ConfigurationSectionHandler. The XML namespace of the section should be set to urn:nhibernate-configuration-2.2.

Include <property> elements in hibernate.cfg.xml (discussed later).

If you take this approach, opening an ISession is as simple as:

ISession session = sessions.OpenSession(); // open a new Session /* do some data access work, an ADO.NET connection will be used on demand */

All NHibernate property names and semantics are defined on the class NHibernate.Cfg.Environment. We will now describe the most important settings for ADO.NET connection configuration.

NHibernate will obtain (and pool) connections using an ADO.NET data provider if you set the following properties:

NHibernate ADO.NET Properties

NHibernate provided ADO.NET connection

Fabio Maulo — Sat, 06 Sep 2008 18:14:22 GMT
Revision 1 posted to NHibernate 2.0 by Fabio Maulo on 06/09/2008 03:14:22 p.m.

Alternatively, you can have the ISessionFactory open connections for you. The ISessionFactory must be provided with ADO.NET connection properties in one of the following ways:

Pass an instance of IDictionary<string, string> (property name, property value) to Configuration.SetProperties(IDictionary<string, string>).

Include <property> elements in a configuration section in the application configuration file. The section should be named hibernate-configuration and its handler set to NHibernate.Cfg.ConfigurationSectionHandler. The XML namespace of the section should be set to urn:nhibernate-configuration-2.2.

Include <property> elements in hibernate.cfg.xml (discussed later).

If you take this approach, opening an ISession is as simple as:

ISession session = sessions.OpenSession(); // open a new Session /* do some data access work, an ADO.NET connection will be used on demand */

All NHibernate property names and semantics are defined on the class NHibernate.Cfg.Environment. We will now describe the most important settings for ADO.NET connection configuration.

NHibernate will obtain (and pool) connections using an ADO.NET data provider if you set the following properties:

NHibernate ADO.NET Properties

Obtaining an ISessionFactory

Fabio Maulo — Sat, 06 Sep 2008 05:46:05 GMT
Current revision posted to NHibernate 2.0 by Fabio Maulo on 06/09/2008 02:46:05 a.m.

Obtaining an ISessionFactory

When all mappings have been parsed by the Configuration, the application must obtain a factory for ISession instances. This factory is intended to be shared by all application threads:

ISessionFactory sessions = cfg.BuildSessionFactory();

However, NHibernate does allow your application to instantiate more than one ISessionFactory.

This is useful if you are using more than one database.

Obtaining an ISessionFactory

Fabio Maulo — Sat, 06 Sep 2008 05:24:37 GMT
Revision 2 posted to NHibernate 2.0 by Fabio Maulo on 06/09/2008 02:24:37 a.m.

Obtaining an ISessionFactory

When all mappings have been parsed by the <tt>Configuration</tt>, Configuration, the application must obtain a factory for <tt>ISession</tt> ISession instances. This factory is intended to be shared by all application threads:

ISessionFactory sessions = cfg.BuildSessionFactory();

However, NHibernate does allow your application to instantiate more than one <tt>ISessionFactory</tt>.ISessionFactory.

This is useful if you are using more than one database.

Obtaining an ISessionFactory

Fabio Maulo — Sat, 06 Sep 2008 05:16:11 GMT
Revision 1 posted to NHibernate 2.0 by Fabio Maulo on 06/09/2008 02:16:11 a.m.

When all mappings have been parsed by the <tt>Configuration</tt>, the application must obtain a factory for <tt>ISession</tt> instances. This factory is intended to be shared by all application threads:

ISessionFactory sessions = cfg.BuildSessionFactory();

However, NHibernate does allow your application to instantiate more than one <tt>ISessionFactory</tt>.

This is useful if you are using more than one database.

ISessionFactory Configuration

Fabio Maulo — Sat, 06 Sep 2008 05:44:44 GMT
Current revision posted to NHibernate 2.0 by Fabio Maulo on 06/09/2008 02:44:44 a.m.

ISessionFactory Configuration

Because NHibernate is designed to operate in many different environments, there are a large number of configuration parameters. Fortunately, most have sensible default values and NHibernate is distributed with an example <tt>App.config</tt> App.config file (found in src\NHibernate.Test) and various templates for supported RDBMS (found in src\NHibernate.Config.Templates). You usually only have to put that file in your project and customize it.

ISessionFactory Configuration

Fabio Maulo — Fri, 05 Sep 2008 23:54:32 GMT
Revision 1 posted to NHibernate 2.0 by Fabio Maulo on 05/09/2008 08:54:32 p.m.

Because NHibernate is designed to operate in many different environments, there are a large number of configuration parameters. Fortunately, most have sensible default values and NHibernate is distributed with an example <tt>App.config</tt> file (found in src\NHibernate.Test) and various templates for supported RDBMS (found in src\NHibernate.Config.Templates). You usually only have to put that file in your project and customize it.

Programmatic Configuration

Fabio Maulo — Sat, 06 Sep 2008 05:43:44 GMT
Current revision posted to NHibernate 2.0 by Fabio Maulo on 06/09/2008 02:43:44 a.m.

Programmatic Configuration

An instance of NHibernate.Cfg.Configuration represents an entire set of mappings of an application's .NET types to a SQL database. The <tt>Configuration</tt> Configuration is used to build an (immutable) <tt>ISessionFactory</tt>. ISessionFactory. The mappings are compiled from various XML mapping files.

You may obtain a <tt>Configuration</tt> Configuration instance by instantiating it directly. Heres an example of setting up a datastore from mappings defined in two XML configuration files:

Configuration cfg = new Configuration() .AddFile("Item.hbm.xml") .AddFile("Bid.hbm.xml");

An alternative (sometimes better) way is to let NHibernate load a mapping file from an embedded resource:

Configuration cfg = new Configuration() .AddClass(typeof(NHibernate.Auction.Item)) .AddClass(typeof(NHibernate.Auction.Bid));

Then NHibernate will look for mapping files named <tt>NHibernate.Auction.Item.hbm.xml</tt> NHibernate.Auction.Item.hbm.xml and <tt>NHibernate.Auction.Bid.hbm.xml</tt> embedded NHibernate.Auction.Bid.hbm.xml as embedded resources in the assembly that the types are contained in. This approach eliminates any hardcoded filenames.

Another alternative (probably the best) way is to let NHibernate load all of the mapping files contained in an Assembly:

Configuration cfg = new Configuration() .AddAssembly( "NHibernate.Auction" );

Then NHibernate will look through the assembly for any resources that end with <tt>.hbm.xml</tt>. .hbm.xml. This approach eliminates any hardcoded filenames and ensures the mapping files in the assembly get added.

If a tool like Visual Studio .NET or NAnt is used to build the assembly, then make sure that the <tt>.hbm.xml</tt> .hbm.xml files are compiled into the assembly as <tt>Embedded Embedded Resources</tt>. .

A <tt>Configuration</tt> Configuration also specifies various optional properties:

IDictionary<string, string> props = new Dictionary<string, string>(); ... Configuration cfg = new Configuration() .AddClass(typeof(NHibernate.Auction.Item)) .AddClass(typeof(NHibernate.Auction.Bind)) .SetProperties(props);

A <tt>Configuration</tt> Configuration is intended as a configuration-time object, to be discarded once an <tt>ISessionFactory</tt> ISessionFactory is built.

Programmatic Configuration

Fabio Maulo — Sat, 06 Sep 2008 05:31:24 GMT
Revision 2 posted to NHibernate 2.0 by Fabio Maulo on 06/09/2008 02:31:24 a.m.

Programmatic Configuration

An instance of <tt>NHibernate.Cfg.Configuration</tt> NHibernate.Cfg.Configuration represents an entire set of mappings of an application's .NET types to a SQL database. The <tt>Configuration</tt> is used to build an (immutable) <tt>ISessionFactory</tt>. The mappings are compiled from various XML mapping files.

You may obtain a <tt>Configuration</tt> instance by instantiating it directly. Heres an example of setting up a datastore from mappings defined in two XML configuration files:

Configuration cfg = new Configuration() .AddFile("Item.hbm.xml") .AddFile("Bid.hbm.xml");

An alternative (sometimes better) way is to let NHibernate load a mapping file from an embedded resource:

Configuration cfg = new Configuration() .AddClass(typeof(NHibernate.Auction.Item)) .AddClass(typeof(NHibernate.Auction.Bid));

Then NHibernate will look for mapping files named <tt>NHibernate.Auction.Item.hbm.xml</tt> and <tt>NHibernate.Auction.Bid.hbm.xml</tt> embedded as resources in the assembly that the types are contained in. This approach eliminates any hardcoded filenames.

Another alternative (probably the best) way is to let NHibernate load all of the mapping files contained in an Assembly:

Configuration cfg = new Configuration() .AddAssembly( "NHibernate.Auction" );

Then NHibernate will look through the assembly for any resources that end with <tt>.hbm.xml</tt>. This approach eliminates any hardcoded filenames and ensures the mapping files in the assembly get added.

If a tool like Visual Studio .NET or NAnt is used to build the assembly, then make sure that the <tt>.hbm.xml</tt> files are compiled into the assembly as <tt>Embedded Resources</tt>.

A <tt>Configuration</tt> also specifies various optional properties:

IDictionary<string, string> props = new Dictionary<string, string>(); ... Configuration cfg = new Configuration() .AddClass(typeof(NHibernate.Auction.Item)) .AddClass(typeof(NHibernate.Auction.Bind)) .SetProperties(props);

A <tt>Configuration</tt> is intended as a configuration-time object, to be discarded once an <tt>ISessionFactory</tt> is built.

Programmatic Configuration

Fabio Maulo — Sat, 06 Sep 2008 05:12:05 GMT
Revision 1 posted to NHibernate 2.0 by Fabio Maulo on 06/09/2008 02:12:05 a.m.

An instance of <tt>NHibernate.Cfg.Configuration</tt> represents an entire set of mappings of an application's .NET types to a SQL database. The <tt>Configuration</tt> is used to build an (immutable) <tt>ISessionFactory</tt>. The mappings are compiled from various XML mapping files.

You may obtain a <tt>Configuration</tt> instance by instantiating it directly. Heres an example of setting up a datastore from mappings defined in two XML configuration files:

Configuration cfg = new Configuration() .AddFile("Item.hbm.xml") .AddFile("Bid.hbm.xml");

An alternative (sometimes better) way is to let NHibernate load a mapping file from an embedded resource:

Configuration cfg = new Configuration() .AddClass(typeof(NHibernate.Auction.Item)) .AddClass(typeof(NHibernate.Auction.Bid));

Then NHibernate will look for mapping files named <tt>NHibernate.Auction.Item.hbm.xml</tt> and <tt>NHibernate.Auction.Bid.hbm.xml</tt> embedded as resources in the assembly that the types are contained in. This approach eliminates any hardcoded filenames.

Another alternative (probably the best) way is to let NHibernate load all of the mapping files contained in an Assembly:

Configuration cfg = new Configuration() .AddAssembly( "NHibernate.Auction" );

Then NHibernate will look through the assembly for any resources that end with <tt>.hbm.xml</tt>. This approach eliminates any hardcoded filenames and ensures the mapping files in the assembly get added.

If a tool like Visual Studio .NET or NAnt is used to build the assembly, then make sure that the <tt>.hbm.xml</tt> files are compiled into the assembly as <tt>Embedded Resources</tt>.

A <tt>Configuration</tt> also specifies various optional properties:

IDictionary<string, string> props = new Dictionary<string, string>(); ... Configuration cfg = new Configuration() .AddClass(typeof(NHibernate.Auction.Item)) .AddClass(typeof(NHibernate.Auction.Bind)) .SetProperties(props);

A <tt>Configuration</tt> is intended as a configuration-time object, to be discarded once an <tt>ISessionFactory</tt> is built.

User provided ADO.NET connection

Fabio Maulo — Sat, 06 Sep 2008 05:34:35 GMT
Current revision posted to NHibernate 2.0 by Fabio Maulo on 06/09/2008 02:34:35 a.m.

User provided ADO.NET connection

An ISessionFactory may open an ISession a user-provided ADO.NET connection. This design choice frees the application to obtain ADO.NET connections wherever it pleases:

IDbConnection conn = myApp.GetOpenConnection(); ISession session = sessions.OpenSession(conn);
// do some data access work

The application must be careful not to open two concurrent ISession on the same ADO.NET connection!

User provided ADO.NET connection

Fabio Maulo — Sat, 06 Sep 2008 05:34:35 GMT
Revision 6 posted to NHibernate 2.0 by Fabio Maulo on 06/09/2008 02:34:35 a.m.

User provided ADO.NET connection

An ISessionFactory may open an ISession a user-provided ADO.NET connection. This design choice frees the application to obtain ADO.NET connections wherever it pleases:

IDbConnection conn = myApp.GetOpenConnection(); ISession session = sessions.OpenSession(conn);
// do some data access work

The application must be careful not to open two concurrent ISession on the same ADO.NET connection!

User provided ADO.NET connection

Fabio Maulo — Sat, 06 Sep 2008 05:32:46 GMT
Revision 5 posted to NHibernate 2.0 by Fabio Maulo on 06/09/2008 02:32:46 a.m.

User provided ADO.NET connection

An <tt>ISessionFactory</tt> may open an <tt>ISession</tt> a user-provided ADO.NET connection. This design choice frees the application to obtain ADO.NET connections wherever it pleases:

IDbConnection conn = myApp.GetOpenConnection(); ISession session = sessions.OpenSession(conn);
// do some data access work

The application must be careful not to open two concurrent <tt>ISession </tt>on on the same ADO.NET connection!

User provided ADO.NET connection

Fabio Maulo — Sat, 06 Sep 2008 05:32:08 GMT
Revision 4 posted to NHibernate 2.0 by Fabio Maulo on 06/09/2008 02:32:08 a.m.

User provided ADO.NET connection

An <tt>ISessionFactory</tt> may open an <tt>ISessionon </tt> a user-provided ADO.NET connection. This design choice frees the application to obtain ADO.NET connections wherever it pleases:

IDbConnection conn = myApp.GetOpenConnection(); ISession session = sessions.OpenSession(conn);
// do some data access work

The application must be careful not to open two concurrent <tt>ISessionon </tt>on the same ADO.NET connection!

User provided ADO.NET connection

Fabio Maulo — Sat, 06 Sep 2008 05:23:30 GMT
Revision 3 posted to NHibernate 2.0 by Fabio Maulo on 06/09/2008 02:23:30 a.m.

User provided ADO.NET connection

An <tt>ISessionFactory</tt> ISessionFactory may open an <tt>ISession</tt> ISession on a user-provided ADO.NET connection. This design choice frees the application to obtain ADO.NET connections wherever it pleases:

IDbConnection conn = myApp.GetOpenConnection(); ISession session = sessions.OpenSession(conn);
// do some data access work

The application must be careful not to open two concurrent <tt>ISession</tt> ISession on the same ADO.NET connection!

User provided ADO.NET connection

Fabio Maulo — Sat, 06 Sep 2008 05:22:29 GMT
Revision 2 posted to NHibernate 2.0 by Fabio Maulo on 06/09/2008 02:22:29 a.m.

User provided ADO.NET connection

An <tt>ISessionFactory</tt> may open an <tt>ISession</tt> on a user-provided ADO.NET connection. This design choice frees the application to obtain ADO.NET connections wherever it pleases:

IDbConnection conn = myApp.GetOpenConnection(); ISession session = sessions.OpenSession(conn);
// do some data access work

The application must be careful not to open two concurrent <tt>ISession</tt> on the same ADO.NET connection!

User provided ADO.NET connection

Fabio Maulo — Sat, 06 Sep 2008 05:20:20 GMT
Revision 1 posted to NHibernate 2.0 by Fabio Maulo on 06/09/2008 02:20:20 a.m.

An <tt>ISessionFactory</tt> may open an <tt>ISession</tt> on a user-provided ADO.NET connection. This design choice frees the application to obtain ADO.NET connections wherever it pleases:

IDbConnection conn = myApp.GetOpenConnection(); ISession session = sessions.OpenSession(conn);
// do some data access work

The application must be careful not to open two concurrent <tt>ISession</tt> on the same ADO.NET connection!

Context Sessions

Fabio Maulo — Mon, 01 Sep 2008 00:06:01 GMT
Current revision posted to NHibernate 2.0 by Fabio Maulo on 31/08/2008 09:06:01 p.m.

Context Sessions

Most applications using NHibernate need some form of "contextual" sessions, where a given session is in effect throughout the scope of a given context. However, across applications the definition of what constitutes a context is typically different; and different contexts define different scopes to the notion of current.

Starting with version 1.2, NHibernate added the ISessionFactory.GetCurrentSession() method. The processing behind ISessionFactory.GetCurrentSession() is pluggable. An extension interface (NHibernate.Context.ICurrentSessionContext) and a new configuration parameter (current_session_context_class) have been added to allow pluggability of the scope and context of defining current sessions.

See the API documentation for the NHibernate.Context.ICurrentSessionContext interface for a detailed discussion of its contract. It defines a single method, CurrentSession(), by which the implementation is responsible for tracking the current contextual session. Out-of-the-box, NHibernate 2.0.0 comes with several implementations of this interface:

NHibernate.Context.ManagedWebSessionContext - current sessions are tracked by HttpContext. However, you are responsible to bind and unbind an ISession instance with static methods on this class, it never opens, flushes, or closes an ISession itself.

NHibernate.Context.CallSessionContext - current sessions are tracked by CallContext. You are responsible to bind and unbind an ISession instance with static methods of class CurrentSessionContext.

NHibernate.Context.ThreadStaticSessionContext - current session is stored in a thread-static variable. This context only supports one session factory. You are responsible to bind and unbind an ISession instance with static methods of class CurrentSessionContext.

NHibernate.Context.WebSessionContext - analogous to ManagedWebSessionContextabove, stores the current session in HttpContext. You are responsible to bind and unbind an ISession instance with static methods of class CurrentSessionContext.

The current_session_context_class configuration parameter defines which NHibernate.Context.ICurrentSessionContext implementation should be used. Typically, the value of this parameter would just name the implementation class to use (including the assembly name); for the out-of-the-box implementations, however, there are corresponding short names: "managed_web", "call", "thread_static", and "web", respectively.

Context Sessions

Fabio Maulo — Mon, 01 Sep 2008 00:06:01 GMT
Revision 3 posted to NHibernate 2.0 by Fabio Maulo on 31/08/2008 09:06:01 p.m.

Context Sessions
  
Most applications using NHibernate need some form of "contextual" sessions, where a given session is in effect throughout the scope of a given context. However, across applications the definition of what constitutes a context is typically different; and different contexts define different scopes to the notion of current.

Starting with version 1.2, NHibernate added the <tt>ISessionFactory.GetCurrentSession()</tt> ISessionFactory.GetCurrentSession() method. The processing behind <tt>ISessionFactory.GetCurrentSession()</tt> ISessionFactory.GetCurrentSession() is pluggable. An extension interface (<tt>NHibernate.Context.ICurrentSessionContext</tt>) NHibernate.Context.ICurrentSessionContext) and a new configuration parameter (<tt>current_session_context_class</tt>) current_session_context_class) have been added to allow pluggability of the scope and context of defining current sessions.

See the API documentation for the <tt>NHibernate.Context.ICurrentSessionContext</tt> NHibernate.Context.ICurrentSessionContext interface for a detailed discussion of its contract. It defines a single method, <tt>CurrentSession()</tt>, CurrentSession(), by which the implementation is responsible for tracking the current contextual session. Out-of-the-box, NHibernate 2.0.0 comes with several implementations of this interface:

<tt>NHibernate.Context.ManagedWebSessionContext</tt>

NHibernate.Context.ManagedWebSessionContext - current sessions are tracked by <tt>HttpContext</tt>. HttpContext. However, you are responsible to bind and unbind an <tt>ISession</tt> ISession instance with static methods on this class, it never opens, flushes, or closes an <tt>ISession</tt> ISession itself.

<tt>NHibernate.Context.CallSessionContext</tt>

NHibernate.Context.CallSessionContext - current sessions are tracked by <tt>CallContext</tt>. CallContext. You are responsible to bind and unbind an <tt>ISession</tt> ISession instance with static methods of class <tt>CurrentSessionContext </tt>.

<tt>NHibernate.Context.ThreadStaticSessionContext</tt> CurrentSessionContext.

NHibernate.Context.ThreadStaticSessionContext - current session is stored in a thread-static variable. This context only supports one session factory. You are responsible to bind and unbind an <tt>ISession</tt> ISession instance with static methods of class <tt>CurrentSessionContext</tt>.

<tt>NHibernate.Context.WebSessionContext</tt> CurrentSessionContext.

NHibernate.Context.WebSessionContext - analogous to <tt>ManagedWebSessionContext</tt> ManagedWebSessionContextabove, stores the current session in <tt>HttpContext</tt>. HttpContext. You are responsible to bind and unbind an <tt>ISession </tt>instance ISession instance with static methods of class <tt>CurrentSessionContext</tt>. CurrentSessionContext.

The <tt>current_session_context_class</tt> current_session_context_class configuration parameter defines which <tt>NHibernate.Context.ICurrentSessionContext</tt> NHibernate.Context.ICurrentSessionContext implementation should be used. Typically, the value of this parameter would just name the implementation class to use (including the assembly name); for the out-of-the-box implementations, however, there are corresponding short names: "managed_web", "call", "thread_static", "managed_web", "call", "thread_static", and "web", "web", respectively.

Context Sessions

Fabio Maulo — Sun, 31 Aug 2008 23:59:18 GMT
Revision 2 posted to NHibernate 2.0 by Fabio Maulo on 31/08/2008 08:59:18 p.m.

Context Sessions

<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="ProgId" content="Word.Document" /> <meta name="Generator" content="Microsoft Word 12" /> <meta name="Originator" content="Microsoft Word 12" /> <link rel="File-List" href="file:///C:\DOCUME~1\FABIOM~1\CONFIG~1\Temp\msohtmlclip1\01\clip_filelist.xml" /> <link rel="themeData" href="file:///C:\DOCUME~1\FABIOM~1\CONFIG~1\Temp\msohtmlclip1\01\clip_themedata.thmx" /> <link rel="colorSchemeMapping" href="file:///C:\DOCUME~1\FABIOM~1\CONFIG~1\Temp\msohtmlclip1\01\clip_colorschememapping.xml" />  <style></style>  
Most applications using NHibernate need some form of "contextual" sessions, where a given session is in effect throughout the scope of a given context. However, across applications the definition of what constitutes a context is typically different; and different contexts define different scopes to the notion of current.

Starting with version 1.2, NHibernate added the <tt>ISessionFactory.GetCurrentSession()</tt> <tt>ISessionFactory.GetCurrentSession()</tt> method. The processing behind <tt>ISessionFactory.GetCurrentSession()</tt> <tt>ISessionFactory.GetCurrentSession()</tt> is pluggable. An extension interface (<tt>NHibernate.Context.ICurrentSessionContext</tt>) <tt>NHibernate.Context.ICurrentSessionContext</tt>) and a new configuration parameter (<tt>hibernate.current_session_context_class</tt>) <tt>current_session_context_class</tt>) have been added to allow pluggability of the scope and context of defining current sessions.

See the API documentation for the <tt>NHibernate.Context.ICurrentSessionContext</tt> <tt>NHibernate.Context.ICurrentSessionContext</tt> interface for a detailed discussion of its contract. It defines a single method, <tt>CurrentSession()</tt>, <tt>CurrentSession()</tt>, by which the implementation is responsible for tracking the current contextual session. Out-of-the-box, NHibernate 2.0.0 comes with several implementations of this interface:

·         <tt>NHibernate.Context.ManagedWebSessionContext</tt>

<tt>NHibernate.Context.ManagedWebSessionContext</tt> - current sessions are tracked by <tt>HttpContext</tt>. <tt>HttpContext</tt>. However, you are responsible to bind and unbind an <tt>ISession</tt> <tt>ISession</tt> instance with static methods on this class, it never opens, flushes, or closes an <tt>ISession</tt> <tt>ISession</tt> itself.

·         <tt>NHibernate.Context.CallSessionContext</tt>

<tt>NHibernate.Context.CallSessionContext</tt> - current sessions are tracked by <tt>CallContext</tt>. <tt>CallContext</tt>. You are responsible to bind and unbind an <tt>ISession</tt> <tt>ISession</tt> instance with static methods of class <tt>CurrentSessionContext <tt>CurrentSessionContext </tt>.

·         <tt>NHibernate.Context.ThreadStaticSessionContext</tt>

<tt>NHibernate.Context.ThreadStaticSessionContext</tt> - current session is stored in a thread-static variable. This context only supports one session factory. You are responsible to bind and unbind an <tt>ISession</tt> <tt>ISession</tt> instance with static methods of class <tt>CurrentSessionContext</tt>.

·         <tt>NHibernate.Context.WebSessionContext</tt> <tt>CurrentSessionContext</tt>.

<tt>NHibernate.Context.WebSessionContext</tt> - analogous to <tt>ManagedWebSessionContext</tt> <tt>ManagedWebSessionContext</tt> above, stores the current session in <tt>HttpContext</tt>. <tt>HttpContext</tt>. You are responsible to bind and unbind an <tt>ISession <tt>ISession </tt>instance with static methods of class <tt>CurrentSessionContext</tt>. <tt>CurrentSessionContext</tt>.

The <tt>hibernate.current_session_context_class</tt> <tt>current_session_context_class</tt> configuration parameter defines which <tt>NHibernate.Context.ICurrentSessionContext</tt> <tt>NHibernate.Context.ICurrentSessionContext</tt> implementation should be used. Typically, the value of this parameter would just name the implementation class to use (including the assembly name); for the out-of-the-box implementations, however, there are corresponding short names: "managed_web", "call", "thread_static", and "web", respectively.

Context Sessions

Fabio Maulo — Sun, 31 Aug 2008 23:57:43 GMT
Revision 1 posted to NHibernate 2.0 by Fabio Maulo on 31/08/2008 08:57:43 p.m.

<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="ProgId" content="Word.Document" /> <meta name="Generator" content="Microsoft Word 12" /> <meta name="Originator" content="Microsoft Word 12" /> <link rel="File-List" href="file:///C:\DOCUME~1\FABIOM~1\CONFIG~1\Temp\msohtmlclip1\01\clip_filelist.xml" /> <link rel="themeData" href="file:///C:\DOCUME~1\FABIOM~1\CONFIG~1\Temp\msohtmlclip1\01\clip_themedata.thmx" /> <link rel="colorSchemeMapping" href="file:///C:\DOCUME~1\FABIOM~1\CONFIG~1\Temp\msohtmlclip1\01\clip_colorschememapping.xml" />  <style></style>  

Most applications using NHibernate need some form of "contextual" sessions, where a given session is in effect throughout the scope of a given context. However, across applications the definition of what constitutes a context is typically different; and different contexts define different scopes to the notion of current.

Starting with version 1.2, NHibernate added the <tt>ISessionFactory.GetCurrentSession()</tt> method. The processing behind <tt>ISessionFactory.GetCurrentSession()</tt> is pluggable. An extension interface (<tt>NHibernate.Context.ICurrentSessionContext</tt>) and a new configuration parameter (<tt>hibernate.current_session_context_class</tt>) have been added to allow pluggability of the scope and context of defining current sessions.

See the API documentation for the <tt>NHibernate.Context.ICurrentSessionContext</tt> interface for a detailed discussion of its contract. It defines a single method, <tt>CurrentSession()</tt>, by which the implementation is responsible for tracking the current contextual session. Out-of-the-box, NHibernate 2.0.0 comes with several implementations of this interface:

·         <tt>NHibernate.Context.ManagedWebSessionContext</tt> - current sessions are tracked by <tt>HttpContext</tt>. However, you are responsible to bind and unbind an <tt>ISession</tt> instance with static methods on this class, it never opens, flushes, or closes an <tt>ISession</tt> itself.

·         <tt>NHibernate.Context.CallSessionContext</tt> - current sessions are tracked by <tt>CallContext</tt>. You are responsible to bind and unbind an <tt>ISession</tt> instance with static methods of class <tt>CurrentSessionContext </tt>.

·         <tt>NHibernate.Context.ThreadStaticSessionContext</tt> - current session is stored in a thread-static variable. This context only supports one session factory. You are responsible to bind and unbind an <tt>ISession</tt> instance with static methods of class <tt>CurrentSessionContext</tt>.

·         <tt>NHibernate.Context.WebSessionContext</tt> - analogous to <tt>ManagedWebSessionContext</tt> above, stores the current session in <tt>HttpContext</tt>. You are responsible to bind and unbind an <tt>ISession </tt>instance with static methods of class <tt>CurrentSessionContext</tt>.

The <tt>hibernate.current_session_context_class</tt> configuration parameter defines which <tt>NHibernate.Context.ICurrentSessionContext</tt> implementation should be used. Typically, the value of this parameter would just name the implementation class to use (including the assembly name); for the out-of-the-box implementations, however, there are corresponding short names: "managed_web", "call", "thread_static", and "web", respectively.

Instance states

Fabio Maulo — Sun, 31 Aug 2008 23:28:14 GMT
Current revision posted to NHibernate 2.0 by Fabio Maulo on 31/08/2008 08:28:14 p.m.

Instance states

An instance of a persistent classes may be in one of three different states, which are defined with respect to a persistence context. The NHibernate <tt class="literal">ISession</tt> ISession object is the persistence context:

<dl><dt>

transient</dt><dd>
The instance is not, and has never been associated with any persistence context. It has no persistent identity (primary key value).
</dd><dt>
persistent</dt><dd>
The instance is currently associated with a persistence context. It has a persistent identity (primary key value) and, perhaps, a corresponding row in the database. For a particular persistence context, NHibernate guarantees that persistent identity is equivalent to CLR identity (in-memory location of the object).
</dd><dt>
detached</dt><dd>
The instance was once associated with a persistence context, but that context was closed, or the instance was serialized to another process. It has a persistent identity and, perhaps, a corrsponding row in the database. For detached instances, NHibernate makes no guarantees about the relationship between persistent identity and CLR identity.
</dd></dl>

Instance states

Fabio Maulo — Sun, 31 Aug 2008 23:26:51 GMT
Revision 1 posted to NHibernate 2.0 by Fabio Maulo on 31/08/2008 08:26:51 p.m.

An instance of a persistent classes may be in one of three different states, which are defined with respect to a persistence context. The NHibernate <tt class="literal">ISession</tt> object is the persistence context:

<dl><dt>transient</dt><dd>
The instance is not, and has never been associated with any persistence context. It has no persistent identity (primary key value).
</dd><dt>persistent</dt><dd>
The instance is currently associated with a persistence context. It has a persistent identity (primary key value) and, perhaps, a corresponding row in the database. For a particular persistence context, NHibernate guarantees that persistent identity is equivalent to CLR identity (in-memory location of the object).
</dd><dt>detached</dt><dd>
The instance was once associated with a persistence context, but that context was closed, or the instance was serialized to another process. It has a persistent identity and, perhaps, a corrsponding row in the database. For detached instances, NHibernate makes no guarantees about the relationship between persistent identity and CLR identity.
</dd></dl>

<Query>	::=	<SelectStatement>
	\|	<DeleteStatement>
	\|	<UpdateStatement>
	\|	<InsertStatement>

<DeleteStatement>	::=	DELETE <AliasedEntityName> <WhereClause>
	\|	DELETE FROM <AliasedEntityName> <WhereClause>

<UpdateStatement>	::=	UPDATE <AliasedEntityName> SET <AssignList> <WhereClause>
	\|	UPDATE VERSIONED <AliasedEntityName> SET <AssignList> <WhereClause>
	\|	UPDATE FROM <AliasedEntityName> SET <AssignList> <WhereClause>
	\|	UPDATE VERSIONED FROM <AliasedEntityName> SET <AssignList> <WhereClause>

<AssignList>	::=	<EntityName> '=' <Expression> ',' <AssignList>
	\|	<EntityName> '=' <Expression>

<SelectStatement>	::=	<SelectClause> <FromClause>
	\|	<FromClause>

<SelectClause>	::=	SELECT <Restriction> <AliasedExpressionList>
	\|	SELECT NEW <EntityName> '(' <ExpressionList> ')'

<JoinClauseChain>	::=	<JoinClause> <JoinClauseChain>
	\|	<JoinClause> ',' <AliasedEntityNameList> <JoinClauseChain>
	\|

<JoinDefinition>	::=	LEFT JOIN <AliasedEntityName>
	\|	RIGHT JOIN <AliasedEntityName>
	\|	LEFT OUTER JOIN <AliasedEntityName>
	\|	RIGHT OUTER JOIN <AliasedEntityName>
	\|	FULL JOIN <AliasedEntityName>
	\|	INNER JOIN <AliasedEntityName>
	\|	LEFT JOIN FETCH <AliasedEntityName>
	\|	LEFT OUTER JOIN FETCH <AliasedEntityName>
	\|	INNER JOIN FETCH <AliasedEntityName>
	\|	JOIN <AliasedEntityName>
	\|	JOIN FETCH <AliasedEntityName>

<OrderList>	::=	<OrderItem> ',' <OrderList>
	\|	<OrderItem>

<OrderType>	::=	ASC
	\|	DESC
	\|	ASCENDING
	\|	DESCENDING
	\|

<AggregateExpression>	::=	COUNT '(' *'' ')'**
	\|	COUNT '(' <Restriction> <EntityName> ')'
	\|	COUNT '(' <Restriction> <CollectionExpression> ')'
	\|	AVG '(' <MathAddExpression> ')'
	\|	MIN '(' <MathAddExpression> ')'
	\|	MAX '(' <MathAddExpression> ')'

<FunctionExpression>	::=	Identifier '(' ')'
	\|	Identifier '(' <ExpressionList> ')'
	\|	CAST '(' <Expression> AS Identifier ')'
	\|	<TrimFunctionExpression>
	\|	<ExtractFunctionExpression>
	\|	YEAR '(' <Expression> ')'
	\|	MONTH '(' <Expression> ')'
	\|	DAY '(' <Expression> ')'
	\|	HOUR '(' <Expression> ')'
	\|	MINUTE '(' <Expression> ')'
	\|	SECOND '(' <Expression> ')'

<TrimFunctionExpression>	::=	TRIM '(' <StringValueExpression> ')'
	\|	TRIM '(' <TrimOperands> <StringValueExpression> ')'

<TrimOperands>	::=	<StringValueExpression> FROM
	\|	<TrimSpecification> <StringValueExpression> FROM
	\|	<TrimSpecification> FROM
	\|	FROM

<ExtractField>	::=	YEAR
	\|	MONTH
	\|	DAY
	\|	HOUR
	\|	MINUTE
	\|	SECOND
	\|	'TIMEZONE_HOUR'
	\|	'TIMEZONE_MINUTE'

<CollectionExpression>	::=	<ElementsExpression>
	\|	INDICES '(' Path ')'

<EntityNameList>	::=	<EntityName> ',' <EntityNameList>
	\|	<EntityName>

<AliasedEntityName>	::=	<EntityName> Identifier
	\|	<EntityName> AS Identifier
	\|	Identifier IN CLASS <EntityName>
	\|	Identifier IN <ElementsExpression>
	\|	<EntityName>

<AliasedEntityNameList>	::=	<AliasedEntityName> ',' <AliasedEntityNameList>
	\|	<AliasedEntityName>

<AliasedExpression>	::=	<Expression> AS Identifier
	\|	<Expression>

<AliasedExpressionList>	::=	<AliasedExpression> ',' <AliasedExpressionList>
	\|	<AliasedExpression>

<AndExpression>	::=	<NotExpression> AND <AndExpression>
	\|	<NotExpression>

<NotExpression>	::=	NOT <PredicateExpression>
	\|	<PredicateExpression>

<QuantifiedExpression>	::=	SOME Path
	\|	ALL Path
	\|	ANY Path
	\|	SOME <CollectionExpression>
	\|	ALL <CollectionExpression>
	\|	ANY <CollectionExpression>
	\|	SOME '(' <SelectStatement> ')'
	\|	ALL '(' <SelectStatement> ')'
	\|	ANY '(' <SelectStatement> ')'

<PredicateExpression>	::=	<MathAddExpression> BETWEEN <MathAddExpression> AND <MathAddExpression>
	\|	<MathAddExpression> NOT BETWEEN <MathAddExpression> AND <MathAddExpression>
	\|	<Value> IS NOT NULL
	\|	<Value> IS NULL
	\|	<Value> IS EMPTY
	\|	<Value> IS NOT EMPTY
	\|	<MathAddExpression> LIKE <ConcatenationExpression> <LikeEscape>
	\|	<MathAddExpression> NOT LIKE <ConcatenationExpression> <LikeEscape>
	\|	<MathAddExpression> IN <Tuple>
	\|	<MathAddExpression> NOT IN <Tuple>
	\|	<MathAddExpression> IN <CollectionExpression>
	\|	<MathAddExpression> NOT IN <CollectionExpression>
	\|	<MemberPredicate>
	\|	<ExistsPredicate>
	\|	<MathAddExpression> '>' <MathAddExpression>
	\|	<MathAddExpression> '<' <MathAddExpression>
	\|	<MathAddExpression> '=' <MathAddExpression>
	\|	<MathAddExpression> '>=' <MathAddExpression>
	\|	<MathAddExpression> '<=' <MathAddExpression>
	\|	<MathAddExpression> NotEqualOperator <MathAddExpression>
	\|	<MathAddExpression> '>' <QuantifiedExpression>
	\|	<MathAddExpression> '<' <QuantifiedExpression>
	\|	<MathAddExpression> '=' <QuantifiedExpression>
	\|	<MathAddExpression> '>=' <QuantifiedExpression>
	\|	<MathAddExpression> '<=' <QuantifiedExpression>
	\|	<MathAddExpression> NotEqualOperator <QuantifiedExpression>
	\|	<MathAddExpression>

<ExistsPredicate>	::=	EXISTS Path
	\|	EXISTS <CollectionExpression>
	\|	EXISTS '(' <SelectStatement> ')'

<MemberPredicate>	::=	Path MEMBER OF Path
	\|	Path MEMBER Path

<MathAddExpression>	::=	<MathAddExpression> '+' <MathMultExpression>
	\|	<MathAddExpression> '-' <MathMultExpression>
	\|	<MathMultExpression>

<MathMultExpression>	::=	<MathMultExpression> *'' <MathNegateExpression>**
	\|	<MathMultExpression> '/' <MathNegateExpression>
	\|	<MathNegateExpression>

<MathNegateExpression>	::=	'-' <Value>
	\|	<Value>