Give a folder its own settings, or leave files out
Give one folder its own settings, leave a folder of migration scripts out, or write one class for a whole folder.
Use this when the .sql files of one folder need other settings than the rest of the project. Use it too when a folder holds .sql files that are not queries, such as migration scripts.
Configure one folder differently
A project reads its .sql files as PostgreSQL and keeps the comments of its queries. One folder, Legacy/, holds MySQL files. Their queries take token fragments that are sometimes empty, so the folder turns the token check off. A settings file in a folder gives it its own settings:
// sqlsource.json, in the project's folder
{
"root": true,
"dialect": "postgres",
"generatorParameters": ["keep-comments"],
}
// Legacy/sqlsource.json
{
"dialect": "mysql",
"generatorParameters": ["token-validation=off"],
}
What you get. SqlSource reads every file under Legacy/ as mysql. Those files keep their comments and skip the token check. Every other file is unchanged: SqlSource reads it as postgres, and it keeps its comments and checks its tokens.
The rules you need.
- The folder's list of generator parameters adds to the project's list. So the files of
Legacy/keep their comments, though the folder's list names onlytoken-validation=off. See generator parameters. - To drop the project's list, start the folder's list with
default.["default", "token-validation=off"]givesLegacy/every default but the token check. See which place wins. - The dialect takes the nearest value whole. If the project's file sets
"mysql,ansi-quotes"as its dialect, SqlSource still reads this folder as plainmysql. See dialect. - A
-- generator:line in one of the files adds its words to the list of both settings files. A-- generator: defaultline drops that list. See which place wins. - The file in
Legacy/applies to the.sqlfiles of its subfolders too, such asLegacy/Reports/. It applies there unless a settings file nearer to them sets the same setting. - A settings file can give only the settings whose row in the table lists a settings file.
- To change a setting for one file, write its marker in the file header. The marker wins over every settings file, so a
-- dialect: mariadbline overrides both of them. See which place wins.
Leave migration scripts out
App/
App.csproj
Queries/
UserRepository.cs [SqlSourceGenerate] on UserRepository
UserRepository.sql belongs to UserRepository
Migrations/
001_create_users.sql not claimed by any type
What you get. No type claims 001_create_users.sql, so SqlSource ignores it. A folder of migration scripts beside your queries does no harm.
To keep the scripts away from the compiler altogether, remove them from the files that the package hands it:
<ItemGroup>
<AdditionalFiles Remove="Migrations/**/*.sql" />
</ItemGroup>
The rules you need.
- SqlSource ignores a
.sqlfile that no[SqlSourceGenerate]type claims. A type claims the file named for it, or the files that itsSourcenames. See which files belong to a type. - The package hands every
.sqlfile under the project's folder to the compiler. AnAdditionalFilesitem withRemovetakes files out of that list. See which.sqlfiles are included.
One class for a whole folder
If you want one class for every .sql file of a folder, and not one class for each file, write Source = "." on the class:
sqlsource.json "root": true, "dialect": "postgres"
Models/
sqlsource.json "output": "models"
StoreQueries.cs [SqlSourceGenerate(Source = ".")] on StoreQueries
Orders.sql belongs to StoreQueries
Users.sql belongs to StoreQueries
// Models/sqlsource.json
{
"output": "models",
}
// Models/StoreQueries.cs
using System.Data.Common;
using System.Threading.Tasks;
using Dapper;
using SqlSource;
[SqlSourceGenerate(Source = ".")]
public sealed partial class StoreQueries(DbConnection connection)
{
public Task<GetOrderDto?> GetOrderAsync(int orderId) =>
connection.QuerySingleOrDefaultAsync<GetOrderDto>(Sql.GetOrder, new GetOrderParams(orderId));
}
What you get. StoreQueries gets the queries of Orders.sql and Users.sql. The folder's settings file sets the output models, so each query gets its models and a constant in the class Sql. For the query GetOrder of Orders.sql, these are GetOrderParams, GetOrderDto and Sql.GetOrder. The class runs the SQL itself, here through Dapper: see Use Dapper or your own ADO.NET code.
The rules you need.
Source = "."gives the class each.sqlfile in the folder of its C# file. Subfolders are not searched. See Source.- A query name can be used once across all the files of a class. See Which files belong to a type.
- Every setting of a query comes from its
.sqlfile and the settings files of its folder and the folders above it, not from the class. The folder of the C# file counts only when it is one of those folders, as withSource = "Queries". See The attribute. - Write
Sourceas a string where the attribute is. The tool reads the attribute as text, so it cannot read a constant ornameofthere. SeeSourcewritten as text.
If it does not work
- SQLSRC004.
Sourcematches no.sqlfile. Write the path from the folder of the C# file, not from the project. See SQLSRC004. - SQLSRC008. Two files of the folder have a query of one name. Rename one of the queries. See SQLSRC008.
- SQLSRC208, and SQLSRC241 for each query of the class.
Sourceis a constant,nameofor another expression. Write the string where the attribute is. SeeSourcewritten as text.