diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 00000000000..7200cc50b8d --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1,3 @@ +# doc-level .gitignore. + +NHibernate.shfbproj diff --git a/doc/reference/master.xml b/doc/reference/master.xml index ed9c0e8d938..335216513d4 100644 --- a/doc/reference/master.xml +++ b/doc/reference/master.xml @@ -39,7 +39,7 @@ NHibernate - Relational Persistence for Idiomatic .NET NHibernate Reference Documentation - 4.0 + 5.0 diff --git a/doc/reference/modules/basic_mapping.xml b/doc/reference/modules/basic_mapping.xml index 0223c77c574..e0aa3e19ab3 100644 --- a/doc/reference/modules/basic_mapping.xml +++ b/doc/reference/modules/basic_mapping.xml @@ -2622,6 +2622,12 @@ DbType.StringFixedLength - 1 char Default when no type attribute specified. + + Currency + System.Decimal + DbType.Currency + type="Currency" must be specified. + Date System.DateTime @@ -2640,25 +2646,31 @@ DbType.DateTime2 type="DateTime2" must be specified. + + DateTimeOffset + System.DateTimeOffset + DbType.DateTimeOffset + Default when no type attribute specified. + DbTimestamp System.DateTime DbType.DateTime - as specific as database supports. type="DbTimestamp" must be specified. When used as a version field, uses the database's current time rather than the client's current time. - - LocalDateTime - System.DateTime - DbType.DateTime - ignores the milliseconds - Ensures the DateTimeKind is set to DateTimeKind.Local - - - UtcDateTime - System.DateTime - DbType.DateTime - ignores the milliseconds - Ensures the DateTimeKind is set to DateTimeKind.Utc - - + + LocalDateTime + System.DateTime + DbType.DateTime - ignores the milliseconds + Ensures the DateTimeKind is set to DateTimeKind.Local + + + UtcDateTime + System.DateTime + DbType.DateTime - ignores the milliseconds + Ensures the DateTimeKind is set to DateTimeKind.Utc + + Decimal System.Decimal DbType.Decimal @@ -2699,9 +2711,15 @@ A System.Enum The DbType for the underlying value. Do not specify type="PersistentEnum" in the mapping. Instead - specify the Assembly Qualified Name of the Enum or let NHibernate use Reflection to "guess" the Type. + specify the Assembly Qualified Name of the Enum or let NHibernate use Reflection to "guess" the Type. The UnderlyingType of the Enum is used to determine the correct DbType. + + SByte + System.SByte + DbType.SByte + Default when no type attribute specified. + Single System.Single @@ -2744,6 +2762,24 @@ DbType.AnsiStringFixedLength - 1 char either 'T' or 'F' type="TrueFalse" must be specified. + + UInt16 + System.UInt16 + DbType.UInt16 + Default when no type attribute specified. + + + UInt32 + System.UInt32 + DbType.UInt32 + Default when no type attribute specified. + + + UInt64 + System.UInt64 + DbType.UInt64 + Default when no type attribute specified. + YesNo System.Boolean @@ -2796,6 +2832,12 @@ DbType.String Default when no type attribute specified. + + Uri + System.Uri + DbType.String + Default when no type attribute specified. + @@ -2831,6 +2873,18 @@ type="Serializable" should be specified. This is the fallback type if no NHibernate Type can be found for the Property. + + XDoc + System.Xml.Linq.XDocument + DbType.Xml + Default when no type attribute specified. Entire field is read into memory. + + + XmlDoc + System.Xml.XmlDocument + DbType.Xml + Default when no type attribute specified. Entire field is read into memory. + diff --git a/doc/reference/modules/batch.xml b/doc/reference/modules/batch.xml index 38982282016..0555e1dcb9c 100644 --- a/doc/reference/modules/batch.xml +++ b/doc/reference/modules/batch.xml @@ -158,7 +158,7 @@ session.Close();]]> - No joins (either implicit or explicit) + No joins (either implicit or explicit) can be specified in a bulk HQL query. Sub-queries may be used in the where-clause; the subqueries, themselves, may contain joins. diff --git a/doc/reference/modules/nhibernate_mapping_attributes.xml b/doc/reference/modules/nhibernate_mapping_attributes.xml index 5c6e457a065..4d42be0d267 100644 --- a/doc/reference/modules/nhibernate_mapping_attributes.xml +++ b/doc/reference/modules/nhibernate_mapping_attributes.xml @@ -164,9 +164,6 @@ public class Base { Instead of using a string for DiscriminatorValue (in [Class] and [Subclass]), you can use any object you want. Example: [Subclass(DiscriminatorValueEnumFormat="d", DiscriminatorValueObject=DiscEnum.Val1)] Here, the object is an Enum, and you can set the format you want (the default value is "g"). Note that you must put it before! For others types, It simply use the ToString() method of the object. - - If you are using members of the type Nullables.NullableXXX (from the library Nullables), then they will be mapped to Nullables.NHibernate.NullableXXXType automatically; don't set Type="..." in [Property] (leave it null). This is also the case for SqlTypes (and you can add your own patterns). Thanks to Michael Third for the idea :) - Each stream generated by NHibernate.Mapping.Attributes can contain a comment with the date of the generation; You may enable/disable this by using the property HbmSerializer.WriteDateComment. diff --git a/src/NHibernate/NHibernateUtil.cs b/src/NHibernate/NHibernateUtil.cs index 72f74c6999b..8f96d3db854 100644 --- a/src/NHibernate/NHibernateUtil.cs +++ b/src/NHibernate/NHibernateUtil.cs @@ -221,12 +221,12 @@ public static IType GuessType(System.Type type) public static readonly TicksType Ticks = new TicksType(); /// - /// NHibernate Ticks type + /// NHibernate TimeAsTimeSpan type /// public static readonly TimeAsTimeSpanType TimeAsTimeSpan = new TimeAsTimeSpanType(); /// - /// NHibernate Ticks type + /// NHibernate TimeSpan type /// public static readonly TimeSpanType TimeSpan = new TimeSpanType(); @@ -278,13 +278,24 @@ public static IType GuessType(System.Type type) // /// // public static readonly NullableType Clob = new ClobType(); - + /// + /// NHibernate AnsiChar type + /// public static readonly AnsiCharType AnsiChar = new AnsiCharType(); + /// + /// NHibernate XmlDoc type + /// public static readonly XmlDocType XmlDoc = new XmlDocType(); + /// + /// NHibernate XDoc type + /// public static readonly XDocType XDoc = new XDocType(); + /// + /// NHibernate Uri type + /// public static readonly UriType Uri = new UriType(); ///