sdmap 0.17.0

dotnet add package sdmap --version 0.17.0
NuGet\Install-Package sdmap -Version 0.17.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="sdmap" Version="0.17.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add sdmap --version 0.17.0
#r "nuget: sdmap, 0.17.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install sdmap as a Cake Addin
#addin nuget:?package=sdmap&version=0.17.0

// Install sdmap as a Cake Tool
#tool nuget:?package=sdmap&version=0.17.0

sdmap NuGet

A template engine for writing dynamic sql: vstool

sdmap has it's own benifics over other dynamic SQL package/framework (like iBatis.NET):

  • Very simple Domain-Specific-Language(or DSL) to enhance the dynamic SQL expression
  • Implemented by Common-Intermediate-Language(or CIL) to ensure the performance
  • Visual Studio integrated, with code-highlight, code-folding and navigate-to features supported
  • Support all majoy databases like MySQL, SQL Server, SQLite (whenever Dapper supports 😃)
  • Even is able to extend to databases that is not relational, like Neo4j
  • Fully unit test covered.

NuGet Package:

How to use? (with Dapper)

  1. Install package: sdmap.ext.Dapper

You can just only install sdmap.ext.Dapper since it will automatically install all dependencies including sdmap and sdmap.ext.

  1. Create a empty text file, and renames it into .sdmap
  2. Set the file "Build operation" from "None" to "Embedded Resource" in item Property Window.
  3. Write some SQL statements into sdmap file, a minimum sdmap file may looks as following:
sql GetUserById
{
    SELECT * FROM [User] WHERE Id = @Id
}

Note: the namespace NS { ... } is not required.

  1. Initialize sdmap by this code(the Program means the assembly where sdmap be located):
DbConnectionExtensions.SetEmbeddedSqlAssembly(typeof(Program).Assembly);

Note:

  • This code MUST be running before any database operations.
  • This code ONLY need to execute ONCE per process.
  • There are many other ways to initialize sdmap, you SHOULD pick up one of those depending on what you need:
    • SetSqlDirectory - initialize from a physical on-disk folder
    • SetSqlDirectoryAndWatch - initialize from a physical on-disk folder, and watch changes when edit those folder sdmap files
    • SetEmbeddedSqlAssembly - initialize from a single assembly, and sdmap automatically parse all the resource file that ends with .sdmap
    • SetEmbeddedSqlAssemblies - initialize from multiple assemblies, and sdmap automatically parse all the resource file that ends with .sdmap
    • SetSqlEmiter - advanced, you can write your own ISdmapEmiter.
  1. And you're good to go!
  2. If you want to emit the SQL statement manully, you may want to call:
string finalSqlToExecute = DbConnectionExtensions.EmitSql(sqlMapId, parameterObject);

Visual Studio 2022 extension:

https://marketplace.visualstudio.com/items?itemName=sdmapvstool.sdmapvstool

How to Compile

  1. Install .NET Core SDK(https://www.microsoft.com/net/download/core)
  2. Download code(git clone https://github.com/sdcb/sdmap.git)
  3. JRE 1.6+ is preferred for building performance purpose but not required
  4. dotnet restore
  5. dotnet build

Release notes:

https://github.com/sdcb/sdmap/blob/master/ReleaseNotes.md

Document/Wiki

https://github.com/sdcb/sdmap/wiki

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on sdmap:

Package Downloads
sdmap.ext

Useful extensions for sdmap/Dapper.

GenApp.Shared

Package Description

ibatis2sdmap

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.17.0 1,873 12/22/2023
0.16.5 209 8/31/2023
0.16.3 6,810 8/13/2021
0.16.2 3,909 7/10/2019
0.16.1 17,009 6/6/2019
0.16.0 1,032 6/5/2019
0.15.0 1,041 12/6/2018
0.14.2 1,233 4/17/2018
0.14.1 1,144 4/8/2018
0.14.0.1 1,099 4/8/2018
0.14.0 1,044 4/3/2018
0.13.1.1 1,056 3/13/2018
0.13.1 952 3/13/2018
0.13.0 1,349 3/5/2018
0.12.0.5 1,383 2/1/2018
0.11.7 930 1/18/2018
0.11.5 1,798 8/15/2017
0.11.0 1,558 7/31/2017
0.10.8 1,236 7/20/2017
0.10.6 1,449 7/12/2017
0.10.0 1,648 3/17/2017
0.9.1 1,378 2/13/2017
0.9.0 1,388 1/11/2017
0.8.2 1,380 12/30/2016
0.8.1 1,402 12/29/2016
0.8.0 1,378 12/28/2016
0.7.1 1,405 12/20/2016
0.5.0 1,641 12/16/2016
0.4.0 1,380 11/11/2016