SQLWrapper 2.0.1

Author: DAIKOZ

CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+## [2.0.1] (2024-04-12)
+
+### SQLWrapper
+- Order caseinsentive input SQL variables.
+- Enhance display warning message
+- MariaDB/MySQL: Fix UNION column checking with BOOL, INT, INTEGER type
+
+### Daikoz.SQLWrapper NuGet Package
+- Visual Studio can generate wrapper in background
+- Fix compilation error after clean the project, the generated source is now added to compile process. Don't need to build again the project.
+- Enhance display warning message
+- Update readme.md
+
+### Template
+- **C# Helper**: Use int type for length or long instead of uint to avoid int cast with index of string function.
+- **C# Helper**: Rename SQLWrapper::UpdateIfModified to SQLWrapperHelper::UpdateIfModified method and move it in same namespace to avoid warning this Daikoz.SQLWrapper NuGet package.
+- **C# Helper**: Fix tab/space mix
+- **C# Helper**: Fix spaces

Daikoz.SQLWrapper/Daikoz.SQLWrapper.csproj

@@ -11,9 +11,9 @@
 		<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
 		<PackageIcon>sqlwrapper.png</PackageIcon>
 		<Title>SQL Wrapper Generator</Title>
-		<Version>2.0.0</Version>
-		<AssemblyVersion>2.0.0</AssemblyVersion>
-		<FileVersion>2.0.0</FileVersion>
+		<Version>2.0.1</Version>
+		<AssemblyVersion>2.0.1</AssemblyVersion>
+		<FileVersion>2.0.1</FileVersion>
 		<Authors>DAIKOZ</Authors>
 		<Description>SQLWrapper makes it easier to create code wrappers for SQL queries. It's a powerful tool that helps speed up development by reducing the need for manual coding. It works with databases various SQL database (MySQL, MariaDB, ...), checking the syntax and performance of SQL queries before you execute them.
 
@@ -28,10 +28,27 @@ Overall, DAIKOZ.SQLWrapper is a handy tool for making SQL code easier to work wi
 		<RepositoryUrl>https://github.com/daikoz/SQLWrapper</RepositoryUrl>
 		<RepositoryType>github</RepositoryType>
 		<PackageTags>sql;wrapper;sqlwrapper;ORM;dapper;linq;database;mysql;mariadb;server;mssql;pgsql;sqlite;postgres;postgresql;query;builder</PackageTags>
-		<PackageReleaseNotes>Version 2.0.0: 
-- increase performance to generate code from sql query
-- Add MariaDB database
-- Genere code under each sql file</PackageReleaseNotes>
+		<PackageReleaseNotes># Changelog
+
+## [2.0.1] (2024-04-12)
+
+### SQLWrapper
+- Order caseinsentive input SQL variables.
+- Enhance display warning message
+- MariaDB/MySQL: Fix UNION column checking with BOOL, INT, INTEGER type
+
+### Daikoz.SQLWrapper NuGet Package
+- Visual Studio can generate wrapper in background
+- Fix compilation error after clean the project, the generated source is now added to compile process. Don't need to build again the project.
+- Enhance display warning message
+- Update readme.md
+
+### Template
+- **C# Helper**: Use int type for length or long instead of uint to avoid int cast with index of string function.
+- **C# Helper**: Rename SQLWrapper::UpdateIfModified to SQLWrapperHelper::UpdateIfModified method and move it in same namespace to avoid warning this Daikoz.SQLWrapper NuGet package.
+- **C# Helper**: Fix tab/space mix
+- **C# Helper**: Fix spaces
+</PackageReleaseNotes>
 		<PackageLicenseFile>license.txt</PackageLicenseFile>
 		<PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
 
@@ -75,4 +92,8 @@ Overall, DAIKOZ.SQLWrapper is a handy tool for making SQL code easier to work wi
 		</EmbeddedResource>
 	</ItemGroup>
 
+	<Target Name="CopyReadme" BeforeTargets="BeforeBuild">
+		<Copy SourceFiles="..\..\..\SQLWrapper\README.md" DestinationFolder="$(MSBuildProjectDirectory)" />
+	</Target>
+
 </Project>

Daikoz.SQLWrapper/SQLWrapperLauncher.cs

@@ -1,6 +1,7 @@
 using Microsoft.Build.Framework;
 using Microsoft.Build.Utilities;
 using System;
+using System.Collections.Generic;
 using System.Diagnostics;
 using System.Globalization;
 using System.IO;
@@ -13,6 +14,8 @@ namespace Daikoz.SQLWrapper
 {
     public class SQLWrapperLauncher
     {
+        public List<string> GeneratedSources { get; set; } = [];
+
         private readonly string _ConfigurationFilePath;
         private readonly string _RootNamespace;
         private readonly DateTime _ConfigurationModifiedDate;
@@ -155,7 +158,36 @@ private void StartProcess(string arguments, string logCategory, string logFile)
             if (!string.IsNullOrWhiteSpace(standartOutput))
             {
                 LogMessage("Output [" + Environment.NewLine + standartOutput + ']');
-                _Log.LogWarning(logCategory, "", "", logFile, 0, 0, 0, 0, standartOutput, null);
+                int lineNumber = 0;
+                int columnNumber = 0;
+                string code = string.Empty;
+                string error = string.Empty;
+                string errorLogFile = logFile;
+
+                Match match = _RegexSQLWrapperErrorSQL.Match(standartOutput);
+                if (match.Success)
+                {
+                    errorLogFile = match.Groups["filepath"].Value;
+                    lineNumber = int.Parse(match.Groups["line"].Value, CultureInfo.InvariantCulture);
+                    columnNumber = int.Parse(match.Groups["position"].Value, CultureInfo.InvariantCulture);
+                    code = match.Groups["code"].Value.TrimStart();
+                    error = match.Groups["message"].Value.TrimStart();
+
+                    _Log.LogWarning(logCategory, code, "", errorLogFile, lineNumber, columnNumber, 0, 0, error.Trim(), null);
+                }
+                else
+                {
+                    match = _RegexSQLWrapperErrorLog.Match(standartOutput);
+                    if (match.Success)
+                    {
+                        code = match.Groups["code"].Value.TrimStart();
+                        error = match.Groups["message"].Value.TrimStart();
+
+                        _Log.LogWarning(logCategory, code, "", logFile, 0, 0, 0, 0, error.Trim(), null);
+                    }
+                    else
+                        _Log.LogWarning(logCategory, "", "", logFile, 0, 0, 0, 0, standartOutput, null);
+                }
             }
 
             // Read error
@@ -321,6 +353,8 @@ private void GenerateHelper(Helper helper)
                         return;
                     }
                 }
+                else
+                    GeneratedSources.Add(outputFilePath);
 
                 // Generate
                 LogMessage(string.Format("Generate Helper for database {0} ('{1}') with XSLT '{2}': '{3}'", helper.Database, databaseFilePath, xlstFilePath, outputFilePath));
@@ -420,6 +454,8 @@ private void GenerateWrapper(Wrapper wrapper)
                             continue;
                         }
                     }
+                    else
+                        GeneratedSources.Add(outputFilePath);
 
                     // Generate
                     LogMessage(string.Format("Generate wrapper: '{0}'", sqlFilePath));

Daikoz.SQLWrapper/SQLWrapperTask.cs

@@ -5,12 +5,16 @@
 
 namespace Daikoz.SQLWrapper
 {
-    public class SQLWrapperTask : Task, ITask
+    public class SQLWrapperTask : Task
     {
         public string? ConfigurationFilePath { get; set; }
         public string RootNamespace { get; set; } = "Daikoz.SQLWrapper";
         public bool IsCleanning { get; set; }
 
+        [Output]
+        public string[] GeneratedSources { get; set; } = [];
+
+
         public override bool Execute()
         {
             // System.Diagnostics.Debugger.Launch();
@@ -29,7 +33,9 @@ public override bool Execute()
                 }
 
                 Daikoz.SQLWrapper.SQLWrapperLauncher sqlWrapper = new(ConfigurationFilePath, RootNamespace, Log, IsCleanning);
-                return sqlWrapper.Execute();
+                bool result = sqlWrapper.Execute();
+                GeneratedSources = [.. sqlWrapper.GeneratedSources];
+                return result;
             }
             catch (Daikoz.SQLWrapper.SQLWrapperException ex)
             {

Daikoz.SQLWrapper/build/Daikoz.SQLWrapper.targets

@@ -34,8 +34,13 @@
 	-->
 	<UsingTask TaskName="Daikoz.SQLWrapper.SQLWrapperTask" AssemblyFile="..\lib\netstandard2.0\Daikoz.SQLWrapper.dll" />
 
-	<Target Name="SQLWrapperBuild" BeforeTargets="BeforeBuild" >
-		<Daikoz.SQLWrapper.SQLWrapperTask ConfigurationFilePath="$(MSBuildProjectDirectory)\sqlwrapper.json" IsCleanning="false" RootNamespace="$(RootNamespace)" />
+	<Target Name="SQLWrapperBuild" BeforeTargets="CoreCompile">
+		<Daikoz.SQLWrapper.SQLWrapperTask ConfigurationFilePath="$(MSBuildProjectDirectory)\sqlwrapper.json" IsCleanning="false" RootNamespace="$(RootNamespace)">
+			<Output TaskParameter="GeneratedSources" ItemName="GeneratedSources" />
+		</Daikoz.SQLWrapper.SQLWrapperTask>
+		<ItemGroup>
+			<Compile Include="@(GeneratedSources)" />
+		</ItemGroup>
 	</Target>
 
 	<Target Name="SQLWrapperClean" AfterTargets="BeforeClean">

Daikoz.SQLWrapper/readme.md

@@ -1,16 +1,26 @@
-SQLWrapper makes it easier to create code wrappers for SQL queries. It's a powerful tool that helps speed up development by reducing the need for manual coding. It works with databases various SQL database (MySQL, MariaDB, ...), checking the syntax and performance of SQL queries before you execute them.
+SQLWrapper makes it easier to create code wrappers for SQL queries. It's a powerful tool that helps speed up development by reducing the need for manual coding. It works with databases various SQL database (MySQL, MariaDB, ...), checking the syntax and performance of SQL queries before you execute them.
 
 It's important to note that SQLWrapper isn't like other tools that map objects to database tables (ORMs). Instead, it directly generates code from your SQL queries and database structure, which performs better than tools like LINQ, EntityFramework, dapper, ... and doesn't have the same limitations.
 
 One feature is that it can look at your database's structure to check if your SQL queries are correct, and it can create an XML file listing all the data your queries need and return. Then, you can use XSLT templates to turn that XML into code in languages like C#, and more.
 
 Overall, SQLWrapper is a handy tool for making SQL code easier to work with, saving time, and helping you write better code.
 
+## Links
+* [Change log](https://github.com/daikoz/SQLWrapper/blob/master/CHANGELOG.md)
+* [Official website](https://www.sqlwrapper.com)
+* [Package .NET](https://www.nuget.org/packages/Daikoz.SQLWrapper/)
+* [Documentation](https://github.com/daikoz/SQLWrapper/wiki)
+* [Issues/Bugs](https://github.com/daikoz/SQLWrapper/issues)
+* [Videos](https://www.youtube.com/@SQLWrapper)
+* [Facebook](https://www.facebook.com/sqlwrapper/)
+* [Twitter](https://twitter.com/sqlwrapper)
+
 ## Getting started with package NuGet Daikoz.SQLWrapper
 
 **Video of demonstration:**
 
-[![Watch the video](https://img.youtube.com/vi/xEeWnESZki0/hqdefault.jpg)](https://www.youtube.com/watch?v=xEeWnESZki0)
+[![Watch the video](https://raw.githubusercontent.com/daikoz/SQLWrapper/master/img/video.jpg)](https://www.youtube.com/watch?v=xEeWnESZki0)
 
 The .NET package NuGet [Daikoz.SQLWrapper](https://www.nuget.org/packages/Daikoz.SQLWrapper) integrate SQLWrapper in build process of our .NET project.
 
@@ -85,14 +95,124 @@ To start, follow a minimal configuration file. Modify HOSTNAME, USERID, PASSWORD
 * A database helper if generate in file MyDataseHelper.cs
 * For each *.sql, a wrapper is generated
 
+
 ## Getting started with command line SQLWrapper
 
-## Links
-* [Official web](https://www.sqlwrapper.com)
-* [Package .NET](https://www.nuget.org/packages/Daikoz.SQLWrapper/)
-* [Documentation](https://github.com/daikoz/SQLWrapper/wiki)
-* [Issues/Bugs](https://github.com/daikoz/SQLWrapper/issues)
-* [Videos](https://www.youtube.com/@SQLWrapper)
-* [Reddit](https://www.reddit.com/r/sqlwrapper/)
-* [Facebook](https://www.facebook.com/sqlwrapper/)
-* [Twitter](https://twitter.com/sqlwrapper)
+SQLWrapper can be use in console.
+
+### Database
+
+First, extract and cache database structure in XML File:
+
+``` dos
+>SQLWrapper help database
+SQL Wrapper Generator
+Copyright (C) DAIKOZ. All rights reserved.
+USAGE:
+Extract and cache database structure in XML file:
+  SQLWrapper database --connectionstring "server=servernamedb;user id=userid;password='password';database=db1" --outputfile sqlwrapper-cachedb.xml --type mariadb --verbose
+
+  -t, --type                Required. Type of database: mysql, mariadb.
+
+  -c, --connectionstring    Required. List of .net database connection string (https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/connection-string-syntax).
+
+  -o, --outputfile          Output XML file (default: stdout).
+
+  -v, --verbose             Set output to verbose messages.
+
+  --help                    Display this help screen.
+
+  --version                 Display version information.
+```
+
+**Example:**
+
+``` dos
+SQLWrapper database --connectionstring "server=servernamedb;user id=userid;password='password';database=db1" --outputfile sqlwrapper-cachedb.xml --type mariadb --verbose
+```
+
+This command connect to **database** of **type** with connection information **connectionstring**. The output is written in **outputfile**.
+
+### Wrapper
+
+Generate the wrapper source code from SQL queries:
+
+``` dos
+>SQLWrapper help wrapper
+SQL Wrapper Generator
+Copyright (C) DAIKOZ. All rights reserved.
+USAGE:
+Generate code from sql request:
+  SQLWrapper wrapper --database sqlwrapper-cachedb.xml --inputfiles request1.mysql request2.mysql --outputfile mysqlrequest.cs --params namespace=DAIKOZ classname=SQLWrapper --xslt Template\CSharp\charpADO.xslt
+
+  -d, --database       Required. XML file of cache database structure to load. Generate it before with database command
+
+  -i, --inputfiles     Required. SQL files. Relative or full path. wildcard * is supported for filename.
+
+  -o, --outputfile     Output file
+
+  -p, --params         XLST Parameters
+
+  -t, --customtypes    Force custom type for database field (table.col=MyEmu
+
+  -x, --xslt           XSLT file path to transform XML output.
+
+  -v, --verbose        Set output to verbose messages.
+
+  --help               Display this help screen.
+
+  --version            Display version information.
+```
+
+**Example:**
+
+``` dos
+SQLWrapper wrapper --database sqlwrapper-cachedb.xml --inputfiles request1.mysql request2.mysql --outputfile mysqlrequest.cs --params namespace=DAIKOZ classname=SQLWrapper --xslt Template\CSharp\charpADO.xslt
+```
+
+This command create a **wrapper** from **database** for 2 queries defined in **inputfiles**. It use the **XSLT** file to generate the **outputfile**. **params** give parameters defined in **XLST** file (here the namespace).
+
+### Helper
+
+Generate a source code helper to help the access to database. For example: the length of all text columns.
+
+``` dos
+>SQLWrapper help helper
+SQL Wrapper Generator
+Copyright (C) DAIKOZ. All rights reserved.
+USAGE:
+Generate code helper to access database:
+  SQLWrapper helper --database sqlwrapper-cachedb.xml --outputfile helper.cs --xslt Template\CSharp\helper.xslt
+
+  -d, --database       Required. XML file of cache database structure to load. Generate it before with database command
+
+  -o, --outputfile     Output file
+
+  -p, --params         XLST Parameters
+
+  -t, --customtypes    Force custom type for database field (table.col=MyEmu
+
+  -x, --xslt           XSLT file path to transform XML output.
+
+  -v, --verbose        Set output to verbose messages.
+
+  --help               Display this help screen.
+
+  --version            Display version information.
+```
+
+**Example:**
+
+``` dos
+SQLWrapper helper --database sqlwrapper-cachedb.xml --outputfile helper.cs --xslt Template\CSharp\helper.xslt
+```
+
+This command create a **helper** for **database**. It use **XLST** file to generate the **outputfile**.
+
+
+## Template XLST
+
+In template section, you can found several XLST files to generate wrappers and helpers in several programming language.
+You can create or modify your own and use it with **--xslt** parameter.
+
+