Skip to content

Commit

Permalink
updated readme for v7.0.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
feO2x committed Sep 6, 2022
1 parent ff5f679 commit c5e0aae
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 14 deletions.
2 changes: 1 addition & 1 deletion Code/Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<Authors>Synnotech AG</Authors>
<Company>Synnotech AG</Company>
<Copyright>Copyright © Synnotech AG 2021</Copyright>
<Version>6.0.0</Version>
<Version>7.0.0</Version>
<LangVersion>10.0</LangVersion>
<Nullable>enable</Nullable>
</PropertyGroup>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@

<PropertyGroup>
<PackageReleaseNotes>
Synntech.Linq2Db.MsSqlServer 6.0.0
Synntech.Linq2Db.MsSqlServer 7.0.0
--------------------------------

- added support for linq2db 3.4.5
- the AsyncReadOnlySession can now have a transaction (breaking change)
- added support for linq2db 4.2
- there is now a dedicated framework target for .NET 4.6.2, to avoid MissingMethodExceptions for DataConnection.DisposeAsync
- the IInitializeAsync infrastructure from Synnotech.Core is now used instead of the old custom one
- see all docs at https://github.com/Synnotech-AG/Synnotech.Linq2Db
</PackageReleaseNotes>
</PropertyGroup>
Expand Down
10 changes: 5 additions & 5 deletions Code/src/Synnotech.Linq2Db.MsSqlServer/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
*Extensions for Linq2Db that target Microsoft SQL Server*

[![License](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)](https://github.com/Synnotech-AG/Synnotech.Linq2Db/blob/main/LICENSE)
[![NuGet](https://img.shields.io/badge/NuGet-6.0.0-blue.svg?style=for-the-badge)](https://www.nuget.org/packages/Synnotech.Linq2Db.MsSqlServer/)
[![NuGet](https://img.shields.io/badge/NuGet-7.0.0-blue.svg?style=for-the-badge)](https://www.nuget.org/packages/Synnotech.Linq2Db.MsSqlServer/)

# How to install

Synnotech.Linq2Db.MsSqlServer is compiled against [.NET Standard 2.0 and 2.1](https://docs.microsoft.com/en-us/dotnet/standard/net-standard) and thus supports all major plattforms like .NET 5, .NET Core, .NET Framework 4.6.1 or newer, Mono, Xamarin, UWP, or Unity.
Synnotech.Linq2Db.MsSqlServer is compiled against [.NET Standard 2.0 and 2.1](https://docs.microsoft.com/en-us/dotnet/standard/net-standard) and .NET Framework 4.6.2, thus supporting all major plattforms like .NET 6, .NET Core, .NET Framework 4.6.2 or newer, Mono, Xamarin, UWP, or Unity.

Synnotech.Linq2Db.MsSqlServer is available as a [NuGet package](https://www.nuget.org/packages/Synnotech.Linq2Db.MsSqlServer/) and can be installed via:

- **Package Reference in csproj**: `<PackageReference Include="Synnotech.Linq2Db.MsSqlServer" Version="6.0.0" />`
- **Package Reference in csproj**: `<PackageReference Include="Synnotech.Linq2Db.MsSqlServer" Version="7.0.0" />`
- **dotnet CLI**: `dotnet add package Synnotech.Linq2Db.MsSqlServer`
- **Visual Studio Package Manager Console**: `Install-Package Synnotech.Linq2Db.MsSqlServer`

Expand Down Expand Up @@ -60,10 +60,10 @@ Please note: the configuration is only loaded once during startup. If you change

`AddLinq2DbForSqlServer` has several optional parameters that you can supply:

- `createMappings`: a delegate that can be used to configure the Linq2DB mapping schema. You do not need to provide this delegate when you use attributes on your data access model classes. However, we highly encourage you to not use attributes but use a single method were you define the mapping configuration (this makes it easier to customize or replace the data access layer).
- `mappingSchema`: an instance of Linq2DB mapping schema. You do not need to provide this instance when you use attributes on your data access model classes. However, we highly encourage you to not use attributes but use a single method were you define the mapping configuration (this makes it easier to customize or replace the data access layer).
- `sqlServerProvider`: the enum value that indicates whether you want to use `Microsoft.Data.SqlClient` or `System.Data.SqlClient` as the underlying data provider. We recommend to use the former one (unless you have issues with it, e.g. when you want to use [spatial types or SqlHierarchyId]()) as it will receive updates more frequently. `System.Data.SqlClient` is part of the .NET Base Class Library.
- `configurationSectionName`: the section name that is used to retrieve the `Linq2DbSettings` from the `IConfiguration` instance already registered with the DI container. The default value is "database".
- `dataConnectionLifetime`: the enumeration value indicating the service lifetime for `DataConnection`. The default value is `ServiceLifetime.Transient`.
- `registerFactoryDelegateForDataConnection`: the value indicating whether a `Func<DataConnection>` should be registered with the DI Container. The default value is `true`. You can set this value to false if you use a proper DI container like [LigthInject](https://github.com/seesharper/LightInject) that supports [Function Factories](https://www.lightinject.net/#function-factories).
- `registerFactoryDelegateForDataConnection`: the value indicating whether a `Func<DataConnection>` should be registered with the DI Container. The default value is `true`. You can set this value to false if you use a proper DI container like [LigthInject](https://github.com/seesharper/LightInject) that supports [Function Factories](https://www.lightinject.net/#function-factories), or null when you want to configure this via `ContainerSettingsContext.Settings`.

If you don't want to use `AddLinq2DbForSqlServer`, you might still want to reuse its internal functionality. Just take a look at the source code of `Linq2DbSettings`, `CreateSqlServerDataProvider`, `CreateLinq2DbConnectionOptions`, and `LogLinq2DbMessage`.
7 changes: 4 additions & 3 deletions Code/src/Synnotech.Linq2Db/Synnotech.Linq2Db.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@

<PropertyGroup>
<PackageReleaseNotes>
Synntech.Linq2Db 6.0.0
Synntech.Linq2Db 7.0.0
--------------------------------

- added support for linq2db 3.4.5
- the AsyncReadOnlySession can now have a transaction (breaking change)
- added support for linq2db 4.2
- there is now a dedicated framework target for .NET 4.6.2, to avoid MissingMethodExceptions for DataConnection.DisposeAsync
- the IInitializeAsync infrastructure from Synnotech.Core is now used instead of the old custom one
- see all docs at https://github.com/Synnotech-AG/Synnotech.Linq2Db
</PackageReleaseNotes>
</PropertyGroup>
Expand Down
4 changes: 2 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@


[![License](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)](https://github.com/Synnotech-AG/Synnotech.Linq2Db/blob/main/LICENSE)
[![NuGet](https://img.shields.io/badge/NuGet-6.0.0-blue.svg?style=for-the-badge)](https://www.nuget.org/packages?q=Synnotech.Linq2Db/)
[![NuGet](https://img.shields.io/badge/NuGet-7.0.0-blue.svg?style=for-the-badge)](https://www.nuget.org/packages?q=Synnotech.Linq2Db/)

# How to install

The Synnotech.Linq2Db packages are compiled against [.NET Standard 2.0 and 2.1](https://docs.microsoft.com/en-us/dotnet/standard/net-standard) and thus supports all major plattforms like .NET 5, .NET Core, .NET Framework 4.6.1 or newer, Mono, Xamarin, UWP, or Unity.
The Synnotech.Linq2Db packages are compiled against [.NET Standard 2.0 and 2.1](https://docs.microsoft.com/en-us/dotnet/standard/net-standard)and .NET Framework 4.6.2, thus supporting all major plattforms like .NET 6, .NET Core, .NET Framework 4.6.2 or newer, Mono, Xamarin, UWP, or Unity.

There are several packages available:

Expand Down

0 comments on commit c5e0aae

Please sign in to comment.