NH-4000 - Release notes.

Author: fredericDelaporte

releasenotes.txt

@@ -1,3 +1,227 @@
+Build 5.0.0
+=============================
+
+** Highlights
+    * IO bound methods have gained an async counterpart. Not intended for parallelism, make sure to await each
+      call before further interacting with a session and its queries.
+    * Strongly typed DML operation (insert/update/delete) are now available as Linq extensions on queryables.
+    * Entities collections can be queried with .AsQueryable() Linq extension without being fully loaded.
+    * Reference documentation has been curated and completed, notably with a Linq section.
+      http://nhibernate.info/doc/nhibernate-reference/index.html
+
+** Known BREAKING CHANGES from NH4.1.1.GA to 5.0.0
+
+    NHibernate now targets .Net 4.6.1.
+
+    Remotion.Linq and Antlr3 libraries are no more merged in the NHibernate library,
+    and must be deployed along NHibernate library. (NuGet will reference them.)
+
+    Classes and members which were flagged as obsolete in the NHibernate 4.x series have been dropped.
+    Prior to upgrading, fix any obsolete warning according to its message. See NH-4075 and NH-3684 for a list.
+
+    ##### Possible Breaking Changes #####
+        * All members exposing some System.Data types have been changed for corresponding System.Data.Common
+          types. (IDbCommand => DbCommand, ...)
+        * The Date NHibernate type will no more replace by null values below its base value (which was year 1753).
+          Its base value is now DateTime.MinValue. Its configuration parameter is obsolete.
+        * Transaction scopes handling has undergone a major rework. See NH-4011 for full details.
+          ** More transaction promotion to distributed may occur if you use the "flush on commit" feature with
+             transaction scopes. Explicitly flush your session instead. Ensure it does not occur by disabling
+             transaction.use_connection_on_system_events setting.
+          ** After transaction events no more allow using the connection when they are raised from a scope
+             completion.
+          ** Connection enlistment in ambient transaction is now enforced by NHibernate by default.
+          ** The connection releasing is no more directly triggered by a scope completion, but by later
+             interactions with the session.
+        * AdoNetWithDistributedTransactionFactory has been renamed AdoNetWithSystemTransactionFactory.
+        * Subcriteria.UniqueResult<T> for value types now return default(T) when result is null, as was
+          already doing CriteriaImpl.UniqueResult<T>.
+        * AliasToBeanResultTransformer property/field resolution logic has changed for supporting members
+          which names differ only by case. See NH-3693 last comments for details.
+        * Linq extension methods marked with attribute LinqExtensionMethod will no more be evaluated
+          in-memory prior to query execution when they do not depend on query results, but will always be
+          translated to their corresponding SQL call. This can be changed with a parameter of the attribute.
+        * Linq Query methods are now native members of ISession and IStatelessSession instead of being
+          extension methods.
+        * Linq provider now use Remotion.Linq v2, which may break Linq provider extensions, mainly due to names
+          changes. See https://github.com/nhibernate/nhibernate-core/pull/568 changes to test files for examples.
+        * NHibernate Linq internals have undergone some minor changes which may breaks custom Linq providers due
+          to method signature changes and additional methods to implement.
+        * NullableType, its descendent (notably all PrimitiveType) and IUserType value getters and setters now
+          take the session as an argument. This should mainly impact custom types implementors.
+        * EmitUtil is now internal and has been cleaned of unused members.
+        * ContraintOrderedTableKeyColumnClosure has been renamed ConstraintOrderedTableKeyColumnClosure.
+        * enabledFilter parameter has been removed from IProjection.ToSqlString and ICriterion.ToSqlString methods.
+        * Proxy factory and proxy cache now use TypeInfo instead of System.Type. This should be transparent for
+          most users.
+        * Exceptions which were based on ApplicationException are now based on Exception: HibernateException,
+          ParserException and AssertionFailure. The logger factory which could throw a bare ApplicationException
+          now throws an InstantiationException instead.
+        * ThreadSafeDictionary class has been removed. Use System.Collections.Concurrent.ConcurrentDictionary
+          instead.
+        * Entity mode switching capability, which had never been fully implemented, is dropped.
+        * BytecodeProviderImpl, intended for .Net Framework 1 and broken, is dropped.
+        * Sessions concrete classes constructors have been changed. (It is not expected for them to be used
+          directly.)
+        * Obsolete setting interceptors.beforetransactioncompletion_ignore_exceptions is dropped.
+        * Oracle: Hbm2dll will no-more choose N- prefixed types for typing Unicode string columns by default.
+          This can be changed with oracle.use_n_prefixed_types_for_unicode setting, which will furthermore
+          control DbCommand parameters typing accordingly. See NH-4062.
+        * SqlServerCe: the id generator "native" will now resolve as table-hilo instead of identity.
+        * Firebird: timestamp resolution is now 1ms.
+        * PostgreSQL: if Npgsql v3 or later is used, time DbParameters will be fetch with TimeSpan instead of
+          DateTime.
+
+** Sub-task
+    * [NH-3956] - Native SQL query plan may get wrong plan
+    * [NH-3957] - Second level query cache may yields wrong cache entry
+    * [NH-4001] - Remove ThreadSafeDictionary
+
+** Bug
+    * [NH-926] - Identity insert fails with SQL Ce dialect and aggressive connection release mode.
+    * [NH-1752] - NHibernate Date type converts to NULL
+    * [NH-1904] - Protected properties and public properties cannot have the same name with different case
+    * [NH-2029] - filter-def's use-many-to-one=false should take ON into consideration
+    * [NH-2145] - AssertionFailure exception at ISession.Save
+    * [NH-2176] - Consecutive TransactionScopes cannot be used in same NHibernate session
+    * [NH-2238] - "DTC transaction prepare phase failed" when UPDATE:ing in a promoted TransactionScope
+    * [NH-2241] - Batch Insert using stateless session when using second level cache throws exception when unable to determine transient status
+    * [NH-2928] - Connections can only be closed after the Transaction is completed
+    * [NH-3023] - Deadlocks may cause connection pool corruption when in a distributed transaction
+    * [NH-3078] - TimeAsTimeSpanType issue when using Sybase Advantage Database
+    * [NH-3100] - Problem in use if condition for nullable boolean in linq to NHibernate
+    * [NH-3114] - Collection inside Component cannot be mapped to a different table
+    * [NH-3227] - InvalidOperationException in AbstractBatcher when distributed transaction is aborted
+    * [NH-3247] - Char value gets 'cached' in Where-queries
+    * [NH-3374] - Session.Merge throws InvalidCastException when using a Lazy bytes[] property
+    * [NH-3600] - ISession.Save returns wrong Id
+    * [NH-3665] - FirstOrDefault() broken since 3.3.4 and 3.4.0
+    * [NH-3693] - AliasToBeanResultTransformerFixture fails under Firebird
+    * [NH-3755] - Proxy exception for multiple joined-subclass
+    * [NH-3757] - Dynamic entity mapped with entity-name cannot have a component of a fixed class
+    * [NH-3793] - Attribute entity-name on <key-many-to-one> is ignored, causing mapping exception
+    * [NH-3845] - OfType fails with polymorphism
+    * [NH-3850] - .Count(), .Any() and other aggregates return only first result on polymorphic queries
+    * [NH-3885] - ThreadSafeDictionary is not threadsafe
+    * [NH-3889] - Coalesce on entity in sub-select causes incorrect SQL
+    * [NH-3911] - Reflection Optimizer tries to cast values to getter type in setter
+    * [NH-3913] - Component has bag of child components. Child property mapping ignored
+    * [NH-3931] - Invalid order of child inserts when using TPH inheritance
+    * [NH-3946] - Linq where "is base class" doesn't get subclasses
+    * [NH-3948] - CheckAndUpdateSessionStatus() called twice in CreateFilter method inside SessionImpl class
+    * [NH-3950] - FutureValue fails on Linq queries defining a PostExecuteTransformer
+    * [NH-3954] - Dynamic proxy cache may yield a wrong proxy
+    * [NH-3955] - Unreliable Equals implementation
+    * [NH-3961] - Invalid date parameter format with nullables and MappedAs
+    * [NH-3966] - Missing command set dispose in batchers
+    * [NH-3968] - Distributed transaction cannot be committed because AdoNetWithDistributedTransactionFactory tries to write data by using locked sqlConnection
+    * [NH-3969] - Firebird: TimestampResolutionInTicks should be 1ms
+    * [NH-3977] - Thread safety weaknesses of MapBasedSessionContext
+    * [NH-3981] - CollectionHelper.DictionaryEquals throws
+    * [NH-3985] - ObjectDisposedException is thrown when using a child session after having previously disposed of another child session.
+    * [NH-3998] - SqlServer CE: "The column aliases must be unique" exception is thrown in some tests
+    * [NH-4013] - SqlClientBatchingBatcher CloseCommands contract violated
+    * [NH-4022] - MsSql2012Dialect: Invalid drop sequence statement
+    * [NH-4024] - ODBC failures with time
+    * [NH-4027] - Missing disposals of enumerators
+    * [NH-4035] - Teardown failure should not prevent cleanup
+    * [NH-4038] - Mapping a TimeSpan in a collection component mapping maps as a BIGINT
+    * [NH-4046] - Default length too short for variable length types with SAP Anywhere / ASE
+    * [NH-4077] - Possible race condition in ActionQueue.ExecuteActions
+
+** New Feature
+    * [NH-1530] - Add support for XmlDocType and XDocType for Oracle
+    * [NH-2319] - IQueryable support for persistent collections
+    * [NH-2520] - New type TimestampUtc
+    * [NH-3488] - Strongly Typed Updates and Deletes
+    * [NH-3771] - Implement setting to enable Batch Update with Optimistic Locking control
+    * [NH-3905] - Support async: Blocking IO leads to ThreadPool starvation and limits scalability
+    * [NH-3934] - Add methods WhereNot(ICriterion) and AndNot(ICriterion) in QueryOver
+    * [NH-3951] - Support .All() result operator
+    * [NH-3996] - Postgres: add support for XmlDocType and XDocType
+    * [NH-4009] - Allow marking a Linq extension as db only
+    * [NH-4017] - Handle Time parameter conversion for newer Npgsql
+    * [NH-4018] - Port AutoJoinTransaction feature
+    * [NH-4028] - Support inconclusive tests in result comparison
+    * [NH-4031] - Add an AsyncLocalSessionContext
+    * [NH-4032] - Supports multiple factories with ThreadStaticSessionContext
+    * [NH-4062] - Properly handle Oracle Unicode support dual model
+
+** Task
+    * [NH-3683] - Fix Compilation Warnings
+    * [NH-3958] - Reference documentation: missing types
+    * [NH-3959] - Fix documentation typos
+    * [NH-3999] - Document effect of quoted identifier on case sensitivity
+    * [NH-4000] - Release 5.0
+    * [NH-4004] - Restrict tests running on SQL CE
+    * [NH-4051] - Replace System.Linq.Dynamic with System.Linq.Dynamic.Core in tests
+    * [NH-4057] - Fix tests for MySql
+    * [NH-4058] - Fix Oracle managed failing tests
+    * [NH-4063] - Fix ODBC failing tests
+
+** Improvement
+    * [NH-1851] - Mapping a TimeSpan as TimeAsTimeSpan for MySQL
+    * [NH-2444] - Document linq provider
+    * [NH-3094] - Linq does not support unary plus and unary minus operators
+    * [NH-3370] - Remove warning about "NHibernate.Type.CustomType -- the custom type * is not serializable"
+    * [NH-3386] - Linq OrderBy NewID()
+    * [NH-3431] - Replace System.Data with System.Data.Common
+    * [NH-3578] - Subcriteria.UniqueResult<T> for value types should return default(T), same as CriteriaImpl.UniqueResult<T> when result is null
+    * [NH-3669] - Query should be instance method of ISession
+    * [NH-3723] - Some tests are failing when log level set to DEBUG
+    * [NH-3744] - Fixed spelling of ContraintOrderedTableKeyColumnClosure method
+    * [NH-3750] - Use NuGet to refer to Remotion.Linq (unmerge ReMotion.Linq)
+    * [NH-3877] - Target .NET 4.6.1
+    * [NH-3884] - Default DateTimeType can not be overridden for SQL queries
+    * [NH-3900] - Upgrade to Nunit 3.x
+    * [NH-3927] - Switch to SemVer version scheme
+    * [NH-3932] - Merge() may fire unnecessary updates if collection and version mapping exists
+    * [NH-3943] - Use NuGet to reference packages instead of local copies
+    * [NH-3944] - Upgrade to ReLinq 2
+    * [NH-3945] - Update to Antlr 3.5.1
+    * [NH-3952] - Cleanup EnumerableHelper usage
+    * [NH-3962] - Build with MSBuild Tools 2017 (15)
+    * [NH-3963] - More explicit error on MappedAs invalid usage.
+    * [NH-3964] - Refactor reflection patterns
+    * [NH-3970] - TestCase base class: avoid hiding test failure on tear-down
+    * [NH-3973] - Remove enabledFilter parameter from IProjection.ToSqlString and ICriterion.ToSqlString methods
+    * [NH-3975] - Synchronize some features dialect support properties
+    * [NH-3978] - Extract IDatabaseMetadata from DatabaseMetadata
+    * [NH-3987] - Re-implement NhQueryable options
+    * [NH-3988] - Replace ApplicationException base class with just Exception
+    * [NH-3990] - Upgrade to VS2017 Project structure
+    * [NH-3993] - Component Element Customizer Missing ability to map non-public parents and composite element relations
+    * [NH-3997] - SqlServer CE: Make native generator to be TableHiLoGenerator
+    * [NH-4003] - Refactor session constructor
+    * [NH-4010] - Visual Studio launcher still launches 2015
+    * [NH-4014] - Update SQLite assembly for tests
+    * [NH-4015] - Update Npgsql driver and enable DTC for it in tests
+    * [NH-4019] - Pass assembly into log4net functions
+    * [NH-4020] - Use TypeBuilder.CreateTypeInfo()
+    * [NH-4021] - Track all opened session in tests
+    * [NH-4023] - Pass ISessionImplementor to all value setters and getters of nullable types
+    * [NH-4026] - Update Firebird driver and use server in tests
+    * [NH-4030] - Cleanup and xml doc of Linq Future extension
+    * [NH-4033] - Update MySql connector used in tests
+    * [NH-4034] - Flush all sessions participating in a transaction
+    * [NH-4043] - Complete keyword registration needs done in dialects.
+    * [NH-4049] - EmitUtil can be cleaned up
+    * [NH-4050] - Use Task.Run instead of BeginInvoke in tests
+    * [NH-4052] - Collect schema validation exceptions
+    * [NH-4064] - Unmerge Antrl3.Runtime
+    * [NH-4073] - Replace NHibernate.Web.Example with modern version
+    * [NH-4076] - Do not resurrect session
+
+** Remove Feature
+    * [NH-3684] - Remove <Time>Part Extension Methods of QueryOver
+    * [NH-3700] - Remove CodeDom BytecodeProviderImpl
+    * [NH-3722] - Remove entity mode switching capability
+    * [NH-4075] - Remove code obsolete in 4.x
+
+** Meta Issue
+    * [NH-4011] - Fix transaction scopes handling
+
+
 Build 4.1.1.GA
 =============================
 
@@ -3062,7 +3286,7 @@ Alpha Build 0.3.0.0
 - BatcherImpl and PreparerImpl were combined and code cleaned up thanks to problems found when using Ngpsql (Martijn Boland).
 - ITransaction is now responsible for joining IDbCommand to IDbTransaction instead of IBatcher - if applicable.
 - Modified code to help improve performance of Drivers that don't support multiple Open DataReaders on a single IDbConnection.
-- Fixed bug with hbm2net and VelocityRenderer throwing Exception (Carlos Guzm�n �lvarez & Peter Smulovics).
+- Fixed bug with hbm2net and VelocityRenderer throwing Exception (Carlos Guzmán Álvarez & Peter Smulovics).
 - Clean up of hbm2net (Peter Smulovics).
 - Modified internals of AbstractEntityPersister to help with buiding on Mono (Oliver Weichhold).
 - Renamed nhibernate.build to NHibernate.build to help with building on Mono (Oliver Weichhold).
@@ -3114,10 +3338,10 @@ PreAlpha Build 0.1.0.0
 - nhibernate-configuration-2.0.xsd schema was updated to .net friendly names and all cfg.xml files are now validated.
 - Fixed bug with classes having dynamic-insert and dynamic-update causing IndexOutOfRangeExceptions.
 - Modified length of string for CultureInfoType.
-- Added Firebird fixes contributed by Carlos Guzm�n �lvarez.
+- Added Firebird fixes contributed by Carlos Guzmán Álvarez.
 - Changed TimestampType.Set to behaive like hibernate.  Will not write a null value anymore - instead replaces it with DateTime.Now.
 - Removed IVersionType interface from DecimalType.
-- Add PropertyExpressions contributed by Carlos Guzm�n �lvarez.
+- Add PropertyExpressions contributed by Carlos Guzmán Álvarez.
 - Fixed bug with referencing joined classes properties in hql.
 - Fixed IndexOutOfRangeException with NormalizedEntityPersister for versioned entities.
 - Added ObjectType to TypeFactory and NHibernate.