FlushMode.cs

using System;

namespace NHibernate
{
	/// <summary>
	/// Represents a flushing strategy.
	/// </summary>
	/// <remarks>
	/// The flush process synchronizes database state with session state by detecting state
	/// changes and executing SQL statements
	/// </remarks>
	[Serializable]
	public enum FlushMode
	{
		/// <summary>
		/// Special value for unspecified flush mode (like <see langword="null" /> in Java).
		/// </summary>
		Unspecified = -1,

		/// <summary>
		/// The <c>ISession</c> is never flushed unless <c>Flush()</c> is explicitly
		/// called by the application. This mode is very efficient for read only
		/// transactions
		/// </summary>
		Manual = 0,
		// Obsolete in v5.
		/// <summary>
		/// The <c>ISession</c> is never flushed unless <c>Flush()</c> is explicitly
		/// called by the application. This mode is very efficient for read only
		/// transactions
		/// </summary>
		[Obsolete("Please use Manual instead.")]
		Never = Manual,
		/// <summary>
		/// The <c>ISession</c> is flushed when <c>Transaction.Commit()</c> is called
		/// </summary>
		Commit = 5,
		/// <summary>
		/// The <c>ISession</c> is sometimes flushed before query execution in order to
		/// ensure that queries never return stale state. This is the default flush mode.
		/// </summary>
		Auto = 10,
		/// <summary>
		/// The <see cref="ISession"/> is flushed before every query. This is
		/// almost always unnecessary and inefficient.
		/// </summary>
		Always = 20
	}
}