[
{
"path": ".gitattributes",
"content": "# Auto detect text files and perform LF normalization\n* text=auto\n\n# Custom for Visual Studio\n*.cs diff=csharp\n*.sln merge=union\n*.csproj merge=union\n*.vbproj merge=union\n*.fsproj merge=union\n*.dbproj merge=union\n\n# Standard to msysgit\n*.doc\t diff=astextplain\n*.DOC\t diff=astextplain\n*.docx diff=astextplain\n*.DOCX diff=astextplain\n*.dot diff=astextplain\n*.DOT diff=astextplain\n*.pdf diff=astextplain\n*.PDF\t diff=astextplain\n*.rtf\t diff=astextplain\n*.RTF\t diff=astextplain\n"
},
{
"path": ".github/FUNDING.yml",
"content": "# These are supported funding model platforms\n\ngithub: maxtoroq\n"
},
{
"path": ".gitignore",
"content": "/.vs/\n/.nuget/\n/packages/\n/docs/api/_toc.xml\n\n[Bb]in\n[Oo]bj\n[Tt]est[Rr]esults\n*.suo\n*.user\n"
},
{
"path": ".gitmodules",
"content": "[submodule \"build/sandcastle-md\"]\n\tpath = build/sandcastle-md\n\turl = https://github.com/maxtoroq/sandcastle-md.git\n"
},
{
"path": "CHANGES.md",
"content": "This page has moved [here](https://maxtoroq.github.io/DbExtensions/docs/7/changes.html)."
},
{
"path": "DbExtensions.sln",
"content": "\nMicrosoft Visual Studio Solution File, Format Version 12.00\n# Visual Studio Version 17\nVisualStudioVersion = 17.11.35222.181\nMinimumVisualStudioVersion = 10.0.40219.1\nProject(\"{9A19103F-16F7-4668-BE54-9A1E7A4F7556}\") = \"DbExtensions\", \"src\\DbExtensions\\DbExtensions.csproj\", \"{0C0CB7A6-FDBA-49A0-8FA9-A35EFFFDE34D}\"\nEndProject\nProject(\"{2150E333-8FDC-42A3-9474-1A3956D46DE8}\") = \"src\", \"src\", \"{0CD55BAA-00D6-4D14-AF01-B2ECC3F8E092}\"\nEndProject\nProject(\"{2150E333-8FDC-42A3-9474-1A3956D46DE8}\") = \"tests\", \"tests\", \"{CDC6A939-6F5A-4CF5-ABDB-A2F87513A769}\"\nEndProject\nProject(\"{9A19103F-16F7-4668-BE54-9A1E7A4F7556}\") = \"DbExtensions.Tests\", \"tests\\DbExtensions.Tests\\DbExtensions.Tests.csproj\", \"{ABB8412B-D292-4393-BB6D-F0241C41D198}\"\nEndProject\nProject(\"{2150E333-8FDC-42A3-9474-1A3956D46DE8}\") = \"samples\", \"samples\", \"{A1718337-F793-499A-A4D1-5A6CF5F265DA}\"\nEndProject\nProject(\"{9A19103F-16F7-4668-BE54-9A1E7A4F7556}\") = \"Samples.CSharp\", \"samples\\CSharp\\Samples.CSharp.csproj\", \"{CC01AB1C-A3CD-4E56-9AF0-8E4FD2000CE0}\"\nEndProject\nProject(\"{9A19103F-16F7-4668-BE54-9A1E7A4F7556}\") = \"Samples.App\", \"samples\\App\\Samples.App.csproj\", \"{0ECA5137-1C9A-46BB-B5EB-ED87F0678FB4}\"\nEndProject\nProject(\"{9A19103F-16F7-4668-BE54-9A1E7A4F7556}\") = \"DbExtensions.SqlBuilder\", \"src\\DbExtensions.SqlBuilder\\DbExtensions.SqlBuilder.csproj\", \"{07B53903-2EB1-4E69-98A2-84069197ADB2}\"\nEndProject\nProject(\"{9A19103F-16F7-4668-BE54-9A1E7A4F7556}\") = \"DbExtensions.SqlSet\", \"src\\DbExtensions.SqlSet\\DbExtensions.SqlSet.csproj\", \"{75C3AEF3-213C-494A-97FA-D4DCA76FA94A}\"\nEndProject\nProject(\"{9A19103F-16F7-4668-BE54-9A1E7A4F7556}\") = \"DbExtensions-QE\", \"src\\DbExtensions-QE\\DbExtensions-QE.csproj\", \"{731E7958-87D2-4C2F-9D59-6308D1553F53}\"\nEndProject\nGlobal\n\tGlobalSection(SolutionConfigurationPlatforms) = preSolution\n\t\tDebug|Any CPU = Debug|Any CPU\n\t\tRelease|Any CPU = Release|Any CPU\n\tEndGlobalSection\n\tGlobalSection(ProjectConfigurationPlatforms) = postSolution\n\t\t{0C0CB7A6-FDBA-49A0-8FA9-A35EFFFDE34D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU\n\t\t{0C0CB7A6-FDBA-49A0-8FA9-A35EFFFDE34D}.Debug|Any CPU.Build.0 = Debug|Any CPU\n\t\t{0C0CB7A6-FDBA-49A0-8FA9-A35EFFFDE34D}.Release|Any CPU.ActiveCfg = Release|Any CPU\n\t\t{0C0CB7A6-FDBA-49A0-8FA9-A35EFFFDE34D}.Release|Any CPU.Build.0 = Release|Any CPU\n\t\t{ABB8412B-D292-4393-BB6D-F0241C41D198}.Debug|Any CPU.ActiveCfg = Debug|Any CPU\n\t\t{ABB8412B-D292-4393-BB6D-F0241C41D198}.Debug|Any CPU.Build.0 = Debug|Any CPU\n\t\t{ABB8412B-D292-4393-BB6D-F0241C41D198}.Release|Any CPU.ActiveCfg = Release|Any CPU\n\t\t{ABB8412B-D292-4393-BB6D-F0241C41D198}.Release|Any CPU.Build.0 = Release|Any CPU\n\t\t{CC01AB1C-A3CD-4E56-9AF0-8E4FD2000CE0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU\n\t\t{CC01AB1C-A3CD-4E56-9AF0-8E4FD2000CE0}.Debug|Any CPU.Build.0 = Debug|Any CPU\n\t\t{CC01AB1C-A3CD-4E56-9AF0-8E4FD2000CE0}.Release|Any CPU.ActiveCfg = Release|Any CPU\n\t\t{CC01AB1C-A3CD-4E56-9AF0-8E4FD2000CE0}.Release|Any CPU.Build.0 = Release|Any CPU\n\t\t{0ECA5137-1C9A-46BB-B5EB-ED87F0678FB4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU\n\t\t{0ECA5137-1C9A-46BB-B5EB-ED87F0678FB4}.Debug|Any CPU.Build.0 = Debug|Any CPU\n\t\t{0ECA5137-1C9A-46BB-B5EB-ED87F0678FB4}.Release|Any CPU.ActiveCfg = Release|Any CPU\n\t\t{0ECA5137-1C9A-46BB-B5EB-ED87F0678FB4}.Release|Any CPU.Build.0 = Release|Any CPU\n\t\t{07B53903-2EB1-4E69-98A2-84069197ADB2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU\n\t\t{07B53903-2EB1-4E69-98A2-84069197ADB2}.Debug|Any CPU.Build.0 = Debug|Any CPU\n\t\t{07B53903-2EB1-4E69-98A2-84069197ADB2}.Release|Any CPU.ActiveCfg = Release|Any CPU\n\t\t{07B53903-2EB1-4E69-98A2-84069197ADB2}.Release|Any CPU.Build.0 = Release|Any CPU\n\t\t{75C3AEF3-213C-494A-97FA-D4DCA76FA94A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU\n\t\t{75C3AEF3-213C-494A-97FA-D4DCA76FA94A}.Debug|Any CPU.Build.0 = Debug|Any CPU\n\t\t{75C3AEF3-213C-494A-97FA-D4DCA76FA94A}.Release|Any CPU.ActiveCfg = Release|Any CPU\n\t\t{75C3AEF3-213C-494A-97FA-D4DCA76FA94A}.Release|Any CPU.Build.0 = Release|Any CPU\n\t\t{731E7958-87D2-4C2F-9D59-6308D1553F53}.Debug|Any CPU.ActiveCfg = Debug|Any CPU\n\t\t{731E7958-87D2-4C2F-9D59-6308D1553F53}.Debug|Any CPU.Build.0 = Debug|Any CPU\n\t\t{731E7958-87D2-4C2F-9D59-6308D1553F53}.Release|Any CPU.ActiveCfg = Release|Any CPU\n\t\t{731E7958-87D2-4C2F-9D59-6308D1553F53}.Release|Any CPU.Build.0 = Release|Any CPU\n\tEndGlobalSection\n\tGlobalSection(SolutionProperties) = preSolution\n\t\tHideSolutionNode = FALSE\n\tEndGlobalSection\n\tGlobalSection(NestedProjects) = preSolution\n\t\t{0C0CB7A6-FDBA-49A0-8FA9-A35EFFFDE34D} = {0CD55BAA-00D6-4D14-AF01-B2ECC3F8E092}\n\t\t{ABB8412B-D292-4393-BB6D-F0241C41D198} = {CDC6A939-6F5A-4CF5-ABDB-A2F87513A769}\n\t\t{CC01AB1C-A3CD-4E56-9AF0-8E4FD2000CE0} = {A1718337-F793-499A-A4D1-5A6CF5F265DA}\n\t\t{0ECA5137-1C9A-46BB-B5EB-ED87F0678FB4} = {A1718337-F793-499A-A4D1-5A6CF5F265DA}\n\t\t{07B53903-2EB1-4E69-98A2-84069197ADB2} = {0CD55BAA-00D6-4D14-AF01-B2ECC3F8E092}\n\t\t{75C3AEF3-213C-494A-97FA-D4DCA76FA94A} = {0CD55BAA-00D6-4D14-AF01-B2ECC3F8E092}\n\t\t{731E7958-87D2-4C2F-9D59-6308D1553F53} = {0CD55BAA-00D6-4D14-AF01-B2ECC3F8E092}\n\tEndGlobalSection\n\tGlobalSection(ExtensibilityGlobals) = postSolution\n\t\tSolutionGuid = {96FE150F-41AE-4AB7-AA87-2B8D278F1FF3}\n\tEndGlobalSection\nEndGlobal\n"
},
{
"path": "LICENSE.txt",
"content": "\n Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright [yyyy] [name of copyright owner]\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License."
},
{
"path": "NOTICE.xml",
"content": "\n\n\n DbExtensions \n https://maxtoroq.github.io/DbExtensions/ \n 2009-2025 Max Toro Q. \n Max Toro Q. \n \n \n \n .NET Framework \n https://github.com/Microsoft/referencesource \n Microsoft Corporation \n \n \n \n \n"
},
{
"path": "README.md",
"content": "[DbExtensions][1] — The SQL framework for .NET\n==============================================\nDbExtensions is a data-access framework with a strong focus on **query composition, granularity and code aesthetics**. It supports both POCO and dynamic (untyped) mapping.\n\nSee the [project home][1] and the [documentation][2] for more information.\n\n[](https://ci.appveyor.com/project/maxtoroq/dbextensions/branch/v7)\n\n\n[1]: https://maxtoroq.github.io/DbExtensions/\n[2]: https://maxtoroq.github.io/DbExtensions/docs/7/\n"
},
{
"path": "appveyor.yml",
"content": "image: Visual Studio 2022\n\nbefore_build:\n - cmd: MSBuild -t:restore\n\nversion: '{build}'\n\nbuild:\n verbosity: minimal\n"
},
{
"path": "build/.gitignore",
"content": "/api-docs/\n/EWSoftware.SHFB/\n/EWSoftware.SHFB.*/\n/nupkg/\n"
},
{
"path": "build/DbExtensions.shfbproj",
"content": "\n\n \n $(MSBuildThisFileDirectory)\\EWSoftware.SHFB\\tools\\ \n \n Debug \n AnyCPU \n 2.0 \n {e4c3bd2c-c9c8-4484-bc16-0d4a5f6dfcd3} \n 2017.9.26.0 \n \n Documentation \n Documentation \n Documentation \n \n api-docs\\html\\ \n Documentation \n en-US \n Website \n False \n DbExtensions \n MemberName \n Top \n C# \n False \n DbExtensions \n \n \n \n DbExtensions is a data-access framework with a strong focus on query composition, granularity and code aesthetics. <see cref=\"T:DbExtensions.Database\"/> is the entry point of the <see cref=\"N:DbExtensions\"/> API. \n \n True \n VS2013 \n False \n AboveNamespaces \n OnlyWarningsAndErrors \n False \n .NET Core/.NET Standard/.NET 5.0+ \n False \n False \n False \n AutoDocumentCtors, AutoDocumentDispose \n 2 \n False \n DbExtensions Namespaces \n InheritedMembers, Protected, SealedProtected, NonBrowsable \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n "
},
{
"path": "build/build-docs.ps1",
"content": "param([string]$ProjectName = \"DbExtensions\", [switch]$NoBuildProj, [switch]$XmlOnly)\n\n$ErrorActionPreference = \"Stop\"\nPush-Location (Split-Path $script:MyInvocation.MyCommand.Path)\n\ntry {\n\n $nuget = .\\ensure-nuget.ps1\n\n if (-not (Test-Path EWSoftware.SHFB -PathType Container)) {\n &$nuget install EWSoftware.SHFB -Version 2025.3.22 -ExcludeVersion\n }\n\n if (-not (Test-Path EWSoftware.SHFB.NET -PathType Container)) {\n &$nuget install EWSoftware.SHFB.NET -Version 5.0.0.2 -ExcludeVersion\n }\n\n if (-not $NoBuildProj) {\n MSBuild ..\\src\\$ProjectName\\$ProjectName.csproj /v:minimal /p:Configuration=Release\n }\n\n MSBuild DbExtensions.shfbproj /v:minimal /p:ProjectName=$ProjectName\n\n if (-not $XmlOnly) {\n\n .\\sandcastle-md\\packages\\restore.ps1\n MSBuild sandcastle-md\\sandcastle-md.sln /v:minimal\n\n if (Test-Path ..\\docs\\api -PathType Container) {\n rm ..\\docs\\api -Recurse\n }\n\n sandcastle-md\\src\\sandcastle-md\\bin\\Debug\\sandcastle-md.exe api-docs\\html ..\\docs\\api `\n --remove-assembly-name `\n --remove-assembly-version `\n --exclude-icons\n }\n\n} finally {\n Pop-Location\n}\n"
},
{
"path": "build/ensure-nuget.ps1",
"content": "$ErrorActionPreference = \"Stop\"\nPush-Location (Split-Path $script:MyInvocation.MyCommand.Path)\n\n$nuget = \"..\\.nuget\\nuget.exe\"\n\ntry {\n\n $nugetDir = Split-Path $nuget\n\n if (-not (Test-Path $nugetDir -PathType Container)) {\n md $nugetDir | Out-Null\n }\n\n if (-not (Test-Path $nuget -PathType Leaf)) {\n Write-Host \"Downloading NuGet...\"\n Invoke-WebRequest https://dist.nuget.org/win-x86-commandline/latest/nuget.exe -OutFile $nuget\n }\n\n Resolve-Path $nuget\n\n} finally {\n Pop-Location\n}\n"
},
{
"path": "build/release.ps1",
"content": "param(\n [Parameter(Mandatory=$true)][Version]$AssemblyVersion,\n [Parameter(Mandatory=$true)][Version]$PackageVersion,\n [Parameter()][string]$PreRelease\n)\n\n$ErrorActionPreference = \"Stop\"\nPush-Location (Split-Path $script:MyInvocation.MyCommand.Path)\n\n$solutionPath = Resolve-Path ..\n$configuration = \"Release\"\n\nfunction ProjectPath([string]$projName) {\n Resolve-Path $solutionPath\\src\\$projName\n}\n\nfunction ProjectFile([string]$projName) {\n $projPath = ProjectPath $projName\n return \"$projPath\\$projName.csproj\"\n}\n\nfunction BuildProj([string]$projName, [string]$target) {\n\n $pack = $target -eq \"Pack\"\n\n MSBuild $(ProjectFile($projName)) /t:$target /v:minimal `\n /p:NoBuild=$pack `\n /p:Configuration=$configuration `\n /p:PackageOutputPath=$outputPath `\n /p:AssemblyVersion=$AssemblyVersion `\n /p:FileVersion=$PackageVersion `\n /p:VersionPrefix=$PackageVersion `\n /p:VersionSuffix=$PreRelease `\n /p:ContinuousIntegrationBuild=true `\n /p:GenerateDocumentationFile=$(-not $pack) `\n /p:Authors=$($notice.authors) `\n /p:Product=$($notice.work) `\n /p:Copyright=$($notice.copyright) `\n /p:Company=$($notice.website) `\n /p:PackageLicenseExpression=$($notice.license.name) `\n /p:PackageProjectUrl=$($notice.website) `\n /p:PackageReleaseNotes=\"For a list of changes see $($notice.website)docs/7/changes.html\" `\n /p:RepositoryBranch=$(git branch --show-current)\n}\n\nfunction NuPack([string]$projName) {\n\n BuildProj $projName \"Build\" | Out-Host\n\n .\\build-docs.ps1 -ProjectName $projName -NoBuildProj -XmlOnly | Out-Host\n\n BuildProj $projName \"Pack\" | Out-Host\n\n return Join-Path $outputPath \"$projName.$pkgVer.nupkg\"\n}\n\nfunction Prompt-Choices($Choices=(\"&Yes\", \"&No\"), [string]$Title=\"Confirm\", [string]$Message=\"Are you sure?\", [int]$Default=0) {\n\n $choicesArr = [Management.Automation.Host.ChoiceDescription[]] `\n ($Choices | % {New-Object Management.Automation.Host.ChoiceDescription $_})\n\n return $host.ui.PromptForChoice($Title, $Message, $choicesArr, $Default)\n}\n\ntry {\n\n [xml]$noticeDoc = Get-Content $solutionPath\\NOTICE.xml\n $notice = $noticeDoc.DocumentElement\n\n if (-not (Test-Path nupkg -PathType Container)) {\n md nupkg | Out-Null\n }\n\n $outputPath = Resolve-Path nupkg\n\n $pkgVer = $PackageVersion.ToString(3)\n\n if ($PreRelease) {\n $pkgVer = $pkgVer + \"-\" + $PreRelease\n }\n\n $newTag = \"v$pkgVer\"\n\n MSBuild $solutionPath\\DbExtensions.sln -t:Restore\n\n $newPackages = (NuPack DbExtensions), (NuPack DbExtensions-QE)\n\n if ((Prompt-Choices -Message \"Create tag $newTag ?\" -Default 1) -eq 0) {\n\n git tag -a $newTag -m $newTag\n Write-Warning \"Created tag: $newTag\"\n\n if ((Prompt-Choices -Message \"Push package(s) to gallery?\" -Default 1) -eq 0) {\n foreach ($pkgPath in $newPackages) {\n dotnet nuget push $pkgPath --source nuget.org\n }\n }\n\n if ((Prompt-Choices -Message \"Push new tag $newTag to origin?\" -Default 1) -eq 0) {\n git push origin $newTag\n }\n }\n\n} finally {\n Pop-Location\n}\n"
},
{
"path": "docs/README.md",
"content": "Documentation has moved [here](https://maxtoroq.github.io/DbExtensions/docs/7/)."
},
{
"path": "docs/SqlBuilder.md",
"content": "This page has moved [here](https://maxtoroq.github.io/DbExtensions/docs/7/SqlBuilder.html)."
},
{
"path": "docs/SqlSet.md",
"content": "This page has moved [here](https://maxtoroq.github.io/DbExtensions/docs/7/SqlSet.html)."
},
{
"path": "docs/api/DbExtensions/AssociationAttribute/Name.md",
"content": "AssociationAttribute.Name Property\n==================================\nGets or sets the name of a constraint.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic string? Name { get; set; }\n```\n\n#### Property Value\n[String][2]\n\nSee Also\n--------\n\n#### Reference\n[AssociationAttribute Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.string\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/AssociationAttribute/OtherKey.md",
"content": "AssociationAttribute.OtherKey Property\n======================================\nGets or sets one or more members of the target entity class as key values on the other side of the association.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic string? OtherKey { get; set; }\n```\n\n#### Property Value\n[String][2]\n\nSee Also\n--------\n\n#### Reference\n[AssociationAttribute Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.string\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/AssociationAttribute/README.md",
"content": "AssociationAttribute Class\n==========================\nDesignates a property to represent a database association, such as a foreign key relationship.\n\n\nInheritance Hierarchy\n---------------------\n[System.Object][1] \n [System.Attribute][2] \n **DbExtensions.AssociationAttribute** \n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic sealed class AssociationAttribute : Attribute\n```\n\nThe **AssociationAttribute** type exposes the following members.\n\n\nConstructors\n------------\n\n| Name | Description |\n| ------------------------- | ---------------------------------------------------------------- |\n| [AssociationAttribute][4] | Initializes a new instance of the **AssociationAttribute** class |\n\n\nProperties\n----------\n\n| Name | Description |\n| ------------- | --------------------------------------------------------------------------------------------------------------- |\n| [Name][5] | Gets or sets the name of a constraint. |\n| [OtherKey][6] | Gets or sets one or more members of the target entity class as key values on the other side of the association. |\n| [ThisKey][7] | Gets or sets members of this entity class to represent the key values on this side of the association. |\n\n\nSee Also\n--------\n\n#### Reference\n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.object\n[2]: https://learn.microsoft.com/dotnet/api/system.attribute\n[3]: ../README.md\n[4]: _ctor.md\n[5]: Name.md\n[6]: OtherKey.md\n[7]: ThisKey.md"
},
{
"path": "docs/api/DbExtensions/AssociationAttribute/ThisKey.md",
"content": "AssociationAttribute.ThisKey Property\n=====================================\nGets or sets members of this entity class to represent the key values on this side of the association.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic string? ThisKey { get; set; }\n```\n\n#### Property Value\n[String][2]\n\nSee Also\n--------\n\n#### Reference\n[AssociationAttribute Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.string\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/AssociationAttribute/_ctor.md",
"content": "AssociationAttribute Constructor\n================================\nInitializes a new instance of the [AssociationAttribute][1] class\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic AssociationAttribute()\n```\n\n\nSee Also\n--------\n\n#### Reference\n[AssociationAttribute Class][1] \n[DbExtensions Namespace][2] \n\n[1]: README.md\n[2]: ../README.md"
},
{
"path": "docs/api/DbExtensions/AutoSync/README.md",
"content": "AutoSync Enumeration\n====================\nUsed to specify for during INSERT and UPDATE operations when a data member should be read back after the operation completes.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic enum AutoSync\n```\n\n\nMembers\n-------\n\n| Member name | Value | Description |\n| ----------- | ----- | ------------------------------------------------- |\n| Default | 0 | Automatically selects the value. |\n| Always | 1 | Always returns the value. |\n| Never | 2 | Never returns the value. |\n| OnInsert | 3 | Returns the value only after an INSERT operation. |\n| OnUpdate | 4 | Returns the value only after an UPDATE operation. |\n\n\nSee Also\n--------\n\n#### Reference\n[DbExtensions Namespace][1] \n\n[1]: ../README.md"
},
{
"path": "docs/api/DbExtensions/ChangeConflictException/README.md",
"content": "ChangeConflictException Class\n=============================\nAn exception that is thrown when a concurrency violation is encountered while saving to the database. A concurrency violation occurs when an unexpected number of rows are affected during save. This is usually because the data in the database has been modified since it was loaded into memory.\n\n\nInheritance Hierarchy\n---------------------\n[System.Object][1] \n [System.Exception][2] \n **DbExtensions.ChangeConflictException** \n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic sealed class ChangeConflictException : Exception\n```\n\nThe **ChangeConflictException** type exposes the following members.\n\n\nConstructors\n------------\n\n| Name | Description |\n| ---------------------------- | --------------------------------------------------------------------------------------------------- |\n| [ChangeConflictException][4] | Initializes a new instance of the **ChangeConflictException** class with a specified error message. |\n\n\nSee Also\n--------\n\n#### Reference\n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.object\n[2]: https://learn.microsoft.com/dotnet/api/system.exception\n[3]: ../README.md\n[4]: _ctor.md"
},
{
"path": "docs/api/DbExtensions/ChangeConflictException/_ctor.md",
"content": "ChangeConflictException Constructor\n===================================\nInitializes a new instance of the [ChangeConflictException][1] class with a specified error message.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic ChangeConflictException(\n\tstring message\n)\n```\n\n#### Parameters\n\n##### *message* [String][3]\nThe message that describes the error.\n\n\nSee Also\n--------\n\n#### Reference\n[ChangeConflictException Class][1] \n[DbExtensions Namespace][2] \n\n[1]: README.md\n[2]: ../README.md\n[3]: https://learn.microsoft.com/dotnet/api/system.string"
},
{
"path": "docs/api/DbExtensions/ColumnAttribute/AutoSync.md",
"content": "ColumnAttribute.AutoSync Property\n=================================\nGets or sets the [AutoSync][1] enumeration.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic AutoSync AutoSync { get; set; }\n```\n\n#### Property Value\n[AutoSync][1]\n\nSee Also\n--------\n\n#### Reference\n[ColumnAttribute Class][3] \n[DbExtensions Namespace][2] \n\n[1]: ../AutoSync/README.md\n[2]: ../README.md\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/ColumnAttribute/ConvertTo.md",
"content": "ColumnAttribute.ConvertTo Property\n==================================\nGets or sets the type to convert this member to before sending to the database.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic Type? ConvertTo { get; set; }\n```\n\n#### Property Value\n[Type][2]\n\nSee Also\n--------\n\n#### Reference\n[ColumnAttribute Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.type\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/ColumnAttribute/IsDbGenerated.md",
"content": "ColumnAttribute.IsDbGenerated Property\n======================================\nGets or sets whether a column contains values that the database auto-generates.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic bool IsDbGenerated { get; set; }\n```\n\n#### Property Value\n[Boolean][2]\n\nSee Also\n--------\n\n#### Reference\n[ColumnAttribute Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.boolean\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/ColumnAttribute/IsPrimaryKey.md",
"content": "ColumnAttribute.IsPrimaryKey Property\n=====================================\nGets or sets whether this class member represents a column that is part or all of the primary key of the table.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic bool IsPrimaryKey { get; set; }\n```\n\n#### Property Value\n[Boolean][2]\n\nSee Also\n--------\n\n#### Reference\n[ColumnAttribute Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.boolean\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/ColumnAttribute/IsVersion.md",
"content": "ColumnAttribute.IsVersion Property\n==================================\nGets or sets whether the column type of the member is a database timestamp or version number.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic bool IsVersion { get; set; }\n```\n\n#### Property Value\n[Boolean][2]\n\nSee Also\n--------\n\n#### Reference\n[ColumnAttribute Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.boolean\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/ColumnAttribute/Name.md",
"content": "ColumnAttribute.Name Property\n=============================\nGets or sets the name of a column.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic string? Name { get; set; }\n```\n\n#### Property Value\n[String][2]\n\nSee Also\n--------\n\n#### Reference\n[ColumnAttribute Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.string\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/ColumnAttribute/README.md",
"content": "ColumnAttribute Class\n=====================\nAssociates a property with a column in a database table.\n\n\nInheritance Hierarchy\n---------------------\n[System.Object][1] \n [System.Attribute][2] \n **DbExtensions.ColumnAttribute** \n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic sealed class ColumnAttribute : Attribute\n```\n\nThe **ColumnAttribute** type exposes the following members.\n\n\nConstructors\n------------\n\n| Name | Description |\n| -------------------- | ----------------------------------------------------------- |\n| [ColumnAttribute][4] | Initializes a new instance of the **ColumnAttribute** class |\n\n\nProperties\n----------\n\n| Name | Description |\n| ------------------ | --------------------------------------------------------------------------------------------------------------- |\n| [AutoSync][5] | Gets or sets the [AutoSync][6] enumeration. |\n| [ConvertTo][7] | Gets or sets the type to convert this member to before sending to the database. |\n| [IsDbGenerated][8] | Gets or sets whether a column contains values that the database auto-generates. |\n| [IsPrimaryKey][9] | Gets or sets whether this class member represents a column that is part or all of the primary key of the table. |\n| [IsVersion][10] | Gets or sets whether the column type of the member is a database timestamp or version number. |\n| [Name][11] | Gets or sets the name of a column. |\n\n\nSee Also\n--------\n\n#### Reference\n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.object\n[2]: https://learn.microsoft.com/dotnet/api/system.attribute\n[3]: ../README.md\n[4]: _ctor.md\n[5]: AutoSync.md\n[6]: ../AutoSync/README.md\n[7]: ConvertTo.md\n[8]: IsDbGenerated.md\n[9]: IsPrimaryKey.md\n[10]: IsVersion.md\n[11]: Name.md"
},
{
"path": "docs/api/DbExtensions/ColumnAttribute/_ctor.md",
"content": "ColumnAttribute Constructor\n===========================\nInitializes a new instance of the [ColumnAttribute][1] class\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic ColumnAttribute()\n```\n\n\nSee Also\n--------\n\n#### Reference\n[ColumnAttribute Class][1] \n[DbExtensions Namespace][2] \n\n[1]: README.md\n[2]: ../README.md"
},
{
"path": "docs/api/DbExtensions/ComplexPropertyAttribute/Name.md",
"content": "ComplexPropertyAttribute.Name Property\n======================================\nThe base name for the columns on the complex property. The default is the property name.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic string? Name { get; set; }\n```\n\n#### Property Value\n[String][2]\n\nSee Also\n--------\n\n#### Reference\n[ComplexPropertyAttribute Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.string\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/ComplexPropertyAttribute/README.md",
"content": "ComplexPropertyAttribute Class\n==============================\nDesignates a property as a complex property that groups columns of a table that share the same base name.\n\n\nInheritance Hierarchy\n---------------------\n[System.Object][1] \n [System.Attribute][2] \n **DbExtensions.ComplexPropertyAttribute** \n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic sealed class ComplexPropertyAttribute : Attribute\n```\n\nThe **ComplexPropertyAttribute** type exposes the following members.\n\n\nConstructors\n------------\n\n| Name | Description |\n| ----------------------------- | -------------------------------------------------------------------- |\n| [ComplexPropertyAttribute][4] | Initializes a new instance of the **ComplexPropertyAttribute** class |\n\n\nProperties\n----------\n\n| Name | Description |\n| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [Name][5] | The base name for the columns on the complex property. The default is the property name. |\n| [Separator][6] | The separator to use between the base name and the complex property's columns. The default is null, which means the separator is taken from [DatabaseConfiguration.DefaultComplexPropertySeparator][7]. To use no separator and override the default configuration, use an empty [String][8]. |\n\n\nSee Also\n--------\n\n#### Reference\n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.object\n[2]: https://learn.microsoft.com/dotnet/api/system.attribute\n[3]: ../README.md\n[4]: _ctor.md\n[5]: Name.md\n[6]: Separator.md\n[7]: ../DatabaseConfiguration/DefaultComplexPropertySeparator.md\n[8]: https://learn.microsoft.com/dotnet/api/system.string"
},
{
"path": "docs/api/DbExtensions/ComplexPropertyAttribute/Separator.md",
"content": "ComplexPropertyAttribute.Separator Property\n===========================================\nThe separator to use between the base name and the complex property's columns. The default is null, which means the separator is taken from [DatabaseConfiguration.DefaultComplexPropertySeparator][1]. To use no separator and override the default configuration, use an empty [String][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic string? Separator { get; set; }\n```\n\n#### Property Value\n[String][2]\n\nSee Also\n--------\n\n#### Reference\n[ComplexPropertyAttribute Class][4] \n[DbExtensions Namespace][3] \n\n[1]: ../DatabaseConfiguration/DefaultComplexPropertySeparator.md\n[2]: https://learn.microsoft.com/dotnet/api/system.string\n[3]: ../README.md\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/ComplexPropertyAttribute/_ctor.md",
"content": "ComplexPropertyAttribute Constructor\n====================================\nInitializes a new instance of the [ComplexPropertyAttribute][1] class\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic ComplexPropertyAttribute()\n```\n\n\nSee Also\n--------\n\n#### Reference\n[ComplexPropertyAttribute Class][1] \n[DbExtensions Namespace][2] \n\n[1]: README.md\n[2]: ../README.md"
},
{
"path": "docs/api/DbExtensions/Database/Add.md",
"content": "Database.Add Method\n===================\nRecursively executes INSERT commands for the specified *entity* and all its one-to-one and one-to-many associations.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic void Add(\n\tObject entity\n)\n```\n\n#### Parameters\n\n##### *entity* [Object][2]\nThe object whose INSERT command is to be executed. This parameter is named entity for consistency with the other CRUD methods, but in this case it doesn't need to be an actual entity, which means it doesn't need to have a primary key.\n\n\nRemarks\n-------\nThis method is a shortcut for `db.Table(entity.GetType()).Add(entity)`.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][3] \n[DbExtensions Namespace][1] \n[SqlTable.Add(Object)][4] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: README.md\n[4]: ../SqlTable/Add.md"
},
{
"path": "docs/api/DbExtensions/Database/AddAsync.md",
"content": "Database.AddAsync Method\n========================\nRecursively executes INSERT commands for the specified *entity* and all its one-to-one and one-to-many associations.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic ValueTask AddAsync(\n\tObject entity,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *entity* [Object][2]\nThe object whose INSERT command is to be executed. This parameter is named entity for consistency with the other CRUD methods, but in this case it doesn't need to be an actual entity, which means it doesn't need to have a primary key.\n\n##### *cancellationToken* [CancellationToken][3] (Optional)\nThe [CancellationToken][3] to monitor for cancellation requests. The default is [None][4].\n\n#### Return Value\n[ValueTask][5]\n\nRemarks\n-------\nThis method is a shortcut for `await db.Table(entity.GetType()).AddAsync(entity, cancellationToken)`.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][6] \n[DbExtensions Namespace][1] \n[SqlTable.AddAsync(Object, CancellationToken)][7] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask\n[6]: README.md\n[7]: ../SqlTable/AddAsync.md"
},
{
"path": "docs/api/DbExtensions/Database/AsyncMap.md",
"content": "Database.AsyncMap(SqlBuilder) Method\n====================================\nMaps the results of the *query* to dynamic objects. The query is deferred-executed.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| **AsyncMap(SqlBuilder)** | Maps the results of the *query* to dynamic objects. The query is deferred-executed. |\n| [AsyncMap(SqlBuilder, Type)][2] | Maps the results of the *query* to objects of type specified by the *resultType* parameter. The query is deferred-executed. |\n| [AsyncMap<TResult>(SqlBuilder)][3] | Maps the results of the *query* to TResult objects. The query is deferred-executed. |\n| [AsyncMap<TResult>(SqlBuilder, Func<DbDataReader, TResult>)][4] | Maps the results of the *query* to TResult objects, using the provided *mapper* delegate. |\n\n\nSyntax\n------\n\n```csharp\npublic IAsyncEnumerable AsyncMap(\n\tSqlBuilder query\n)\n```\n\n#### Parameters\n\n##### *query* [SqlBuilder][5]\nThe query.\n\n#### Return Value\n[IAsyncEnumerable][6]<[Object][7]> \nThe results of the query as dynamic objects.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][8] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: AsyncMap_1.md\n[3]: AsyncMap__1.md\n[4]: AsyncMap__1_1.md\n[5]: ../SqlBuilder/README.md\n[6]: https://learn.microsoft.com/dotnet/api/system.collections.generic.iasyncenumerable-1\n[7]: https://learn.microsoft.com/dotnet/api/system.object\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/AsyncMap_1.md",
"content": "Database.AsyncMap(SqlBuilder, Type) Method\n==========================================\nMaps the results of the *query* to objects of type specified by the *resultType* parameter. The query is deferred-executed.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| [AsyncMap(SqlBuilder)][2] | Maps the results of the *query* to dynamic objects. The query is deferred-executed. |\n| **AsyncMap(SqlBuilder, Type)** | Maps the results of the *query* to objects of type specified by the *resultType* parameter. The query is deferred-executed. |\n| [AsyncMap<TResult>(SqlBuilder)][3] | Maps the results of the *query* to TResult objects. The query is deferred-executed. |\n| [AsyncMap<TResult>(SqlBuilder, Func<DbDataReader, TResult>)][4] | Maps the results of the *query* to TResult objects, using the provided *mapper* delegate. |\n\n\nSyntax\n------\n\n```csharp\npublic IAsyncEnumerable AsyncMap(\n\tSqlBuilder query,\n\tType resultType\n)\n```\n\n#### Parameters\n\n##### *query* [SqlBuilder][5]\nThe query.\n\n##### *resultType* [Type][6]\nThe type of objects to map the results to.\n\n#### Return Value\n[IAsyncEnumerable][7]<[Object][8]> \nThe results of the query as objects of type specified by the *resultType* parameter.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][9] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: AsyncMap.md\n[3]: AsyncMap__1.md\n[4]: AsyncMap__1_1.md\n[5]: ../SqlBuilder/README.md\n[6]: https://learn.microsoft.com/dotnet/api/system.type\n[7]: https://learn.microsoft.com/dotnet/api/system.collections.generic.iasyncenumerable-1\n[8]: https://learn.microsoft.com/dotnet/api/system.object\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/AsyncMap__1.md",
"content": "Database.AsyncMap<TResult>(SqlBuilder) Method\n================================================\nMaps the results of the *query* to TResult objects. The query is deferred-executed.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| [AsyncMap(SqlBuilder)][2] | Maps the results of the *query* to dynamic objects. The query is deferred-executed. |\n| [AsyncMap(SqlBuilder, Type)][3] | Maps the results of the *query* to objects of type specified by the *resultType* parameter. The query is deferred-executed. |\n| **AsyncMap<TResult>(SqlBuilder)** | Maps the results of the *query* to TResult objects. The query is deferred-executed. |\n| [AsyncMap<TResult>(SqlBuilder, Func<DbDataReader, TResult>)][4] | Maps the results of the *query* to TResult objects, using the provided *mapper* delegate. |\n\n\nSyntax\n------\n\n```csharp\npublic IAsyncEnumerable AsyncMap(\n\tSqlBuilder query\n)\n\n```\n\n#### Parameters\n\n##### *query* [SqlBuilder][5]\nThe query.\n\n#### Type Parameters\n\n##### *TResult*\nThe type of objects to map the results to.\n\n#### Return Value\n[IAsyncEnumerable][6]<**TResult**> \nThe results of the query as TResult objects.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: AsyncMap.md\n[3]: AsyncMap_1.md\n[4]: AsyncMap__1_1.md\n[5]: ../SqlBuilder/README.md\n[6]: https://learn.microsoft.com/dotnet/api/system.collections.generic.iasyncenumerable-1\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/AsyncMap__1_1.md",
"content": "Database.AsyncMap<TResult>(SqlBuilder, Func<DbDataReader, TResult>) Method\n================================================================================\nMaps the results of the *query* to TResult objects, using the provided *mapper* delegate.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| [AsyncMap(SqlBuilder)][2] | Maps the results of the *query* to dynamic objects. The query is deferred-executed. |\n| [AsyncMap(SqlBuilder, Type)][3] | Maps the results of the *query* to objects of type specified by the *resultType* parameter. The query is deferred-executed. |\n| [AsyncMap<TResult>(SqlBuilder)][4] | Maps the results of the *query* to TResult objects. The query is deferred-executed. |\n| **AsyncMap<TResult>(SqlBuilder, Func<DbDataReader, TResult>)** | Maps the results of the *query* to TResult objects, using the provided *mapper* delegate. |\n\n\nSyntax\n------\n\n```csharp\npublic IAsyncEnumerable AsyncMap(\n\tSqlBuilder query,\n\tFunc mapper\n)\n\n```\n\n#### Parameters\n\n##### *query* [SqlBuilder][5]\nThe query.\n\n##### *mapper* [Func][6]<[DbDataReader][7], **TResult**>\nThe delegate for creating TResult objects from an [DbDataReader][7] object.\n\n#### Type Parameters\n\n##### *TResult*\nThe type of objects to map the results to.\n\n#### Return Value\n[IAsyncEnumerable][8]<**TResult**> \nThe results of the query as TResult objects.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][9] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: AsyncMap.md\n[3]: AsyncMap_1.md\n[4]: AsyncMap__1.md\n[5]: ../SqlBuilder/README.md\n[6]: https://learn.microsoft.com/dotnet/api/system.func-2\n[7]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[8]: https://learn.microsoft.com/dotnet/api/system.collections.generic.iasyncenumerable-1\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/Configuration.md",
"content": "Database.Configuration Property\n===============================\nProvides access to configuration options for this instance.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic DatabaseConfiguration Configuration { get; }\n```\n\n#### Property Value\n[DatabaseConfiguration][2]\n\nSee Also\n--------\n\n#### Reference\n[Database Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: ../DatabaseConfiguration/README.md\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/Connection.md",
"content": "Database.Connection Property\n============================\nGets the connection to associate with new commands.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic DbConnection Connection { get; }\n```\n\n#### Property Value\n[DbConnection][2]\n\nSee Also\n--------\n\n#### Reference\n[Database Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.data.common.dbconnection\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/CreateCommand.md",
"content": "Database.CreateCommand Method\n=============================\nCreates and returns a [DbCommand][1] object from the specified *sqlBuilder*.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic virtual DbCommand CreateCommand(\n\tSqlBuilder sqlBuilder\n)\n```\n\n#### Parameters\n\n##### *sqlBuilder* [SqlBuilder][3]\nThe [SqlBuilder][3] that provides the command's text and parameters.\n\n#### Return Value\n[DbCommand][1] \n A new [DbCommand][1] object with its [CommandText][4] property initialized with the *sqlBuilder*'s string representation, and its [Parameters][5] property is initialized with the values from the [ParameterValues][6] property of the *sqlBuilder* parameter.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][7] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.data.common.dbcommand\n[2]: ../README.md\n[3]: ../SqlBuilder/README.md\n[4]: https://learn.microsoft.com/dotnet/api/system.data.common.dbcommand.commandtext\n[5]: https://learn.microsoft.com/dotnet/api/system.data.common.dbcommand.parameters\n[6]: ../SqlBuilder/ParameterValues.md\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/Dispose.md",
"content": "Database.Dispose Method\n=======================\nReleases all resources used by the current instance of the [Database][1] class.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------- | ------------------------------------------------------------------------------- |\n| **Dispose()** | Releases all resources used by the current instance of the [Database][1] class. |\n| [Dispose(Boolean)][3] | Releases the resources used by this [Database][1] instance. |\n\n\nSyntax\n------\n\n```csharp\npublic void Dispose()\n```\n\n#### Implements\n[IDisposable.Dispose()][4] \n\n\nSee Also\n--------\n\n#### Reference\n[Database Class][1] \n[DbExtensions Namespace][2] \n\n[1]: README.md\n[2]: ../README.md\n[3]: Dispose_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.idisposable.dispose"
},
{
"path": "docs/api/DbExtensions/Database/Dispose_1.md",
"content": "Database.Dispose(Boolean) Method\n================================\nReleases the resources used by this [Database][1] instance.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------- | ------------------------------------------------------------------------------- |\n| [Dispose()][3] | Releases all resources used by the current instance of the [Database][1] class. |\n| **Dispose(Boolean)** | Releases the resources used by this [Database][1] instance. |\n\n\nSyntax\n------\n\n```csharp\nprotected virtual void Dispose(\n\tbool disposing\n)\n```\n\n#### Parameters\n\n##### *disposing* [Boolean][4]\n`true` if this method is being called due to a call to [Dispose()][3]; otherwise, `false`.\n\n\nSee Also\n--------\n\n#### Reference\n[Database Class][1] \n[DbExtensions Namespace][2] \n\n[1]: README.md\n[2]: ../README.md\n[3]: Dispose.md\n[4]: https://learn.microsoft.com/dotnet/api/system.boolean"
},
{
"path": "docs/api/DbExtensions/Database/EnsureConnectionOpen.md",
"content": "Database.EnsureConnectionOpen Method\n====================================\nOpens [Connection][1] (if it's not open) and returns an [IDisposable][2] object you can use to close it (if it wasn't open).\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic IDisposable EnsureConnectionOpen()\n```\n\n#### Return Value\n[IDisposable][2] \nAn [IDisposable][2] object to close the connection.\n\nRemarks\n-------\nUse this method with the `using` statement in C# or Visual Basic to ensure that a block of code is always executed with an open connection.\n\nExample\n-------\n\n```csharp\nusing (db.EnsureConnectionOpen()) {\n // Execute commands.\n}\n```\n\n\nSee Also\n--------\n\n#### Reference\n[Database Class][4] \n[DbExtensions Namespace][3] \n\n[1]: Connection.md\n[2]: https://learn.microsoft.com/dotnet/api/system.idisposable\n[3]: ../README.md\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/EnsureConnectionOpenAsync.md",
"content": "Database.EnsureConnectionOpenAsync Method\n=========================================\nOpens [Connection][1] (if it's not open) and returns an [IAsyncDisposable][2] object you can use to close it (if it wasn't open).\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic ValueTask EnsureConnectionOpenAsync(\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]<[IAsyncDisposable][2]> \nAn [IAsyncDisposable][2] object to close the connection.\n\nRemarks\n-------\nUse this method with the `using` statement in C# or Visual Basic to ensure that a block of code is always executed with an open connection.\n\nExample\n-------\n\n```csharp\nawait using (await db.EnsureConnectionOpenAsync()) {\n // Execute commands.\n}\n```\n\n\nSee Also\n--------\n\n#### Reference\n[Database Class][7] \n[DbExtensions Namespace][3] \n\n[1]: Connection.md\n[2]: https://learn.microsoft.com/dotnet/api/system.iasyncdisposable\n[3]: ../README.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/EnsureInTransaction.md",
"content": "Database.EnsureInTransaction Method\n===================================\nReturns a virtual transaction that you can use to ensure a code block is always executed in a transaction, new or existing.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| **EnsureInTransaction()** | Returns a virtual transaction that you can use to ensure a code block is always executed in a transaction, new or existing. |\n| [EnsureInTransaction(IsolationLevel)][2] | Returns a virtual transaction that you can use to ensure a code block is always executed in a transaction, new or existing. |\n\n\nSyntax\n------\n\n```csharp\npublic DbTransaction EnsureInTransaction()\n```\n\n#### Return Value\n[DbTransaction][3] \n A virtual transaction you can use to ensure a code block is always executed in a transaction, new or existing.\n\nRemarks\n-------\nThis method returns a virtual transaction that wraps an existing or new transaction. By calling [Commit()][4] on the returned object, this object will then call [Commit()][4] on the wrapped transaction if the transaction was just created, or do nothing if it was previously created.\n\nExample\n-------\n\nCalls to this method can be nested, like in the following example:\n\n```csharp\nvoid DoSomething() {\n\n using (var tx = this.db.EnsureInTransaction()) {\n\n // Execute commands\n\n DoSomethingElse();\n\n tx.Commit();\n }\n}\n\nvoid DoSomethingElse() { \n\n using (var tx = this.db.EnsureInTransaction()) {\n\n // Execute commands\n\n tx.Commit();\n }\n}\n```\n\n\nSee Also\n--------\n\n#### Reference\n[Database Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: EnsureInTransaction_1.md\n[3]: https://learn.microsoft.com/dotnet/api/system.data.common.dbtransaction\n[4]: https://learn.microsoft.com/dotnet/api/system.data.common.dbtransaction.commit\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/EnsureInTransactionAsync.md",
"content": "Database.EnsureInTransactionAsync(IsolationLevel, CancellationToken) Method\n===========================================================================\nReturns a virtual transaction that you can use to ensure a code block is always executed in a transaction, new or existing.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| [EnsureInTransactionAsync(CancellationToken)][2] | Returns a virtual transaction that you can use to ensure a code block is always executed in a transaction, new or existing. |\n| **EnsureInTransactionAsync(IsolationLevel, CancellationToken)** | Returns a virtual transaction that you can use to ensure a code block is always executed in a transaction, new or existing. |\n\n\nSyntax\n------\n\n```csharp\npublic virtual ValueTask EnsureInTransactionAsync(\n\tIsolationLevel isolationLevel,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *isolationLevel* [IsolationLevel][3]\nSpecifies the isolation level for the transaction. This parameter is ignored when using an existing transaction.\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]<[DbTransaction][7]> \n A virtual transaction you can use to ensure a code block is always executed in a transaction, new or existing.\n\nRemarks\n-------\nThis method returns a virtual transaction that wraps an existing or new transaction. By calling [Commit()][8] on the returned object, this object will then call [Commit()][8] on the wrapped transaction if the transaction was just created, or do nothing if it was previously created.\n\nExample\n-------\n\nCalls to this method can be nested, like in the following example:\n\n```csharp\nasync Task DoSomething() {\n\n await using (var tx = await this.db.EnsureInTransactionAsync()) {\n\n // Execute commands\n\n await DoSomethingElse();\n\n await tx.CommitAsync();\n }\n}\n\nasync Task DoSomethingElse() {\n\n await using (var tx = await this.db.EnsureInTransactionAsync()) {\n\n // Execute commands\n\n await tx.CommitAsync();\n }\n}\n```\n\n\nSee Also\n--------\n\n#### Reference\n[Database Class][9] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: EnsureInTransactionAsync_1.md\n[3]: https://learn.microsoft.com/dotnet/api/system.data.isolationlevel\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[7]: https://learn.microsoft.com/dotnet/api/system.data.common.dbtransaction\n[8]: https://learn.microsoft.com/dotnet/api/system.data.common.dbtransaction.commit\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/EnsureInTransactionAsync_1.md",
"content": "Database.EnsureInTransactionAsync(CancellationToken) Method\n===========================================================\nReturns a virtual transaction that you can use to ensure a code block is always executed in a transaction, new or existing.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| **EnsureInTransactionAsync(CancellationToken)** | Returns a virtual transaction that you can use to ensure a code block is always executed in a transaction, new or existing. |\n| [EnsureInTransactionAsync(IsolationLevel, CancellationToken)][2] | Returns a virtual transaction that you can use to ensure a code block is always executed in a transaction, new or existing. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask EnsureInTransactionAsync(\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *cancellationToken* [CancellationToken][3] (Optional)\nThe [CancellationToken][3] to monitor for cancellation requests. The default is [None][4].\n\n#### Return Value\n[ValueTask][5]<[DbTransaction][6]> \n A virtual transaction you can use to ensure a code block is always executed in a transaction, new or existing.\n\nRemarks\n-------\nThis method returns a virtual transaction that wraps an existing or new transaction. By calling [Commit()][7] on the returned object, this object will then call [Commit()][7] on the wrapped transaction if the transaction was just created, or do nothing if it was previously created.\n\nExample\n-------\n\nCalls to this method can be nested, like in the following example:\n\n```csharp\nasync Task DoSomething() {\n\n await using (var tx = await this.db.EnsureInTransactionAsync()) {\n\n // Execute commands\n\n await DoSomethingElse();\n\n await tx.CommitAsync();\n }\n}\n\nasync Task DoSomethingElse() {\n\n await using (var tx = await this.db.EnsureInTransactionAsync()) {\n\n // Execute commands\n\n await tx.CommitAsync();\n }\n}\n```\n\n\nSee Also\n--------\n\n#### Reference\n[Database Class][8] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: EnsureInTransactionAsync.md\n[3]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[6]: https://learn.microsoft.com/dotnet/api/system.data.common.dbtransaction\n[7]: https://learn.microsoft.com/dotnet/api/system.data.common.dbtransaction.commit\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/EnsureInTransaction_1.md",
"content": "Database.EnsureInTransaction(IsolationLevel) Method\n===================================================\nReturns a virtual transaction that you can use to ensure a code block is always executed in a transaction, new or existing.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| [EnsureInTransaction()][2] | Returns a virtual transaction that you can use to ensure a code block is always executed in a transaction, new or existing. |\n| **EnsureInTransaction(IsolationLevel)** | Returns a virtual transaction that you can use to ensure a code block is always executed in a transaction, new or existing. |\n\n\nSyntax\n------\n\n```csharp\npublic virtual DbTransaction EnsureInTransaction(\n\tIsolationLevel isolationLevel\n)\n```\n\n#### Parameters\n\n##### *isolationLevel* [IsolationLevel][3]\nSpecifies the isolation level for the transaction. This parameter is ignored when using an existing transaction.\n\n#### Return Value\n[DbTransaction][4] \n A virtual transaction you can use to ensure a code block is always executed in a transaction, new or existing.\n\nRemarks\n-------\nThis method returns a virtual transaction that wraps an existing or new transaction. By calling [Commit()][5] on the returned object, this object will then call [Commit()][5] on the wrapped transaction if the transaction was just created, or do nothing if it was previously created.\n\nExample\n-------\n\nCalls to this method can be nested, like in the following example:\n\n```csharp\nvoid DoSomething() {\n\n using (var tx = this.db.EnsureInTransaction()) {\n\n // Execute commands\n\n DoSomethingElse();\n\n tx.Commit();\n }\n}\n\nvoid DoSomethingElse() { \n\n using (var tx = this.db.EnsureInTransaction()) {\n\n // Execute commands\n\n tx.Commit();\n }\n}\n```\n\n\nSee Also\n--------\n\n#### Reference\n[Database Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: EnsureInTransaction.md\n[3]: https://learn.microsoft.com/dotnet/api/system.data.isolationlevel\n[4]: https://learn.microsoft.com/dotnet/api/system.data.common.dbtransaction\n[5]: https://learn.microsoft.com/dotnet/api/system.data.common.dbtransaction.commit\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/Execute.md",
"content": "Database.Execute Method\n=======================\nExecutes the *nonQuery* command. Optionally uses a transaction and validates affected records value before committing.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic int Execute(\n\tSqlBuilder nonQuery,\n\tint affect = -1,\n\tbool exact = false\n)\n```\n\n#### Parameters\n\n##### *nonQuery* [SqlBuilder][2]\nThe non-query command to execute.\n\n##### *affect* [Int32][3] (Optional)\nThe number of records the command should affect. This value is ignored if less or equal to -1.\n\n##### *exact* [Boolean][4] (Optional)\n`true` if the number of affected records should exactly match *affect*; `false` if a lower number is acceptable.\n\n#### Return Value\n[Int32][3] \nThe number of affected records.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ---------------------------- | -------------------------------------------------------- |\n| [ChangeConflictException][5] | The number of affected records is not equal to *affect*. |\n\n\nSee Also\n--------\n\n#### Reference\n[Database Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: ../SqlBuilder/README.md\n[3]: https://learn.microsoft.com/dotnet/api/system.int32\n[4]: https://learn.microsoft.com/dotnet/api/system.boolean\n[5]: ../ChangeConflictException/README.md\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/ExecuteAsync.md",
"content": "Database.ExecuteAsync Method\n============================\nExecutes the *nonQuery* command. Optionally uses a transaction and validates affected records value before committing.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic ValueTask ExecuteAsync(\n\tSqlBuilder nonQuery,\n\tint affect = -1,\n\tbool exact = false,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *nonQuery* [SqlBuilder][2]\nThe non-query command to execute.\n\n##### *affect* [Int32][3] (Optional)\nThe number of records the command should affect. This value is ignored if less or equal to -1.\n\n##### *exact* [Boolean][4] (Optional)\n`true` if the number of affected records should exactly match *affect*; `false` if a lower number is acceptable.\n\n##### *cancellationToken* [CancellationToken][5] (Optional)\nThe [CancellationToken][5] to monitor for cancellation requests. The default is [None][6].\n\n#### Return Value\n[ValueTask][7]<[Int32][3]> \nThe number of affected records.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ---------------------------- | -------------------------------------------------------- |\n| [ChangeConflictException][8] | The number of affected records is not equal to *affect*. |\n\n\nSee Also\n--------\n\n#### Reference\n[Database Class][9] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: ../SqlBuilder/README.md\n[3]: https://learn.microsoft.com/dotnet/api/system.int32\n[4]: https://learn.microsoft.com/dotnet/api/system.boolean\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[7]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[8]: ../ChangeConflictException/README.md\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/FindAsync__1.md",
"content": "Database.FindAsync<TEntity> Method\n=====================================\nGets the entity whose primary key matches the *id* parameter.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic ValueTask FindAsync(\n\tObject id,\n\tCancellationToken cancellationToken = default\n)\nwhere TEntity : class\n\n```\n\n#### Parameters\n\n##### *id* [Object][2]\nThe primary key value.\n\n##### *cancellationToken* [CancellationToken][3] (Optional)\nThe [CancellationToken][3] to monitor for cancellation requests. The default is [None][4].\n\n#### Type Parameters\n\n##### *TEntity*\nThe type of the entity.\n\n#### Return Value\n[ValueTask][5]<**TEntity**> \n The entity whose primary key matches the *id* parameter, or null if the *id* does not exist.\n\nRemarks\n-------\nThis method is a shortcut for `await db.Table().FindAsync(id, cancellationToken)`.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/Find__1.md",
"content": "Database.Find<TEntity> Method\n================================\nGets the entity whose primary key matches the *id* parameter.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic TEntity Find(\n\tObject id\n)\nwhere TEntity : class\n\n```\n\n#### Parameters\n\n##### *id* [Object][2]\nThe primary key value.\n\n#### Type Parameters\n\n##### *TEntity*\nThe type of the entity.\n\n#### Return Value\n**TEntity** \n The entity whose primary key matches the *id* parameter, or null if the *id* does not exist.\n\nRemarks\n-------\nThis method is a shortcut for `db.Table().Find(id)`.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][3] \n[DbExtensions Namespace][1] \n[SqlSet<TResult>.Find(Object)][4] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: README.md\n[4]: ../SqlSet_1/Find.md"
},
{
"path": "docs/api/DbExtensions/Database/From.md",
"content": "Database.From(String) Method\n============================\nCreates and returns a new [SqlSet][1] using the provided table name.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------- | -------------------------------------------------------------------------------- |\n| **From(String)** | Creates and returns a new [SqlSet][1] using the provided table name. |\n| [From(String, Type)][3] | Creates and returns a new [SqlSet][1] using the provided table name. |\n| [From<TResult>(String)][4] | Creates and returns a new [SqlSet<TResult>][5] using the provided table name. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlSet From(\n\tstring tableName\n)\n```\n\n#### Parameters\n\n##### *tableName* [String][6]\nThe name of the table that will be the source of data for the set.\n\n#### Return Value\n[SqlSet][1] \nA new [SqlSet][1] object.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][7] \n[DbExtensions Namespace][2] \n\n[1]: ../SqlSet/README.md\n[2]: ../README.md\n[3]: From_1.md\n[4]: From__1.md\n[5]: ../SqlSet_1/README.md\n[6]: https://learn.microsoft.com/dotnet/api/system.string\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/FromQuery.md",
"content": "Database.FromQuery(SqlBuilder) Method\n=====================================\nCreates and returns a new [SqlSet][1] using the provided defining query.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |\n| **FromQuery(SqlBuilder)** | Creates and returns a new [SqlSet][1] using the provided defining query. |\n| [FromQuery(SqlBuilder, Type)][3] | Creates and returns a new [SqlSet][1] using the provided defining query. |\n| [FromQuery<TResult>(SqlBuilder)][4] | Creates and returns a new [SqlSet<TResult>][5] using the provided defining query. |\n| [FromQuery<TResult>(SqlBuilder, Func<DbDataReader, TResult>)][6] | Creates and returns a new [SqlSet<TResult>][5] using the provided defining query and mapper. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlSet FromQuery(\n\tSqlBuilder definingQuery\n)\n```\n\n#### Parameters\n\n##### *definingQuery* [SqlBuilder][7]\nThe SQL query that will be the source of data for the set.\n\n#### Return Value\n[SqlSet][1] \nA new [SqlSet][1] object.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][8] \n[DbExtensions Namespace][2] \n\n[1]: ../SqlSet/README.md\n[2]: ../README.md\n[3]: FromQuery_1.md\n[4]: FromQuery__1.md\n[5]: ../SqlSet_1/README.md\n[6]: FromQuery__1_1.md\n[7]: ../SqlBuilder/README.md\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/FromQuery_1.md",
"content": "Database.FromQuery(SqlBuilder, Type) Method\n===========================================\nCreates and returns a new [SqlSet][1] using the provided defining query.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |\n| [FromQuery(SqlBuilder)][3] | Creates and returns a new [SqlSet][1] using the provided defining query. |\n| **FromQuery(SqlBuilder, Type)** | Creates and returns a new [SqlSet][1] using the provided defining query. |\n| [FromQuery<TResult>(SqlBuilder)][4] | Creates and returns a new [SqlSet<TResult>][5] using the provided defining query. |\n| [FromQuery<TResult>(SqlBuilder, Func<DbDataReader, TResult>)][6] | Creates and returns a new [SqlSet<TResult>][5] using the provided defining query and mapper. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlSet FromQuery(\n\tSqlBuilder definingQuery,\n\tType? resultType\n)\n```\n\n#### Parameters\n\n##### *definingQuery* [SqlBuilder][7]\nThe SQL query that will be the source of data for the set.\n\n##### *resultType* [Type][8]\nThe type of objects to map the results to.\n\n#### Return Value\n[SqlSet][1] \nA new [SqlSet][1] object.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][9] \n[DbExtensions Namespace][2] \n\n[1]: ../SqlSet/README.md\n[2]: ../README.md\n[3]: FromQuery.md\n[4]: FromQuery__1.md\n[5]: ../SqlSet_1/README.md\n[6]: FromQuery__1_1.md\n[7]: ../SqlBuilder/README.md\n[8]: https://learn.microsoft.com/dotnet/api/system.type\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/FromQuery__1.md",
"content": "Database.FromQuery<TResult>(SqlBuilder) Method\n=================================================\nCreates and returns a new [SqlSet<TResult>][1] using the provided defining query.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |\n| [FromQuery(SqlBuilder)][3] | Creates and returns a new [SqlSet][4] using the provided defining query. |\n| [FromQuery(SqlBuilder, Type)][5] | Creates and returns a new [SqlSet][4] using the provided defining query. |\n| **FromQuery<TResult>(SqlBuilder)** | Creates and returns a new [SqlSet<TResult>][1] using the provided defining query. |\n| [FromQuery<TResult>(SqlBuilder, Func<DbDataReader, TResult>)][6] | Creates and returns a new [SqlSet<TResult>][1] using the provided defining query and mapper. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlSet FromQuery(\n\tSqlBuilder definingQuery\n)\n\n```\n\n#### Parameters\n\n##### *definingQuery* [SqlBuilder][7]\nThe SQL query that will be the source of data for the set.\n\n#### Type Parameters\n\n##### *TResult*\nThe type of objects to map the results to.\n\n#### Return Value\n[SqlSet][1]<**TResult**> \nA new [SqlSet<TResult>][1] object.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][8] \n[DbExtensions Namespace][2] \n\n[1]: ../SqlSet_1/README.md\n[2]: ../README.md\n[3]: FromQuery.md\n[4]: ../SqlSet/README.md\n[5]: FromQuery_1.md\n[6]: FromQuery__1_1.md\n[7]: ../SqlBuilder/README.md\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/FromQuery__1_1.md",
"content": "Database.FromQuery<TResult>(SqlBuilder, Func<DbDataReader, TResult>) Method\n=================================================================================\nCreates and returns a new [SqlSet<TResult>][1] using the provided defining query and mapper.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |\n| [FromQuery(SqlBuilder)][3] | Creates and returns a new [SqlSet][4] using the provided defining query. |\n| [FromQuery(SqlBuilder, Type)][5] | Creates and returns a new [SqlSet][4] using the provided defining query. |\n| [FromQuery<TResult>(SqlBuilder)][6] | Creates and returns a new [SqlSet<TResult>][1] using the provided defining query. |\n| **FromQuery<TResult>(SqlBuilder, Func<DbDataReader, TResult>)** | Creates and returns a new [SqlSet<TResult>][1] using the provided defining query and mapper. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlSet FromQuery(\n\tSqlBuilder definingQuery,\n\tFunc mapper\n)\n\n```\n\n#### Parameters\n\n##### *definingQuery* [SqlBuilder][7]\nThe SQL query that will be the source of data for the set.\n\n##### *mapper* [Func][8]<[DbDataReader][9], **TResult**>\nA custom mapper function that creates TResult instances from the rows in the set.\n\n#### Type Parameters\n\n##### *TResult*\nThe type of objects to map the results to.\n\n#### Return Value\n[SqlSet][1]<**TResult**> \nA new [SqlSet<TResult>][1] object.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][10] \n[DbExtensions Namespace][2] \n\n[1]: ../SqlSet_1/README.md\n[2]: ../README.md\n[3]: FromQuery.md\n[4]: ../SqlSet/README.md\n[5]: FromQuery_1.md\n[6]: FromQuery__1.md\n[7]: ../SqlBuilder/README.md\n[8]: https://learn.microsoft.com/dotnet/api/system.func-2\n[9]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[10]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/From_1.md",
"content": "Database.From(String, Type) Method\n==================================\nCreates and returns a new [SqlSet][1] using the provided table name.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------- | -------------------------------------------------------------------------------- |\n| [From(String)][3] | Creates and returns a new [SqlSet][1] using the provided table name. |\n| **From(String, Type)** | Creates and returns a new [SqlSet][1] using the provided table name. |\n| [From<TResult>(String)][4] | Creates and returns a new [SqlSet<TResult>][5] using the provided table name. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlSet From(\n\tstring tableName,\n\tType? resultType\n)\n```\n\n#### Parameters\n\n##### *tableName* [String][6]\nThe name of the table that will be the source of data for the set.\n\n##### *resultType* [Type][7]\nThe type of objects to map the results to.\n\n#### Return Value\n[SqlSet][1] \nA new [SqlSet][1] object.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][8] \n[DbExtensions Namespace][2] \n\n[1]: ../SqlSet/README.md\n[2]: ../README.md\n[3]: From.md\n[4]: From__1.md\n[5]: ../SqlSet_1/README.md\n[6]: https://learn.microsoft.com/dotnet/api/system.string\n[7]: https://learn.microsoft.com/dotnet/api/system.type\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/From__1.md",
"content": "Database.From<TResult>(String) Method\n========================================\nCreates and returns a new [SqlSet<TResult>][1] using the provided table name.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------- | -------------------------------------------------------------------------------- |\n| [From(String)][3] | Creates and returns a new [SqlSet][4] using the provided table name. |\n| [From(String, Type)][5] | Creates and returns a new [SqlSet][4] using the provided table name. |\n| **From<TResult>(String)** | Creates and returns a new [SqlSet<TResult>][1] using the provided table name. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlSet From(\n\tstring tableName\n)\n\n```\n\n#### Parameters\n\n##### *tableName* [String][6]\nThe name of the table that will be the source of data for the set.\n\n#### Type Parameters\n\n##### *TResult*\nThe type of objects to map the results to.\n\n#### Return Value\n[SqlSet][1]<**TResult**> \nA new [SqlSet<TResult>][1] object.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][7] \n[DbExtensions Namespace][2] \n\n[1]: ../SqlSet_1/README.md\n[2]: ../README.md\n[3]: From.md\n[4]: ../SqlSet/README.md\n[5]: From_1.md\n[6]: https://learn.microsoft.com/dotnet/api/system.string\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/LastInsertId.md",
"content": "Database.LastInsertId Method\n============================\nGets the identity value of the last inserted record.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic virtual Object? LastInsertId()\n```\n\n#### Return Value\n[Object][2] \nThe identity value of the last inserted record.\n\nRemarks\n-------\nIt is very important to keep the connection open between the last command and this one, or else you might get the wrong value.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/LastInsertIdAsync.md",
"content": "Database.LastInsertIdAsync Method\n=================================\nGets the identity value of the last inserted record.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic virtual ValueTask LastInsertIdAsync(\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *cancellationToken* [CancellationToken][2] (Optional)\nThe [CancellationToken][2] to monitor for cancellation requests. The default is [None][3].\n\n#### Return Value\n[ValueTask][4]<[Object][5]> \nThe identity value of the last inserted record.\n\nRemarks\n-------\nIt is very important to keep the connection open between the last command and this one, or else you might get the wrong value.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[3]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[5]: https://learn.microsoft.com/dotnet/api/system.object\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/Map.md",
"content": "Database.Map(SqlBuilder) Method\n===============================\nMaps the results of the *query* to dynamic objects. The query is deferred-executed.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| **Map(SqlBuilder)** | Maps the results of the *query* to dynamic objects. The query is deferred-executed. |\n| [Map(SqlBuilder, Type)][2] | Maps the results of the *query* to objects of type specified by the *resultType* parameter. The query is deferred-executed. |\n| [Map<TResult>(SqlBuilder)][3] | Maps the results of the *query* to TResult objects. The query is deferred-executed. |\n| [Map<TResult>(SqlBuilder, Func<DbDataReader, TResult>)][4] | Maps the results of the *query* to TResult objects, using the provided *mapper* delegate. |\n\n\nSyntax\n------\n\n```csharp\npublic IEnumerable Map(\n\tSqlBuilder query\n)\n```\n\n#### Parameters\n\n##### *query* [SqlBuilder][5]\nThe query.\n\n#### Return Value\n[IEnumerable][6]<[Object][7]> \nThe results of the query as dynamic objects.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][8] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Map_1.md\n[3]: Map__1.md\n[4]: Map__1_1.md\n[5]: ../SqlBuilder/README.md\n[6]: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1\n[7]: https://learn.microsoft.com/dotnet/api/system.object\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/Map_1.md",
"content": "Database.Map(SqlBuilder, Type) Method\n=====================================\nMaps the results of the *query* to objects of type specified by the *resultType* parameter. The query is deferred-executed.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| [Map(SqlBuilder)][2] | Maps the results of the *query* to dynamic objects. The query is deferred-executed. |\n| **Map(SqlBuilder, Type)** | Maps the results of the *query* to objects of type specified by the *resultType* parameter. The query is deferred-executed. |\n| [Map<TResult>(SqlBuilder)][3] | Maps the results of the *query* to TResult objects. The query is deferred-executed. |\n| [Map<TResult>(SqlBuilder, Func<DbDataReader, TResult>)][4] | Maps the results of the *query* to TResult objects, using the provided *mapper* delegate. |\n\n\nSyntax\n------\n\n```csharp\npublic IEnumerable Map(\n\tSqlBuilder query,\n\tType resultType\n)\n```\n\n#### Parameters\n\n##### *query* [SqlBuilder][5]\nThe query.\n\n##### *resultType* [Type][6]\nThe type of objects to map the results to.\n\n#### Return Value\n[IEnumerable][7]<[Object][8]> \nThe results of the query as objects of type specified by the *resultType* parameter.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][9] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Map.md\n[3]: Map__1.md\n[4]: Map__1_1.md\n[5]: ../SqlBuilder/README.md\n[6]: https://learn.microsoft.com/dotnet/api/system.type\n[7]: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1\n[8]: https://learn.microsoft.com/dotnet/api/system.object\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/Map__1.md",
"content": "Database.Map<TResult>(SqlBuilder) Method\n===========================================\nMaps the results of the *query* to TResult objects. The query is deferred-executed.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| [Map(SqlBuilder)][2] | Maps the results of the *query* to dynamic objects. The query is deferred-executed. |\n| [Map(SqlBuilder, Type)][3] | Maps the results of the *query* to objects of type specified by the *resultType* parameter. The query is deferred-executed. |\n| **Map<TResult>(SqlBuilder)** | Maps the results of the *query* to TResult objects. The query is deferred-executed. |\n| [Map<TResult>(SqlBuilder, Func<DbDataReader, TResult>)][4] | Maps the results of the *query* to TResult objects, using the provided *mapper* delegate. |\n\n\nSyntax\n------\n\n```csharp\npublic IEnumerable Map(\n\tSqlBuilder query\n)\n\n```\n\n#### Parameters\n\n##### *query* [SqlBuilder][5]\nThe query.\n\n#### Type Parameters\n\n##### *TResult*\nThe type of objects to map the results to.\n\n#### Return Value\n[IEnumerable][6]<**TResult**> \nThe results of the query as TResult objects.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Map.md\n[3]: Map_1.md\n[4]: Map__1_1.md\n[5]: ../SqlBuilder/README.md\n[6]: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/Map__1_1.md",
"content": "Database.Map<TResult>(SqlBuilder, Func<DbDataReader, TResult>) Method\n===========================================================================\nMaps the results of the *query* to TResult objects, using the provided *mapper* delegate.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| [Map(SqlBuilder)][2] | Maps the results of the *query* to dynamic objects. The query is deferred-executed. |\n| [Map(SqlBuilder, Type)][3] | Maps the results of the *query* to objects of type specified by the *resultType* parameter. The query is deferred-executed. |\n| [Map<TResult>(SqlBuilder)][4] | Maps the results of the *query* to TResult objects. The query is deferred-executed. |\n| **Map<TResult>(SqlBuilder, Func<DbDataReader, TResult>)** | Maps the results of the *query* to TResult objects, using the provided *mapper* delegate. |\n\n\nSyntax\n------\n\n```csharp\npublic IEnumerable Map(\n\tSqlBuilder query,\n\tFunc mapper\n)\n\n```\n\n#### Parameters\n\n##### *query* [SqlBuilder][5]\nThe query.\n\n##### *mapper* [Func][6]<[DbDataReader][7], **TResult**>\nThe delegate for creating TResult objects from an [DbDataReader][7] object.\n\n#### Type Parameters\n\n##### *TResult*\nThe type of objects to map the results to.\n\n#### Return Value\n[IEnumerable][8]<**TResult**> \nThe results of the query as TResult objects.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][9] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Map.md\n[3]: Map_1.md\n[4]: Map__1.md\n[5]: ../SqlBuilder/README.md\n[6]: https://learn.microsoft.com/dotnet/api/system.func-2\n[7]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[8]: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/QuoteIdentifier.md",
"content": "Database.QuoteIdentifier Method\n===============================\nGiven an unquoted identifier in the correct catalog case, returns the correct quoted form of that identifier.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic string QuoteIdentifier(\n\tstring identifier\n)\n```\n\n#### Parameters\n\n##### *identifier* [String][2]\nThe original identifier.\n\n#### Return Value\n[String][2] \nThe quoted version of the identifier. If the indentifier is already quoted it's returned unchanged.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.string\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/README.md",
"content": "Database Class\n==============\nProvides simple data access using [SqlSet][1], [SqlBuilder][2] and [SqlTable<TEntity>][3].\n\n\nInheritance Hierarchy\n---------------------\n[System.Object][4] \n **DbExtensions.Database** \n \n**Namespace:** [DbExtensions][5] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic class Database : IDisposable\n```\n\nThe **Database** type exposes the following members.\n\n\nConstructors\n------------\n\n| Name | Description |\n| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------ |\n| [Database(DbConnection)][6] | Initializes a new instance of the **Database** class using the provided connection. |\n| [Database(String, String)][7] | Initializes a new instance of the **Database** class using the provided connection string and provider's invariant name. |\n\n\nProperties\n----------\n\n| Name | Description |\n| ------------------ | ----------------------------------------------------------- |\n| [Configuration][8] | Provides access to configuration options for this instance. |\n| [Connection][9] | Gets the connection to associate with new commands. |\n| [Transaction][10] | Gets or sets a transaction to associate with new commands. |\n\n\nMethods\n-------\n\n| Name | Description |\n| ----------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |\n| [Add][11] | Recursively executes INSERT commands for the specified *entity* and all its one-to-one and one-to-many associations. |\n| [AddAsync][12] | Recursively executes INSERT commands for the specified *entity* and all its one-to-one and one-to-many associations. |\n| [AsyncMap(SqlBuilder)][13] | Maps the results of the *query* to dynamic objects. The query is deferred-executed. |\n| [AsyncMap(SqlBuilder, Type)][14] | Maps the results of the *query* to objects of type specified by the *resultType* parameter. The query is deferred-executed. |\n| [AsyncMap<TResult>(SqlBuilder)][15] | Maps the results of the *query* to TResult objects. The query is deferred-executed. |\n| [AsyncMap<TResult>(SqlBuilder, Func<DbDataReader, TResult>)][16] | Maps the results of the *query* to TResult objects, using the provided *mapper* delegate. |\n| [CreateCommand][17] | Creates and returns a [DbCommand][18] object from the specified *sqlBuilder*. |\n| [Dispose()][19] | Releases all resources used by the current instance of the **Database** class. |\n| [Dispose(Boolean)][20] | Releases the resources used by this **Database** instance. |\n| [EnsureConnectionOpen][21] | Opens [Connection][9] (if it's not open) and returns an [IDisposable][22] object you can use to close it (if it wasn't open). |\n| [EnsureConnectionOpenAsync][23] | Opens [Connection][9] (if it's not open) and returns an [IAsyncDisposable][24] object you can use to close it (if it wasn't open). |\n| [EnsureInTransaction()][25] | Returns a virtual transaction that you can use to ensure a code block is always executed in a transaction, new or existing. |\n| [EnsureInTransaction(IsolationLevel)][26] | Returns a virtual transaction that you can use to ensure a code block is always executed in a transaction, new or existing. |\n| [EnsureInTransactionAsync(CancellationToken)][27] | Returns a virtual transaction that you can use to ensure a code block is always executed in a transaction, new or existing. |\n| [EnsureInTransactionAsync(IsolationLevel, CancellationToken)][28] | Returns a virtual transaction that you can use to ensure a code block is always executed in a transaction, new or existing. |\n| [Execute][29] | Executes the *nonQuery* command. Optionally uses a transaction and validates affected records value before committing. |\n| [ExecuteAsync][30] | Executes the *nonQuery* command. Optionally uses a transaction and validates affected records value before committing. |\n| [Find<TEntity>][31] | Gets the entity whose primary key matches the *id* parameter. |\n| [FindAsync<TEntity>][32] | Gets the entity whose primary key matches the *id* parameter. |\n| [From(String)][33] | Creates and returns a new [SqlSet][1] using the provided table name. |\n| [From(String, Type)][34] | Creates and returns a new [SqlSet][1] using the provided table name. |\n| [From<TResult>(String)][35] | Creates and returns a new [SqlSet<TResult>][36] using the provided table name. |\n| [FromQuery(SqlBuilder)][37] | Creates and returns a new [SqlSet][1] using the provided defining query. |\n| [FromQuery(SqlBuilder, Type)][38] | Creates and returns a new [SqlSet][1] using the provided defining query. |\n| [FromQuery<TResult>(SqlBuilder)][39] | Creates and returns a new [SqlSet<TResult>][36] using the provided defining query. |\n| [FromQuery<TResult>(SqlBuilder, Func<DbDataReader, TResult>)][40] | Creates and returns a new [SqlSet<TResult>][36] using the provided defining query and mapper. |\n| [LastInsertId][41] | Gets the identity value of the last inserted record. |\n| [LastInsertIdAsync][42] | Gets the identity value of the last inserted record. |\n| [Map(SqlBuilder)][43] | Maps the results of the *query* to dynamic objects. The query is deferred-executed. |\n| [Map(SqlBuilder, Type)][44] | Maps the results of the *query* to objects of type specified by the *resultType* parameter. The query is deferred-executed. |\n| [Map<TResult>(SqlBuilder)][45] | Maps the results of the *query* to TResult objects. The query is deferred-executed. |\n| [Map<TResult>(SqlBuilder, Func<DbDataReader, TResult>)][46] | Maps the results of the *query* to TResult objects, using the provided *mapper* delegate. |\n| [QuoteIdentifier][47] | Given an unquoted identifier in the correct catalog case, returns the correct quoted form of that identifier. |\n| [Remove][48] | Executes a DELETE command for the specified *entity*. |\n| [RemoveAsync][49] | Executes a DELETE command for the specified *entity*. |\n| [Table(Type)][50] | Returns the [SqlTable][51] instance for the specified *entityType*. |\n| [Table<TEntity>()][52] | Returns the [SqlTable<TEntity>][3] instance for the specified TEntity. |\n| [Update(Object)][53] | Executes an UPDATE command for the specified *entity*. |\n| [Update(Object, Object)][54] | Executes an UPDATE command for the specified *entity*. |\n| [UpdateAsync(Object, CancellationToken)][55] | Executes an UPDATE command for the specified *entity*. |\n| [UpdateAsync(Object, Object, CancellationToken)][56] | Executes an UPDATE command for the specified *entity*. |\n\n\nSee Also\n--------\n\n#### Reference\n[DbExtensions Namespace][5] \n\n[1]: ../SqlSet/README.md\n[2]: ../SqlBuilder/README.md\n[3]: ../SqlTable_1/README.md\n[4]: https://learn.microsoft.com/dotnet/api/system.object\n[5]: ../README.md\n[6]: _ctor.md\n[7]: _ctor_1.md\n[8]: Configuration.md\n[9]: Connection.md\n[10]: Transaction.md\n[11]: Add.md\n[12]: AddAsync.md\n[13]: AsyncMap.md\n[14]: AsyncMap_1.md\n[15]: AsyncMap__1.md\n[16]: AsyncMap__1_1.md\n[17]: CreateCommand.md\n[18]: https://learn.microsoft.com/dotnet/api/system.data.common.dbcommand\n[19]: Dispose.md\n[20]: Dispose_1.md\n[21]: EnsureConnectionOpen.md\n[22]: https://learn.microsoft.com/dotnet/api/system.idisposable\n[23]: EnsureConnectionOpenAsync.md\n[24]: https://learn.microsoft.com/dotnet/api/system.iasyncdisposable\n[25]: EnsureInTransaction.md\n[26]: EnsureInTransaction_1.md\n[27]: EnsureInTransactionAsync_1.md\n[28]: EnsureInTransactionAsync.md\n[29]: Execute.md\n[30]: ExecuteAsync.md\n[31]: Find__1.md\n[32]: FindAsync__1.md\n[33]: From.md\n[34]: From_1.md\n[35]: From__1.md\n[36]: ../SqlSet_1/README.md\n[37]: FromQuery.md\n[38]: FromQuery_1.md\n[39]: FromQuery__1.md\n[40]: FromQuery__1_1.md\n[41]: LastInsertId.md\n[42]: LastInsertIdAsync.md\n[43]: Map.md\n[44]: Map_1.md\n[45]: Map__1.md\n[46]: Map__1_1.md\n[47]: QuoteIdentifier.md\n[48]: Remove.md\n[49]: RemoveAsync.md\n[50]: Table.md\n[51]: ../SqlTable/README.md\n[52]: Table__1.md\n[53]: Update.md\n[54]: Update_1.md\n[55]: UpdateAsync_1.md\n[56]: UpdateAsync.md"
},
{
"path": "docs/api/DbExtensions/Database/Remove.md",
"content": "Database.Remove Method\n======================\nExecutes a DELETE command for the specified *entity*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic bool Remove(\n\tObject entity\n)\n```\n\n#### Parameters\n\n##### *entity* [Object][2]\nThe entity whose DELETE command is to be executed.\n\n#### Return Value\n[Boolean][3] \n`true` if *entity* is deleted; otherwise, `false`.\n\nRemarks\n-------\nThis method is a shortcut for `db.Table(entity.GetType()).Remove(entity)`.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][4] \n[DbExtensions Namespace][1] \n[SqlTable.Remove(Object)][5] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: https://learn.microsoft.com/dotnet/api/system.boolean\n[4]: README.md\n[5]: ../SqlTable/Remove.md"
},
{
"path": "docs/api/DbExtensions/Database/RemoveAsync.md",
"content": "Database.RemoveAsync Method\n===========================\nExecutes a DELETE command for the specified *entity*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic ValueTask RemoveAsync(\n\tObject entity,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *entity* [Object][2]\nThe entity whose DELETE command is to be executed.\n\n##### *cancellationToken* [CancellationToken][3] (Optional)\nThe [CancellationToken][3] to monitor for cancellation requests. The default is [None][4].\n\n#### Return Value\n[ValueTask][5]<[Boolean][6]> \n`true` if *entity* is deleted; otherwise, `false`.\n\nRemarks\n-------\nThis method is a shortcut for `await db.Table(entity.GetType()).RemoveAsync(entity, cancellationToken)`.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][7] \n[DbExtensions Namespace][1] \n[SqlTable.RemoveAsync(Object, CancellationToken)][8] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[6]: https://learn.microsoft.com/dotnet/api/system.boolean\n[7]: README.md\n[8]: ../SqlTable/RemoveAsync.md"
},
{
"path": "docs/api/DbExtensions/Database/Table.md",
"content": "Database.Table(Type) Method\n===========================\nReturns the [SqlTable][1] instance for the specified *entityType*.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------ | ------------------------------------------------------------------------- |\n| **Table(Type)** | Returns the [SqlTable][1] instance for the specified *entityType*. |\n| [Table<TEntity>()][3] | Returns the [SqlTable<TEntity>][4] instance for the specified TEntity. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlTable Table(\n\tType entityType\n)\n```\n\n#### Parameters\n\n##### *entityType* [Type][5]\nThe type of the entity.\n\n#### Return Value\n[SqlTable][1] \nThe [SqlTable][1] instance for *entityType*.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][6] \n[DbExtensions Namespace][2] \n\n[1]: ../SqlTable/README.md\n[2]: ../README.md\n[3]: Table__1.md\n[4]: ../SqlTable_1/README.md\n[5]: https://learn.microsoft.com/dotnet/api/system.type\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/Table__1.md",
"content": "Database.Table<TEntity> Method\n=================================\nReturns the [SqlTable<TEntity>][1] instance for the specified TEntity.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------- | ------------------------------------------------------------------------- |\n| [Table(Type)][3] | Returns the [SqlTable][4] instance for the specified *entityType*. |\n| **Table<TEntity>()** | Returns the [SqlTable<TEntity>][1] instance for the specified TEntity. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlTable Table()\nwhere TEntity : class\n\n```\n\n#### Type Parameters\n\n##### *TEntity*\nThe type of the entity.\n\n#### Return Value\n[SqlTable][1]<**TEntity**> \nThe [SqlTable<TEntity>][1] instance for TEntity.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][5] \n[DbExtensions Namespace][2] \n\n[1]: ../SqlTable_1/README.md\n[2]: ../README.md\n[3]: Table.md\n[4]: ../SqlTable/README.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/Transaction.md",
"content": "Database.Transaction Property\n=============================\nGets or sets a transaction to associate with new commands.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic DbTransaction? Transaction { get; set; }\n```\n\n#### Property Value\n[DbTransaction][2]\n\nSee Also\n--------\n\n#### Reference\n[Database Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.data.common.dbtransaction\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/Database/Update.md",
"content": "Database.Update(Object) Method\n==============================\nExecutes an UPDATE command for the specified *entity*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------- | ------------------------------------------------------ |\n| **Update(Object)** | Executes an UPDATE command for the specified *entity*. |\n| [Update(Object, Object)][2] | Executes an UPDATE command for the specified *entity*. |\n\n\nSyntax\n------\n\n```csharp\npublic void Update(\n\tObject entity\n)\n```\n\n#### Parameters\n\n##### *entity* [Object][3]\nThe entity whose UPDATE command is to be executed.\n\n\nRemarks\n-------\nThis method is a shortcut for `db.Table(entity.GetType()).Update(entity)`.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][4] \n[DbExtensions Namespace][1] \n[SqlTable.Update(Object)][5] \n\n[1]: ../README.md\n[2]: Update_1.md\n[3]: https://learn.microsoft.com/dotnet/api/system.object\n[4]: README.md\n[5]: ../SqlTable/Update.md"
},
{
"path": "docs/api/DbExtensions/Database/UpdateAsync.md",
"content": "Database.UpdateAsync(Object, Object, CancellationToken) Method\n==============================================================\nExecutes an UPDATE command for the specified *entity*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------- | ------------------------------------------------------ |\n| [UpdateAsync(Object, CancellationToken)][2] | Executes an UPDATE command for the specified *entity*. |\n| **UpdateAsync(Object, Object, CancellationToken)** | Executes an UPDATE command for the specified *entity*. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask UpdateAsync(\n\tObject entity,\n\tObject? originalId,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *entity* [Object][3]\nThe entity whose UPDATE command is to be executed.\n\n##### *originalId* [Object][3]\nThe original primary key value.\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]\n\nRemarks\n-------\nThis method is a shortcut for `await db.Table(entity.GetType()).UpdateAsync(entity, originalId, cancellationToken)`.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][7] \n[DbExtensions Namespace][1] \n[SqlTable.UpdateAsync(Object, Object, CancellationToken)][8] \n\n[1]: ../README.md\n[2]: UpdateAsync_1.md\n[3]: https://learn.microsoft.com/dotnet/api/system.object\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask\n[7]: README.md\n[8]: ../SqlTable/UpdateAsync.md"
},
{
"path": "docs/api/DbExtensions/Database/UpdateAsync_1.md",
"content": "Database.UpdateAsync(Object, CancellationToken) Method\n======================================================\nExecutes an UPDATE command for the specified *entity*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------- | ------------------------------------------------------ |\n| **UpdateAsync(Object, CancellationToken)** | Executes an UPDATE command for the specified *entity*. |\n| [UpdateAsync(Object, Object, CancellationToken)][2] | Executes an UPDATE command for the specified *entity*. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask UpdateAsync(\n\tObject entity,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *entity* [Object][3]\nThe entity whose UPDATE command is to be executed.\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]\n\nRemarks\n-------\nThis method is a shortcut for `await db.Table(entity.GetType()).UpdateAsync(entity, cancellationToken)`.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][7] \n[DbExtensions Namespace][1] \n[SqlTable.UpdateAsync(Object, CancellationToken)][8] \n\n[1]: ../README.md\n[2]: UpdateAsync.md\n[3]: https://learn.microsoft.com/dotnet/api/system.object\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask\n[7]: README.md\n[8]: ../SqlTable/UpdateAsync_1.md"
},
{
"path": "docs/api/DbExtensions/Database/Update_1.md",
"content": "Database.Update(Object, Object) Method\n======================================\nExecutes an UPDATE command for the specified *entity*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------- | ------------------------------------------------------ |\n| [Update(Object)][2] | Executes an UPDATE command for the specified *entity*. |\n| **Update(Object, Object)** | Executes an UPDATE command for the specified *entity*. |\n\n\nSyntax\n------\n\n```csharp\npublic void Update(\n\tObject entity,\n\tObject? originalId\n)\n```\n\n#### Parameters\n\n##### *entity* [Object][3]\nThe entity whose UPDATE command is to be executed.\n\n##### *originalId* [Object][3]\nThe original primary key value.\n\n\nRemarks\n-------\nThis method is a shortcut for `db.Table(entity.GetType()).Update(entity, originalId)`.\n\nSee Also\n--------\n\n#### Reference\n[Database Class][4] \n[DbExtensions Namespace][1] \n[SqlTable.Update(Object, Object)][5] \n\n[1]: ../README.md\n[2]: Update.md\n[3]: https://learn.microsoft.com/dotnet/api/system.object\n[4]: README.md\n[5]: ../SqlTable/Update_1.md"
},
{
"path": "docs/api/DbExtensions/Database/_ctor.md",
"content": "Database(DbConnection) Constructor\n==================================\nInitializes a new instance of the [Database][1] class using the provided connection.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------- |\n| **Database(DbConnection)** | Initializes a new instance of the [Database][1] class using the provided connection. |\n| [Database(String, String)][3] | Initializes a new instance of the [Database][1] class using the provided connection string and provider's invariant name. |\n\n\nSyntax\n------\n\n```csharp\npublic Database(\n\tDbConnection connection\n)\n```\n\n#### Parameters\n\n##### *connection* [DbConnection][4]\nThe connection.\n\n\nSee Also\n--------\n\n#### Reference\n[Database Class][1] \n[DbExtensions Namespace][2] \n\n[1]: README.md\n[2]: ../README.md\n[3]: _ctor_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.data.common.dbconnection"
},
{
"path": "docs/api/DbExtensions/Database/_ctor_1.md",
"content": "Database(String, String) Constructor\n====================================\nInitializes a new instance of the [Database][1] class using the provided connection string and provider's invariant name.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------- |\n| [Database(DbConnection)][3] | Initializes a new instance of the [Database][1] class using the provided connection. |\n| **Database(String, String)** | Initializes a new instance of the [Database][1] class using the provided connection string and provider's invariant name. |\n\n\nSyntax\n------\n\n```csharp\npublic Database(\n\tstring connectionString,\n\tstring providerInvariantName\n)\n```\n\n#### Parameters\n\n##### *connectionString* [String][4]\nThe connection string.\n\n##### *providerInvariantName* [String][4]\nThe provider's invariant name.\n\n\nSee Also\n--------\n\n#### Reference\n[Database Class][1] \n[DbExtensions Namespace][2] \n\n[1]: README.md\n[2]: ../README.md\n[3]: _ctor.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string"
},
{
"path": "docs/api/DbExtensions/DatabaseConfiguration/CommandTimeout.md",
"content": "DatabaseConfiguration.CommandTimeout Property\n=============================================\nSpecifies a timeout to assign to commands. This setting is ignored if less or equal to -1. The default is -1.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic int CommandTimeout { get; set; }\n```\n\n#### Property Value\n[Int32][2]\n\nSee Also\n--------\n\n#### Reference\n[DatabaseConfiguration Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.int32\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/DatabaseConfiguration/DefaultComplexPropertySeparator.md",
"content": "DatabaseConfiguration.DefaultComplexPropertySeparator Property\n==============================================================\nThe default separator to use when mapping complex properties. The default value is null, which means no separator is used, unless an explicit separator is specified on [ComplexPropertyAttribute.Separator][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic string? DefaultComplexPropertySeparator { get; set; }\n```\n\n#### Property Value\n[String][3]\n\nSee Also\n--------\n\n#### Reference\n[DatabaseConfiguration Class][4] \n[DbExtensions Namespace][2] \n\n[1]: ../ComplexPropertyAttribute/Separator.md\n[2]: ../README.md\n[3]: https://learn.microsoft.com/dotnet/api/system.string\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/DatabaseConfiguration/EnableBatchCommands.md",
"content": "DatabaseConfiguration.EnableBatchCommands Property\n==================================================\n`true` to execute batch commands when possible; otherwise, `false`. The default is `true`.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic bool EnableBatchCommands { get; set; }\n```\n\n#### Property Value\n[Boolean][2]\n\nRemarks\n-------\nThis setting affects the behavior of [AddRange(TEntity[])][3], [UpdateRange(TEntity[])][4] and [RemoveRange(TEntity[])][5].\n\nSee Also\n--------\n\n#### Reference\n[DatabaseConfiguration Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.boolean\n[3]: ../SqlTable_1/AddRange_1.md\n[4]: ../SqlTable_1/UpdateRange_1.md\n[5]: ../SqlTable_1/RemoveRange_1.md\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/DatabaseConfiguration/LastInsertIdCommand.md",
"content": "DatabaseConfiguration.LastInsertIdCommand Property\n==================================================\nGets or sets the SQL command that returns the last identity value generated on the database.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic string LastInsertIdCommand { get; set; }\n```\n\n#### Property Value\n[String][2]\n\nSee Also\n--------\n\n#### Reference\n[DatabaseConfiguration Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.string\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/DatabaseConfiguration/Log.md",
"content": "DatabaseConfiguration.Log Property\n==================================\nSpecifies the destination to write the SQL query or command.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic TextWriter? Log { get; set; }\n```\n\n#### Property Value\n[TextWriter][2]\n\nSee Also\n--------\n\n#### Reference\n[DatabaseConfiguration Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.io.textwriter\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/DatabaseConfiguration/ParameterNameBuilder.md",
"content": "DatabaseConfiguration.ParameterNameBuilder Property\n===================================================\nSpecifies a function that prepares a parameter name to be used on [DbParameter.ParameterName][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic Func ParameterNameBuilder { get; set; }\n```\n\n#### Property Value\n[Func][3]<[String][4], [String][4]>\n\nSee Also\n--------\n\n#### Reference\n[DatabaseConfiguration Class][5] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.data.common.dbparameter.parametername\n[2]: ../README.md\n[3]: https://learn.microsoft.com/dotnet/api/system.func-2\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/DatabaseConfiguration/ParameterPlaceholderBuilder.md",
"content": "DatabaseConfiguration.ParameterPlaceholderBuilder Property\n==========================================================\nSpecifies a function that builds a parameter placeholder to be used in SQL statements.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic Func ParameterPlaceholderBuilder { get; set; }\n```\n\n#### Property Value\n[Func][2]<[String][3], [String][3]>\n\nSee Also\n--------\n\n#### Reference\n[DatabaseConfiguration Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.func-2\n[3]: https://learn.microsoft.com/dotnet/api/system.string\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/DatabaseConfiguration/QuotePrefix.md",
"content": "DatabaseConfiguration.QuotePrefix Property\n==========================================\nGets or sets the beginning character or characters to use when specifying database objects (for example, tables or columns) whose names contain characters such as spaces or reserved tokens.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic string QuotePrefix { get; set; }\n```\n\n#### Property Value\n[String][2]\n\nSee Also\n--------\n\n#### Reference\n[DatabaseConfiguration Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.string\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/DatabaseConfiguration/QuoteSuffix.md",
"content": "DatabaseConfiguration.QuoteSuffix Property\n==========================================\nGets or sets the ending character or characters to use when specifying database objects (for example, tables or columns) whose names contain characters such as spaces or reserved tokens.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic string QuoteSuffix { get; set; }\n```\n\n#### Property Value\n[String][2]\n\nSee Also\n--------\n\n#### Reference\n[DatabaseConfiguration Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.string\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/DatabaseConfiguration/README.md",
"content": "DatabaseConfiguration Class\n===========================\nHolds configuration options that customize the behavior of [Database][1]. This class cannot be instantiated, to get an instance use the [Configuration][2] property.\n\n\nInheritance Hierarchy\n---------------------\n[System.Object][3] \n **DbExtensions.DatabaseConfiguration** \n \n**Namespace:** [DbExtensions][4] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic sealed class DatabaseConfiguration\n```\n\nThe **DatabaseConfiguration** type exposes the following members.\n\n\nProperties\n----------\n\n| Name | Description |\n| ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [CommandTimeout][5] | Specifies a timeout to assign to commands. This setting is ignored if less or equal to -1. The default is -1. |\n| [DefaultComplexPropertySeparator][6] | The default separator to use when mapping complex properties. The default value is null, which means no separator is used, unless an explicit separator is specified on [ComplexPropertyAttribute.Separator][7]. |\n| [EnableBatchCommands][8] | `true` to execute batch commands when possible; otherwise, `false`. The default is `true`. |\n| [LastInsertIdCommand][9] | Gets or sets the SQL command that returns the last identity value generated on the database. |\n| [Log][10] | Specifies the destination to write the SQL query or command. |\n| [ParameterNameBuilder][11] | Specifies a function that prepares a parameter name to be used on [DbParameter.ParameterName][12]. |\n| [ParameterPlaceholderBuilder][13] | Specifies a function that builds a parameter placeholder to be used in SQL statements. |\n| [QuotePrefix][14] | Gets or sets the beginning character or characters to use when specifying database objects (for example, tables or columns) whose names contain characters such as spaces or reserved tokens. |\n| [QuoteSuffix][15] | Gets or sets the ending character or characters to use when specifying database objects (for example, tables or columns) whose names contain characters such as spaces or reserved tokens. |\n| [UseVersionMember][16] | `true` to include version column check in SQL statements' predicates; otherwise, `false`. The default is `true`. |\n\n\nSee Also\n--------\n\n#### Reference\n[DbExtensions Namespace][4] \n\n[1]: ../Database/README.md\n[2]: ../Database/Configuration.md\n[3]: https://learn.microsoft.com/dotnet/api/system.object\n[4]: ../README.md\n[5]: CommandTimeout.md\n[6]: DefaultComplexPropertySeparator.md\n[7]: ../ComplexPropertyAttribute/Separator.md\n[8]: EnableBatchCommands.md\n[9]: LastInsertIdCommand.md\n[10]: Log.md\n[11]: ParameterNameBuilder.md\n[12]: https://learn.microsoft.com/dotnet/api/system.data.common.dbparameter.parametername\n[13]: ParameterPlaceholderBuilder.md\n[14]: QuotePrefix.md\n[15]: QuoteSuffix.md\n[16]: UseVersionMember.md"
},
{
"path": "docs/api/DbExtensions/DatabaseConfiguration/UseVersionMember.md",
"content": "DatabaseConfiguration.UseVersionMember Property\n===============================================\n`true` to include version column check in SQL statements' predicates; otherwise, `false`. The default is `true`.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic bool UseVersionMember { get; set; }\n```\n\n#### Property Value\n[Boolean][2]\n\nSee Also\n--------\n\n#### Reference\n[DatabaseConfiguration Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.boolean\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetBoolean.md",
"content": "Extensions.GetBoolean Method\n============================\nGets the value of the specified column as a [Boolean][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic static bool GetBoolean(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][3]\nThe data reader.\n\n##### *name* [String][4]\nThe name of the column to find.\n\n#### Return Value\n[Boolean][1] \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][3]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][5] or [Extension Methods (C# Programming Guide)][6].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][7] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.boolean\n[2]: ../README.md\n[3]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[6]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetByte.md",
"content": "Extensions.GetByte Method\n=========================\nGets the value of the specified column as a [Byte][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic static byte GetByte(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][3]\nThe data reader.\n\n##### *name* [String][4]\nThe name of the column to find.\n\n#### Return Value\n[Byte][1] \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][3]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][5] or [Extension Methods (C# Programming Guide)][6].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][7] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.byte\n[2]: ../README.md\n[3]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[6]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetChar.md",
"content": "Extensions.GetChar Method\n=========================\nGets the value of the specified column as a [Char][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic static char GetChar(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][3]\nThe data reader.\n\n##### *name* [String][4]\nThe name of the column to find.\n\n#### Return Value\n[Char][1] \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][3]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][5] or [Extension Methods (C# Programming Guide)][6].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][7] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.char\n[2]: ../README.md\n[3]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[6]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetDateTime.md",
"content": "Extensions.GetDateTime Method\n=============================\nGets the value of the specified column as a [DateTime][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic static DateTime GetDateTime(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][3]\nThe data reader.\n\n##### *name* [String][4]\nThe name of the column to find.\n\n#### Return Value\n[DateTime][1] \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][3]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][5] or [Extension Methods (C# Programming Guide)][6].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][7] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.datetime\n[2]: ../README.md\n[3]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[6]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetDecimal.md",
"content": "Extensions.GetDecimal Method\n============================\nGets the value of the specified column as a [Decimal][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic static decimal GetDecimal(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][3]\nThe data reader.\n\n##### *name* [String][4]\nThe name of the column to find.\n\n#### Return Value\n[Decimal][1] \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][3]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][5] or [Extension Methods (C# Programming Guide)][6].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][7] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.decimal\n[2]: ../README.md\n[3]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[6]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetDouble.md",
"content": "Extensions.GetDouble Method\n===========================\nGets the value of the specified column as a [Double][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic static double GetDouble(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][3]\nThe data reader.\n\n##### *name* [String][4]\nThe name of the column to find.\n\n#### Return Value\n[Double][1] \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][3]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][5] or [Extension Methods (C# Programming Guide)][6].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][7] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.double\n[2]: ../README.md\n[3]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[6]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetFloat.md",
"content": "Extensions.GetFloat Method\n==========================\nGets the value of the specified column as a [Single][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic static float GetFloat(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][3]\nThe data reader.\n\n##### *name* [String][4]\nThe name of the column to find.\n\n#### Return Value\n[Single][1] \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][3]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][5] or [Extension Methods (C# Programming Guide)][6].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][7] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.single\n[2]: ../README.md\n[3]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[6]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetInt16.md",
"content": "Extensions.GetInt16 Method\n==========================\nGets the value of the specified column as an [Int16][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic static short GetInt16(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][3]\nThe data reader.\n\n##### *name* [String][4]\nThe name of the column to find.\n\n#### Return Value\n[Int16][1] \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][3]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][5] or [Extension Methods (C# Programming Guide)][6].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][7] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.int16\n[2]: ../README.md\n[3]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[6]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetInt32.md",
"content": "Extensions.GetInt32 Method\n==========================\nGets the value of the specified column as an [Int32][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic static int GetInt32(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][3]\nThe data reader.\n\n##### *name* [String][4]\nThe name of the column to find.\n\n#### Return Value\n[Int32][1] \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][3]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][5] or [Extension Methods (C# Programming Guide)][6].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][7] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.int32\n[2]: ../README.md\n[3]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[6]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetInt64.md",
"content": "Extensions.GetInt64 Method\n==========================\nGets the value of the specified column as an [Int64][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic static long GetInt64(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][3]\nThe data reader.\n\n##### *name* [String][4]\nThe name of the column to find.\n\n#### Return Value\n[Int64][1] \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][3]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][5] or [Extension Methods (C# Programming Guide)][6].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][7] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.int64\n[2]: ../README.md\n[3]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[6]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetNullableBoolean.md",
"content": "Extensions.GetNullableBoolean(DbDataReader, Int32) Method\n=========================================================\nGets the value of the specified column as a [Nullable<T>][1] of [Boolean][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------- | -------------------------------------------------------------------------------- |\n| **GetNullableBoolean(DbDataReader, Int32)** | Gets the value of the specified column as a [Nullable<T>][1] of [Boolean][2]. |\n| [GetNullableBoolean(DbDataReader, String)][4] | Gets the value of the specified column as a [Nullable<T>][1] of [Boolean][2]. |\n\n\nSyntax\n------\n\n```csharp\npublic static bool? GetNullableBoolean(\n\tthis DbDataReader reader,\n\tint i\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][5]\nThe data reader.\n\n##### *i* [Int32][6]\nThe zero-based column ordinal.\n\n#### Return Value\n[Nullable][1]<[Boolean][2]> \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][5]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][7] or [Extension Methods (C# Programming Guide)][8].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][9] \n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.nullable-1\n[2]: https://learn.microsoft.com/dotnet/api/system.boolean\n[3]: ../README.md\n[4]: GetNullableBoolean_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[6]: https://learn.microsoft.com/dotnet/api/system.int32\n[7]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[8]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetNullableBoolean_1.md",
"content": "Extensions.GetNullableBoolean(DbDataReader, String) Method\n==========================================================\nGets the value of the specified column as a [Nullable<T>][1] of [Boolean][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------- | -------------------------------------------------------------------------------- |\n| [GetNullableBoolean(DbDataReader, Int32)][4] | Gets the value of the specified column as a [Nullable<T>][1] of [Boolean][2]. |\n| **GetNullableBoolean(DbDataReader, String)** | Gets the value of the specified column as a [Nullable<T>][1] of [Boolean][2]. |\n\n\nSyntax\n------\n\n```csharp\npublic static bool? GetNullableBoolean(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][5]\nThe data reader.\n\n##### *name* [String][6]\nThe name of the column to find.\n\n#### Return Value\n[Nullable][1]<[Boolean][2]> \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][5]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][7] or [Extension Methods (C# Programming Guide)][8].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][9] \n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.nullable-1\n[2]: https://learn.microsoft.com/dotnet/api/system.boolean\n[3]: ../README.md\n[4]: GetNullableBoolean.md\n[5]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[6]: https://learn.microsoft.com/dotnet/api/system.string\n[7]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[8]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetNullableByte.md",
"content": "Extensions.GetNullableByte(DbDataReader, Int32) Method\n======================================================\nGets the value of the specified column as a [Nullable<T>][1] of [Byte][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------ | ----------------------------------------------------------------------------- |\n| **GetNullableByte(DbDataReader, Int32)** | Gets the value of the specified column as a [Nullable<T>][1] of [Byte][2]. |\n| [GetNullableByte(DbDataReader, String)][4] | Gets the value of the specified column as a [Nullable<T>][1] of [Byte][2]. |\n\n\nSyntax\n------\n\n```csharp\npublic static byte? GetNullableByte(\n\tthis DbDataReader reader,\n\tint i\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][5]\nThe data reader.\n\n##### *i* [Int32][6]\nThe zero-based column ordinal.\n\n#### Return Value\n[Nullable][1]<[Byte][2]> \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][5]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][7] or [Extension Methods (C# Programming Guide)][8].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][9] \n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.nullable-1\n[2]: https://learn.microsoft.com/dotnet/api/system.byte\n[3]: ../README.md\n[4]: GetNullableByte_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[6]: https://learn.microsoft.com/dotnet/api/system.int32\n[7]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[8]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetNullableByte_1.md",
"content": "Extensions.GetNullableByte(DbDataReader, String) Method\n=======================================================\nGets the value of the specified column as a [Nullable<T>][1] of [Byte][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------- | ----------------------------------------------------------------------------- |\n| [GetNullableByte(DbDataReader, Int32)][4] | Gets the value of the specified column as a [Nullable<T>][1] of [Byte][2]. |\n| **GetNullableByte(DbDataReader, String)** | Gets the value of the specified column as a [Nullable<T>][1] of [Byte][2]. |\n\n\nSyntax\n------\n\n```csharp\npublic static byte? GetNullableByte(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][5]\nThe data reader.\n\n##### *name* [String][6]\nThe name of the column to find.\n\n#### Return Value\n[Nullable][1]<[Byte][2]> \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][5]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][7] or [Extension Methods (C# Programming Guide)][8].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][9] \n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.nullable-1\n[2]: https://learn.microsoft.com/dotnet/api/system.byte\n[3]: ../README.md\n[4]: GetNullableByte.md\n[5]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[6]: https://learn.microsoft.com/dotnet/api/system.string\n[7]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[8]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetNullableChar.md",
"content": "Extensions.GetNullableChar(DbDataReader, Int32) Method\n======================================================\nGets the value of the specified column as a [Nullable<T>][1] of [Char][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------ | ----------------------------------------------------------------------------- |\n| **GetNullableChar(DbDataReader, Int32)** | Gets the value of the specified column as a [Nullable<T>][1] of [Char][2]. |\n| [GetNullableChar(DbDataReader, String)][4] | Gets the value of the specified column as a [Nullable<T>][1] of [Char][2]. |\n\n\nSyntax\n------\n\n```csharp\npublic static char? GetNullableChar(\n\tthis DbDataReader reader,\n\tint i\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][5]\nThe data reader.\n\n##### *i* [Int32][6]\nThe zero-based column ordinal.\n\n#### Return Value\n[Nullable][1]<[Char][2]> \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][5]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][7] or [Extension Methods (C# Programming Guide)][8].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][9] \n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.nullable-1\n[2]: https://learn.microsoft.com/dotnet/api/system.char\n[3]: ../README.md\n[4]: GetNullableChar_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[6]: https://learn.microsoft.com/dotnet/api/system.int32\n[7]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[8]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetNullableChar_1.md",
"content": "Extensions.GetNullableChar(DbDataReader, String) Method\n=======================================================\nGets the value of the specified column as a [Nullable<T>][1] of [Char][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------- | ----------------------------------------------------------------------------- |\n| [GetNullableChar(DbDataReader, Int32)][4] | Gets the value of the specified column as a [Nullable<T>][1] of [Char][2]. |\n| **GetNullableChar(DbDataReader, String)** | Gets the value of the specified column as a [Nullable<T>][1] of [Char][2]. |\n\n\nSyntax\n------\n\n```csharp\npublic static char? GetNullableChar(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][5]\nThe data reader.\n\n##### *name* [String][6]\nThe name of the column to find.\n\n#### Return Value\n[Nullable][1]<[Char][2]> \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][5]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][7] or [Extension Methods (C# Programming Guide)][8].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][9] \n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.nullable-1\n[2]: https://learn.microsoft.com/dotnet/api/system.char\n[3]: ../README.md\n[4]: GetNullableChar.md\n[5]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[6]: https://learn.microsoft.com/dotnet/api/system.string\n[7]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[8]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetNullableDateTime.md",
"content": "Extensions.GetNullableDateTime(DbDataReader, Int32) Method\n==========================================================\nGets the value of the specified column as a [Nullable<T>][1] of [DateTime][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------- | --------------------------------------------------------------------------------- |\n| **GetNullableDateTime(DbDataReader, Int32)** | Gets the value of the specified column as a [Nullable<T>][1] of [DateTime][2]. |\n| [GetNullableDateTime(DbDataReader, String)][4] | Gets the value of the specified column as a [Nullable<T>][1] of [DateTime][2]. |\n\n\nSyntax\n------\n\n```csharp\npublic static DateTime? GetNullableDateTime(\n\tthis DbDataReader reader,\n\tint i\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][5]\nThe data reader.\n\n##### *i* [Int32][6]\nThe zero-based column ordinal.\n\n#### Return Value\n[Nullable][1]<[DateTime][2]> \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][5]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][7] or [Extension Methods (C# Programming Guide)][8].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][9] \n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.nullable-1\n[2]: https://learn.microsoft.com/dotnet/api/system.datetime\n[3]: ../README.md\n[4]: GetNullableDateTime_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[6]: https://learn.microsoft.com/dotnet/api/system.int32\n[7]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[8]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetNullableDateTime_1.md",
"content": "Extensions.GetNullableDateTime(DbDataReader, String) Method\n===========================================================\nGets the value of the specified column as a [Nullable<T>][1] of [DateTime][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------- | --------------------------------------------------------------------------------- |\n| [GetNullableDateTime(DbDataReader, Int32)][4] | Gets the value of the specified column as a [Nullable<T>][1] of [DateTime][2]. |\n| **GetNullableDateTime(DbDataReader, String)** | Gets the value of the specified column as a [Nullable<T>][1] of [DateTime][2]. |\n\n\nSyntax\n------\n\n```csharp\npublic static DateTime? GetNullableDateTime(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][5]\nThe data reader.\n\n##### *name* [String][6]\nThe name of the column to find.\n\n#### Return Value\n[Nullable][1]<[DateTime][2]> \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][5]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][7] or [Extension Methods (C# Programming Guide)][8].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][9] \n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.nullable-1\n[2]: https://learn.microsoft.com/dotnet/api/system.datetime\n[3]: ../README.md\n[4]: GetNullableDateTime.md\n[5]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[6]: https://learn.microsoft.com/dotnet/api/system.string\n[7]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[8]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetNullableDecimal.md",
"content": "Extensions.GetNullableDecimal(DbDataReader, Int32) Method\n=========================================================\nGets the value of the specified column as a [Nullable<T>][1] of [Decimal][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------- | -------------------------------------------------------------------------------- |\n| **GetNullableDecimal(DbDataReader, Int32)** | Gets the value of the specified column as a [Nullable<T>][1] of [Decimal][2]. |\n| [GetNullableDecimal(DbDataReader, String)][4] | Gets the value of the specified column as a [Nullable<T>][1] of [Decimal][2]. |\n\n\nSyntax\n------\n\n```csharp\npublic static decimal? GetNullableDecimal(\n\tthis DbDataReader reader,\n\tint i\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][5]\nThe data reader.\n\n##### *i* [Int32][6]\nThe zero-based column ordinal.\n\n#### Return Value\n[Nullable][1]<[Decimal][2]> \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][5]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][7] or [Extension Methods (C# Programming Guide)][8].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][9] \n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.nullable-1\n[2]: https://learn.microsoft.com/dotnet/api/system.decimal\n[3]: ../README.md\n[4]: GetNullableDecimal_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[6]: https://learn.microsoft.com/dotnet/api/system.int32\n[7]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[8]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetNullableDecimal_1.md",
"content": "Extensions.GetNullableDecimal(DbDataReader, String) Method\n==========================================================\nGets the value of the specified column as a [Nullable<T>][1] of [Decimal][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------- | -------------------------------------------------------------------------------- |\n| [GetNullableDecimal(DbDataReader, Int32)][4] | Gets the value of the specified column as a [Nullable<T>][1] of [Decimal][2]. |\n| **GetNullableDecimal(DbDataReader, String)** | Gets the value of the specified column as a [Nullable<T>][1] of [Decimal][2]. |\n\n\nSyntax\n------\n\n```csharp\npublic static decimal? GetNullableDecimal(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][5]\nThe data reader.\n\n##### *name* [String][6]\nThe name of the column to find.\n\n#### Return Value\n[Nullable][1]<[Decimal][2]> \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][5]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][7] or [Extension Methods (C# Programming Guide)][8].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][9] \n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.nullable-1\n[2]: https://learn.microsoft.com/dotnet/api/system.decimal\n[3]: ../README.md\n[4]: GetNullableDecimal.md\n[5]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[6]: https://learn.microsoft.com/dotnet/api/system.string\n[7]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[8]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetNullableDouble.md",
"content": "Extensions.GetNullableDouble(DbDataReader, Int32) Method\n========================================================\nGets the value of the specified column as a [Nullable<T>][1] of [Double][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------- | ------------------------------------------------------------------------------- |\n| **GetNullableDouble(DbDataReader, Int32)** | Gets the value of the specified column as a [Nullable<T>][1] of [Double][2]. |\n| [GetNullableDouble(DbDataReader, String)][4] | Gets the value of the specified column as a [Nullable<T>][1] of [Double][2]. |\n\n\nSyntax\n------\n\n```csharp\npublic static double? GetNullableDouble(\n\tthis DbDataReader reader,\n\tint i\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][5]\nThe data reader.\n\n##### *i* [Int32][6]\nThe zero-based column ordinal.\n\n#### Return Value\n[Nullable][1]<[Double][2]> \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][5]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][7] or [Extension Methods (C# Programming Guide)][8].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][9] \n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.nullable-1\n[2]: https://learn.microsoft.com/dotnet/api/system.double\n[3]: ../README.md\n[4]: GetNullableDouble_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[6]: https://learn.microsoft.com/dotnet/api/system.int32\n[7]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[8]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetNullableDouble_1.md",
"content": "Extensions.GetNullableDouble(DbDataReader, String) Method\n=========================================================\nGets the value of the specified column as a [Nullable<T>][1] of [Double][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------- | ------------------------------------------------------------------------------- |\n| [GetNullableDouble(DbDataReader, Int32)][4] | Gets the value of the specified column as a [Nullable<T>][1] of [Double][2]. |\n| **GetNullableDouble(DbDataReader, String)** | Gets the value of the specified column as a [Nullable<T>][1] of [Double][2]. |\n\n\nSyntax\n------\n\n```csharp\npublic static double? GetNullableDouble(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][5]\nThe data reader.\n\n##### *name* [String][6]\nThe name of the column to find.\n\n#### Return Value\n[Nullable][1]<[Double][2]> \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][5]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][7] or [Extension Methods (C# Programming Guide)][8].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][9] \n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.nullable-1\n[2]: https://learn.microsoft.com/dotnet/api/system.double\n[3]: ../README.md\n[4]: GetNullableDouble.md\n[5]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[6]: https://learn.microsoft.com/dotnet/api/system.string\n[7]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[8]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetNullableFloat.md",
"content": "Extensions.GetNullableFloat(DbDataReader, Int32) Method\n=======================================================\nGets the value of the specified column as a [Nullable<T>][1] of [Single][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------- | ------------------------------------------------------------------------------- |\n| **GetNullableFloat(DbDataReader, Int32)** | Gets the value of the specified column as a [Nullable<T>][1] of [Single][2]. |\n| [GetNullableFloat(DbDataReader, String)][4] | Gets the value of the specified column as a [Nullable<T>][1] of [Single][2]. |\n\n\nSyntax\n------\n\n```csharp\npublic static float? GetNullableFloat(\n\tthis DbDataReader reader,\n\tint i\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][5]\nThe data reader.\n\n##### *i* [Int32][6]\nThe zero-based column ordinal.\n\n#### Return Value\n[Nullable][1]<[Single][2]> \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][5]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][7] or [Extension Methods (C# Programming Guide)][8].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][9] \n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.nullable-1\n[2]: https://learn.microsoft.com/dotnet/api/system.single\n[3]: ../README.md\n[4]: GetNullableFloat_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[6]: https://learn.microsoft.com/dotnet/api/system.int32\n[7]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[8]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetNullableFloat_1.md",
"content": "Extensions.GetNullableFloat(DbDataReader, String) Method\n========================================================\nGets the value of the specified column as a [Nullable<T>][1] of [Single][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------ | ------------------------------------------------------------------------------- |\n| [GetNullableFloat(DbDataReader, Int32)][4] | Gets the value of the specified column as a [Nullable<T>][1] of [Single][2]. |\n| **GetNullableFloat(DbDataReader, String)** | Gets the value of the specified column as a [Nullable<T>][1] of [Single][2]. |\n\n\nSyntax\n------\n\n```csharp\npublic static float? GetNullableFloat(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][5]\nThe data reader.\n\n##### *name* [String][6]\nThe name of the column to find.\n\n#### Return Value\n[Nullable][1]<[Single][2]> \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][5]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][7] or [Extension Methods (C# Programming Guide)][8].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][9] \n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.nullable-1\n[2]: https://learn.microsoft.com/dotnet/api/system.single\n[3]: ../README.md\n[4]: GetNullableFloat.md\n[5]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[6]: https://learn.microsoft.com/dotnet/api/system.string\n[7]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[8]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetNullableGuid.md",
"content": "Extensions.GetNullableGuid(DbDataReader, Int32) Method\n======================================================\nGets the value of the specified column as a [Nullable<T>][1] of [Guid][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------ | ----------------------------------------------------------------------------- |\n| **GetNullableGuid(DbDataReader, Int32)** | Gets the value of the specified column as a [Nullable<T>][1] of [Guid][2]. |\n| [GetNullableGuid(DbDataReader, String)][4] | Gets the value of the specified column as a [Nullable<T>][1] of [Guid][2]. |\n\n\nSyntax\n------\n\n```csharp\npublic static Guid? GetNullableGuid(\n\tthis DbDataReader reader,\n\tint i\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][5]\nThe data reader.\n\n##### *i* [Int32][6]\nThe zero-based column ordinal.\n\n#### Return Value\n[Nullable][1]<[Guid][2]> \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][5]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][7] or [Extension Methods (C# Programming Guide)][8].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][9] \n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.nullable-1\n[2]: https://learn.microsoft.com/dotnet/api/system.guid\n[3]: ../README.md\n[4]: GetNullableGuid_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[6]: https://learn.microsoft.com/dotnet/api/system.int32\n[7]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[8]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetNullableGuid_1.md",
"content": "Extensions.GetNullableGuid(DbDataReader, String) Method\n=======================================================\nGets the value of the specified column as a [Nullable<T>][1] of [Guid][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------- | ----------------------------------------------------------------------------- |\n| [GetNullableGuid(DbDataReader, Int32)][4] | Gets the value of the specified column as a [Nullable<T>][1] of [Guid][2]. |\n| **GetNullableGuid(DbDataReader, String)** | Gets the value of the specified column as a [Nullable<T>][1] of [Guid][2]. |\n\n\nSyntax\n------\n\n```csharp\npublic static Guid? GetNullableGuid(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][5]\nThe data reader.\n\n##### *name* [String][6]\nThe name of the column to find.\n\n#### Return Value\n[Nullable][1]<[Guid][2]> \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][5]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][7] or [Extension Methods (C# Programming Guide)][8].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][9] \n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.nullable-1\n[2]: https://learn.microsoft.com/dotnet/api/system.guid\n[3]: ../README.md\n[4]: GetNullableGuid.md\n[5]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[6]: https://learn.microsoft.com/dotnet/api/system.string\n[7]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[8]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetNullableInt16.md",
"content": "Extensions.GetNullableInt16(DbDataReader, Int32) Method\n=======================================================\nGets the value of the specified column as a [Nullable<T>][1] of [Int16][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------- | ------------------------------------------------------------------------------ |\n| **GetNullableInt16(DbDataReader, Int32)** | Gets the value of the specified column as a [Nullable<T>][1] of [Int16][2]. |\n| [GetNullableInt16(DbDataReader, String)][4] | Gets the value of the specified column as a [Nullable<T>][1] of [Int16][2]. |\n\n\nSyntax\n------\n\n```csharp\npublic static short? GetNullableInt16(\n\tthis DbDataReader reader,\n\tint i\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][5]\nThe data reader.\n\n##### *i* [Int32][6]\nThe zero-based column ordinal.\n\n#### Return Value\n[Nullable][1]<[Int16][2]> \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][5]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][7] or [Extension Methods (C# Programming Guide)][8].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][9] \n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.nullable-1\n[2]: https://learn.microsoft.com/dotnet/api/system.int16\n[3]: ../README.md\n[4]: GetNullableInt16_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[6]: https://learn.microsoft.com/dotnet/api/system.int32\n[7]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[8]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetNullableInt16_1.md",
"content": "Extensions.GetNullableInt16(DbDataReader, String) Method\n========================================================\nGets the value of the specified column as a [Nullable<T>][1] of [Int16][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------ | ------------------------------------------------------------------------------ |\n| [GetNullableInt16(DbDataReader, Int32)][4] | Gets the value of the specified column as a [Nullable<T>][1] of [Int16][2]. |\n| **GetNullableInt16(DbDataReader, String)** | Gets the value of the specified column as a [Nullable<T>][1] of [Int16][2]. |\n\n\nSyntax\n------\n\n```csharp\npublic static short? GetNullableInt16(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][5]\nThe data reader.\n\n##### *name* [String][6]\nThe name of the column to find.\n\n#### Return Value\n[Nullable][1]<[Int16][2]> \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][5]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][7] or [Extension Methods (C# Programming Guide)][8].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][9] \n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.nullable-1\n[2]: https://learn.microsoft.com/dotnet/api/system.int16\n[3]: ../README.md\n[4]: GetNullableInt16.md\n[5]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[6]: https://learn.microsoft.com/dotnet/api/system.string\n[7]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[8]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetNullableInt32.md",
"content": "Extensions.GetNullableInt32(DbDataReader, Int32) Method\n=======================================================\nGets the value of the specified column as a [Nullable<T>][1] of [Int32][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------- | ------------------------------------------------------------------------------ |\n| **GetNullableInt32(DbDataReader, Int32)** | Gets the value of the specified column as a [Nullable<T>][1] of [Int32][2]. |\n| [GetNullableInt32(DbDataReader, String)][4] | Gets the value of the specified column as a [Nullable<T>][1] of [Int32][2]. |\n\n\nSyntax\n------\n\n```csharp\npublic static int? GetNullableInt32(\n\tthis DbDataReader reader,\n\tint i\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][5]\nThe data reader.\n\n##### *i* [Int32][2]\nThe zero-based column ordinal.\n\n#### Return Value\n[Nullable][1]<[Int32][2]> \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][5]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][6] or [Extension Methods (C# Programming Guide)][7].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][8] \n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.nullable-1\n[2]: https://learn.microsoft.com/dotnet/api/system.int32\n[3]: ../README.md\n[4]: GetNullableInt32_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[6]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[7]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetNullableInt32_1.md",
"content": "Extensions.GetNullableInt32(DbDataReader, String) Method\n========================================================\nGets the value of the specified column as a [Nullable<T>][1] of [Int32][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------ | ------------------------------------------------------------------------------ |\n| [GetNullableInt32(DbDataReader, Int32)][4] | Gets the value of the specified column as a [Nullable<T>][1] of [Int32][2]. |\n| **GetNullableInt32(DbDataReader, String)** | Gets the value of the specified column as a [Nullable<T>][1] of [Int32][2]. |\n\n\nSyntax\n------\n\n```csharp\npublic static int? GetNullableInt32(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][5]\nThe data reader.\n\n##### *name* [String][6]\nThe name of the column to find.\n\n#### Return Value\n[Nullable][1]<[Int32][2]> \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][5]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][7] or [Extension Methods (C# Programming Guide)][8].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][9] \n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.nullable-1\n[2]: https://learn.microsoft.com/dotnet/api/system.int32\n[3]: ../README.md\n[4]: GetNullableInt32.md\n[5]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[6]: https://learn.microsoft.com/dotnet/api/system.string\n[7]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[8]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetNullableInt64.md",
"content": "Extensions.GetNullableInt64(DbDataReader, Int32) Method\n=======================================================\nGets the value of the specified column as a [Nullable<T>][1] of [Int64][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------- | ------------------------------------------------------------------------------ |\n| **GetNullableInt64(DbDataReader, Int32)** | Gets the value of the specified column as a [Nullable<T>][1] of [Int64][2]. |\n| [GetNullableInt64(DbDataReader, String)][4] | Gets the value of the specified column as a [Nullable<T>][1] of [Int64][2]. |\n\n\nSyntax\n------\n\n```csharp\npublic static long? GetNullableInt64(\n\tthis DbDataReader reader,\n\tint i\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][5]\nThe data reader.\n\n##### *i* [Int32][6]\nThe zero-based column ordinal.\n\n#### Return Value\n[Nullable][1]<[Int64][2]> \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][5]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][7] or [Extension Methods (C# Programming Guide)][8].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][9] \n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.nullable-1\n[2]: https://learn.microsoft.com/dotnet/api/system.int64\n[3]: ../README.md\n[4]: GetNullableInt64_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[6]: https://learn.microsoft.com/dotnet/api/system.int32\n[7]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[8]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetNullableInt64_1.md",
"content": "Extensions.GetNullableInt64(DbDataReader, String) Method\n========================================================\nGets the value of the specified column as a [Nullable<T>][1] of [Int64][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------ | ------------------------------------------------------------------------------ |\n| [GetNullableInt64(DbDataReader, Int32)][4] | Gets the value of the specified column as a [Nullable<T>][1] of [Int64][2]. |\n| **GetNullableInt64(DbDataReader, String)** | Gets the value of the specified column as a [Nullable<T>][1] of [Int64][2]. |\n\n\nSyntax\n------\n\n```csharp\npublic static long? GetNullableInt64(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][5]\nThe data reader.\n\n##### *name* [String][6]\nThe name of the column to find.\n\n#### Return Value\n[Nullable][1]<[Int64][2]> \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][5]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][7] or [Extension Methods (C# Programming Guide)][8].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][9] \n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.nullable-1\n[2]: https://learn.microsoft.com/dotnet/api/system.int64\n[3]: ../README.md\n[4]: GetNullableInt64.md\n[5]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[6]: https://learn.microsoft.com/dotnet/api/system.string\n[7]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[8]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetString.md",
"content": "Extensions.GetString Method\n===========================\nGets the value of the specified column as a [String][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic static string GetString(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][3]\nThe data reader.\n\n##### *name* [String][1]\nThe name of the column to find.\n\n#### Return Value\n[String][1] \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][3]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][4] or [Extension Methods (C# Programming Guide)][5].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][6] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.string\n[2]: ../README.md\n[3]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[4]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[5]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetStringOrNull.md",
"content": "Extensions.GetStringOrNull(DbDataReader, Int32) Method\n======================================================\nGets the value of the specified column as a [String][1], or null (Nothing in Visual Basic).\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------ | ------------------------------------------------------------------------------------------- |\n| **GetStringOrNull(DbDataReader, Int32)** | Gets the value of the specified column as a [String][1], or null (Nothing in Visual Basic). |\n| [GetStringOrNull(DbDataReader, String)][3] | Gets the value of the specified column as a [String][1], or null (Nothing in Visual Basic). |\n\n\nSyntax\n------\n\n```csharp\npublic static string? GetStringOrNull(\n\tthis DbDataReader reader,\n\tint i\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][4]\nThe data reader.\n\n##### *i* [Int32][5]\nThe zero-based column ordinal.\n\n#### Return Value\n[String][1] \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][4]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][6] or [Extension Methods (C# Programming Guide)][7].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][8] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.string\n[2]: ../README.md\n[3]: GetStringOrNull_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[5]: https://learn.microsoft.com/dotnet/api/system.int32\n[6]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[7]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetStringOrNull_1.md",
"content": "Extensions.GetStringOrNull(DbDataReader, String) Method\n=======================================================\nGets the value of the specified column as a [String][1], or null (Nothing in Visual Basic).\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------- | ------------------------------------------------------------------------------------------- |\n| [GetStringOrNull(DbDataReader, Int32)][3] | Gets the value of the specified column as a [String][1], or null (Nothing in Visual Basic). |\n| **GetStringOrNull(DbDataReader, String)** | Gets the value of the specified column as a [String][1], or null (Nothing in Visual Basic). |\n\n\nSyntax\n------\n\n```csharp\npublic static string? GetStringOrNull(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][4]\nThe data reader.\n\n##### *name* [String][1]\nThe name of the column to find.\n\n#### Return Value\n[String][1] \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][4]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][5] or [Extension Methods (C# Programming Guide)][6].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][7] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.string\n[2]: ../README.md\n[3]: GetStringOrNull.md\n[4]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[5]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[6]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetValue.md",
"content": "Extensions.GetValue Method\n==========================\nGets the value of the specified column.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic static Object GetValue(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][2]\nThe data reader.\n\n##### *name* [String][3]\nThe name of the column to find.\n\n#### Return Value\n[Object][4] \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][2]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][5] or [Extension Methods (C# Programming Guide)][6].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[3]: https://learn.microsoft.com/dotnet/api/system.string\n[4]: https://learn.microsoft.com/dotnet/api/system.object\n[5]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[6]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetValueOrNull.md",
"content": "Extensions.GetValueOrNull(DbDataReader, Int32) Method\n=====================================================\nGets the value of the specified column as an [Object][1], or null (Nothing in Visual Basic).\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------- | -------------------------------------------------------------------------------------------- |\n| **GetValueOrNull(DbDataReader, Int32)** | Gets the value of the specified column as an [Object][1], or null (Nothing in Visual Basic). |\n| [GetValueOrNull(DbDataReader, String)][3] | Gets the value of the specified column as an [Object][1], or null (Nothing in Visual Basic). |\n\n\nSyntax\n------\n\n```csharp\npublic static Object? GetValueOrNull(\n\tthis DbDataReader reader,\n\tint i\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][4]\nThe data reader.\n\n##### *i* [Int32][5]\nThe zero-based column ordinal.\n\n#### Return Value\n[Object][1] \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][4]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][6] or [Extension Methods (C# Programming Guide)][7].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][8] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.object\n[2]: ../README.md\n[3]: GetValueOrNull_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[5]: https://learn.microsoft.com/dotnet/api/system.int32\n[6]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[7]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/GetValueOrNull_1.md",
"content": "Extensions.GetValueOrNull(DbDataReader, String) Method\n======================================================\nGets the value of the specified column as an [Object][1], or null (Nothing in Visual Basic).\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------- | -------------------------------------------------------------------------------------------- |\n| [GetValueOrNull(DbDataReader, Int32)][3] | Gets the value of the specified column as an [Object][1], or null (Nothing in Visual Basic). |\n| **GetValueOrNull(DbDataReader, String)** | Gets the value of the specified column as an [Object][1], or null (Nothing in Visual Basic). |\n\n\nSyntax\n------\n\n```csharp\npublic static Object? GetValueOrNull(\n\tthis DbDataReader reader,\n\tstring name\n)\n```\n\n#### Parameters\n\n##### *reader* [DbDataReader][4]\nThe data reader.\n\n##### *name* [String][5]\nThe name of the column to find.\n\n#### Return Value\n[Object][1] \nThe value of the column.\n#### Usage Note\nIn Visual Basic and C#, you can call this method as an instance method on any object of type [DbDataReader][4]. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)][6] or [Extension Methods (C# Programming Guide)][7].\n\nSee Also\n--------\n\n#### Reference\n[Extensions Class][8] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.object\n[2]: ../README.md\n[3]: GetValueOrNull.md\n[4]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[5]: https://learn.microsoft.com/dotnet/api/system.string\n[6]: https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods\n[7]: https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/Extensions/README.md",
"content": "Extensions Class\n================\nProvides extension methods for common ADO.NET objects.\n\n\nInheritance Hierarchy\n---------------------\n[System.Object][1] \n **DbExtensions.Extensions** \n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic static class Extensions\n```\n\nThe **Extensions** type exposes the following members.\n\n\nMethods\n-------\n\n| Name | Description |\n| ----------------------------------------------- | -------------------------------------------------------------------------------------------- |\n| [GetBoolean][3] | Gets the value of the specified column as a [Boolean][4]. |\n| [GetByte][5] | Gets the value of the specified column as a [Byte][6]. |\n| [GetChar][7] | Gets the value of the specified column as a [Char][8]. |\n| [GetDateTime][9] | Gets the value of the specified column as a [DateTime][10]. |\n| [GetDecimal][11] | Gets the value of the specified column as a [Decimal][12]. |\n| [GetDouble][13] | Gets the value of the specified column as a [Double][14]. |\n| [GetFloat][15] | Gets the value of the specified column as a [Single][16]. |\n| [GetInt16][17] | Gets the value of the specified column as an [Int16][18]. |\n| [GetInt32][19] | Gets the value of the specified column as an [Int32][20]. |\n| [GetInt64][21] | Gets the value of the specified column as an [Int64][22]. |\n| [GetNullableBoolean(DbDataReader, Int32)][23] | Gets the value of the specified column as a [Nullable<T>][24] of [Boolean][4]. |\n| [GetNullableBoolean(DbDataReader, String)][25] | Gets the value of the specified column as a [Nullable<T>][24] of [Boolean][4]. |\n| [GetNullableByte(DbDataReader, Int32)][26] | Gets the value of the specified column as a [Nullable<T>][24] of [Byte][6]. |\n| [GetNullableByte(DbDataReader, String)][27] | Gets the value of the specified column as a [Nullable<T>][24] of [Byte][6]. |\n| [GetNullableChar(DbDataReader, Int32)][28] | Gets the value of the specified column as a [Nullable<T>][24] of [Char][8]. |\n| [GetNullableChar(DbDataReader, String)][29] | Gets the value of the specified column as a [Nullable<T>][24] of [Char][8]. |\n| [GetNullableDateTime(DbDataReader, Int32)][30] | Gets the value of the specified column as a [Nullable<T>][24] of [DateTime][10]. |\n| [GetNullableDateTime(DbDataReader, String)][31] | Gets the value of the specified column as a [Nullable<T>][24] of [DateTime][10]. |\n| [GetNullableDecimal(DbDataReader, Int32)][32] | Gets the value of the specified column as a [Nullable<T>][24] of [Decimal][12]. |\n| [GetNullableDecimal(DbDataReader, String)][33] | Gets the value of the specified column as a [Nullable<T>][24] of [Decimal][12]. |\n| [GetNullableDouble(DbDataReader, Int32)][34] | Gets the value of the specified column as a [Nullable<T>][24] of [Double][14]. |\n| [GetNullableDouble(DbDataReader, String)][35] | Gets the value of the specified column as a [Nullable<T>][24] of [Double][14]. |\n| [GetNullableFloat(DbDataReader, Int32)][36] | Gets the value of the specified column as a [Nullable<T>][24] of [Single][16]. |\n| [GetNullableFloat(DbDataReader, String)][37] | Gets the value of the specified column as a [Nullable<T>][24] of [Single][16]. |\n| [GetNullableGuid(DbDataReader, Int32)][38] | Gets the value of the specified column as a [Nullable<T>][24] of [Guid][39]. |\n| [GetNullableGuid(DbDataReader, String)][40] | Gets the value of the specified column as a [Nullable<T>][24] of [Guid][39]. |\n| [GetNullableInt16(DbDataReader, Int32)][41] | Gets the value of the specified column as a [Nullable<T>][24] of [Int16][18]. |\n| [GetNullableInt16(DbDataReader, String)][42] | Gets the value of the specified column as a [Nullable<T>][24] of [Int16][18]. |\n| [GetNullableInt32(DbDataReader, Int32)][43] | Gets the value of the specified column as a [Nullable<T>][24] of [Int32][20]. |\n| [GetNullableInt32(DbDataReader, String)][44] | Gets the value of the specified column as a [Nullable<T>][24] of [Int32][20]. |\n| [GetNullableInt64(DbDataReader, Int32)][45] | Gets the value of the specified column as a [Nullable<T>][24] of [Int64][22]. |\n| [GetNullableInt64(DbDataReader, String)][46] | Gets the value of the specified column as a [Nullable<T>][24] of [Int64][22]. |\n| [GetString][47] | Gets the value of the specified column as a [String][48]. |\n| [GetStringOrNull(DbDataReader, Int32)][49] | Gets the value of the specified column as a [String][48], or null (Nothing in Visual Basic). |\n| [GetStringOrNull(DbDataReader, String)][50] | Gets the value of the specified column as a [String][48], or null (Nothing in Visual Basic). |\n| [GetValue][51] | Gets the value of the specified column. |\n| [GetValueOrNull(DbDataReader, Int32)][52] | Gets the value of the specified column as an [Object][1], or null (Nothing in Visual Basic). |\n| [GetValueOrNull(DbDataReader, String)][53] | Gets the value of the specified column as an [Object][1], or null (Nothing in Visual Basic). |\n\n\nSee Also\n--------\n\n#### Reference\n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.object\n[2]: ../README.md\n[3]: GetBoolean.md\n[4]: https://learn.microsoft.com/dotnet/api/system.boolean\n[5]: GetByte.md\n[6]: https://learn.microsoft.com/dotnet/api/system.byte\n[7]: GetChar.md\n[8]: https://learn.microsoft.com/dotnet/api/system.char\n[9]: GetDateTime.md\n[10]: https://learn.microsoft.com/dotnet/api/system.datetime\n[11]: GetDecimal.md\n[12]: https://learn.microsoft.com/dotnet/api/system.decimal\n[13]: GetDouble.md\n[14]: https://learn.microsoft.com/dotnet/api/system.double\n[15]: GetFloat.md\n[16]: https://learn.microsoft.com/dotnet/api/system.single\n[17]: GetInt16.md\n[18]: https://learn.microsoft.com/dotnet/api/system.int16\n[19]: GetInt32.md\n[20]: https://learn.microsoft.com/dotnet/api/system.int32\n[21]: GetInt64.md\n[22]: https://learn.microsoft.com/dotnet/api/system.int64\n[23]: GetNullableBoolean.md\n[24]: https://learn.microsoft.com/dotnet/api/system.nullable-1\n[25]: GetNullableBoolean_1.md\n[26]: GetNullableByte.md\n[27]: GetNullableByte_1.md\n[28]: GetNullableChar.md\n[29]: GetNullableChar_1.md\n[30]: GetNullableDateTime.md\n[31]: GetNullableDateTime_1.md\n[32]: GetNullableDecimal.md\n[33]: GetNullableDecimal_1.md\n[34]: GetNullableDouble.md\n[35]: GetNullableDouble_1.md\n[36]: GetNullableFloat.md\n[37]: GetNullableFloat_1.md\n[38]: GetNullableGuid.md\n[39]: https://learn.microsoft.com/dotnet/api/system.guid\n[40]: GetNullableGuid_1.md\n[41]: GetNullableInt16.md\n[42]: GetNullableInt16_1.md\n[43]: GetNullableInt32.md\n[44]: GetNullableInt32_1.md\n[45]: GetNullableInt64.md\n[46]: GetNullableInt64_1.md\n[47]: GetString.md\n[48]: https://learn.microsoft.com/dotnet/api/system.string\n[49]: GetStringOrNull.md\n[50]: GetStringOrNull_1.md\n[51]: GetValue.md\n[52]: GetValueOrNull.md\n[53]: GetValueOrNull_1.md"
},
{
"path": "docs/api/DbExtensions/README.md",
"content": "DbExtensions Namespace\n======================\nDbExtensions is a data-access framework with a strong focus on query composition, granularity and code aesthetics. [Database][1] is the entry point of the **DbExtensions** API.\n\n\nClasses\n-------\n\n| Class | Description |\n| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [AssociationAttribute][2] | Designates a property to represent a database association, such as a foreign key relationship. |\n| [ChangeConflictException][3] | An exception that is thrown when a concurrency violation is encountered while saving to the database. A concurrency violation occurs when an unexpected number of rows are affected during save. This is usually because the data in the database has been modified since it was loaded into memory. |\n| [ColumnAttribute][4] | Associates a property with a column in a database table. |\n| [ComplexPropertyAttribute][5] | Designates a property as a complex property that groups columns of a table that share the same base name. |\n| [Database][1] | Provides simple data access using [SqlSet][6], [SqlBuilder][7] and [SqlTable<TEntity>][8]. |\n| [DatabaseConfiguration][9] | Holds configuration options that customize the behavior of [Database][1]. This class cannot be instantiated, to get an instance use the [Configuration][10] property. |\n| [Extensions][11] | Provides extension methods for common ADO.NET objects. |\n| [SQL][12] | Provides a set of static (Shared in Visual Basic) methods to create [SqlBuilder][7] instances. |\n| [SqlBuilder][7] | Represents a mutable SQL string. |\n| [SqlClause][13] | Provides information about a SQL clause. Used by [SqlBuilder][7]. |\n| [SqlSet][6] | Represents an immutable, connected SQL query. This class cannot be instantiated, to get an instance use one of the [Database.From][14] or [Database.FromQuery][15] overloads. |\n| [SqlSet<TResult>][16] | Represents an immutable, connected SQL query that maps to TResult objects. This class cannot be instantiated, to get an instance use one of the [Database.From<TResult>(String)][17] or [Database.FromQuery<TResult>(SqlBuilder)][18] overloads. |\n| [SqlTable][19] | A non-generic version of [SqlTable<TEntity>][8] which can be used when the type of the entity is not known at build time. This class cannot be instantiated, to get an instance use the [Database.Table(Type)][20] method. |\n| [SqlTable<TEntity>][8] | A [SqlSet<TResult>][16] that provides CRUD (Create, Read, Update, Delete) operations for annotated classes. This class cannot be instantiated, to get an instance use the [Database.Table<TEntity>()][21] method. |\n| [TableAttribute][22] | Designates a class as an entity class that is associated with a database table. |\n\n\nEnumerations\n------------\n\n| Enumeration | Description |\n| -------------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| [AutoSync][23] | Used to specify for during INSERT and UPDATE operations when a data member should be read back after the operation completes. |\n\n[1]: Database/README.md\n[2]: AssociationAttribute/README.md\n[3]: ChangeConflictException/README.md\n[4]: ColumnAttribute/README.md\n[5]: ComplexPropertyAttribute/README.md\n[6]: SqlSet/README.md\n[7]: SqlBuilder/README.md\n[8]: SqlTable_1/README.md\n[9]: DatabaseConfiguration/README.md\n[10]: Database/Configuration.md\n[11]: Extensions/README.md\n[12]: SQL/README.md\n[13]: SqlClause/README.md\n[14]: Database/From.md\n[15]: Database/FromQuery.md\n[16]: SqlSet_1/README.md\n[17]: Database/From__1.md\n[18]: Database/FromQuery__1.md\n[19]: SqlTable/README.md\n[20]: Database/Table.md\n[21]: Database/Table__1.md\n[22]: TableAttribute/README.md\n[23]: AutoSync/README.md"
},
{
"path": "docs/api/DbExtensions/SQL/DELETE_FROM.md",
"content": "SQL.DELETE_FROM(SqlBuilder.ClauseStringHandler<SqlClause.DELETE_FROM>) Method\n================================================================================\nCreates and returns a new [SqlBuilder][1] initialized by appending the DELETE FROM clause using the provided string interpolated *handler*.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| **DELETE_FROM(SqlBuilder.ClauseStringHandler<DELETE_FROM>)** | Creates and returns a new [SqlBuilder][1] initialized by appending the DELETE FROM clause using the provided string interpolated *handler*. |\n| [DELETE_FROM(String)][3] | Creates and returns a new [SqlBuilder][1] initialized by appending the DELETE FROM clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic static SqlBuilder DELETE_FROM(\n\tref ClauseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<DELETE_FROM>\nThe body of the DELETE FROM clause.\n\n#### Return Value\n[SqlBuilder][1] \n A new [SqlBuilder][1] after calling [DELETE_FROM(SqlBuilder.ClauseStringHandler<DELETE_FROM>)][4].\n\nSee Also\n--------\n\n#### Reference\n[SQL Class][5] \n[DbExtensions Namespace][2] \n\n[1]: ../SqlBuilder/README.md\n[2]: ../README.md\n[3]: DELETE_FROM_1.md\n[4]: ../SqlBuilder/DELETE_FROM.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SQL/DELETE_FROM_1.md",
"content": "SQL.DELETE_FROM(String) Method\n==============================\nCreates and returns a new [SqlBuilder][1] initialized by appending the DELETE FROM clause using the provided *text*.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| [DELETE_FROM(SqlBuilder.ClauseStringHandler<DELETE_FROM>)][3] | Creates and returns a new [SqlBuilder][1] initialized by appending the DELETE FROM clause using the provided string interpolated *handler*. |\n| **DELETE_FROM(String)** | Creates and returns a new [SqlBuilder][1] initialized by appending the DELETE FROM clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic static SqlBuilder DELETE_FROM(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][4]\nThe body of the DELETE FROM clause.\n\n#### Return Value\n[SqlBuilder][1] \n A new [SqlBuilder][1] after calling [DELETE_FROM(String)][5].\n\nSee Also\n--------\n\n#### Reference\n[SQL Class][6] \n[DbExtensions Namespace][2] \n\n[1]: ../SqlBuilder/README.md\n[2]: ../README.md\n[3]: DELETE_FROM.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: ../SqlBuilder/DELETE_FROM_1.md\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SQL/INSERT_INTO.md",
"content": "SQL.INSERT_INTO(SqlBuilder.ClauseStringHandler<SqlClause.INSERT_INTO>) Method\n================================================================================\nCreates and returns a new [SqlBuilder][1] initialized by appending the INSERT INTO clause using the provided string interpolated *handler*.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| **INSERT_INTO(SqlBuilder.ClauseStringHandler<INSERT_INTO>)** | Creates and returns a new [SqlBuilder][1] initialized by appending the INSERT INTO clause using the provided string interpolated *handler*. |\n| [INSERT_INTO(String)][3] | Creates and returns a new [SqlBuilder][1] initialized by appending the INSERT INTO clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic static SqlBuilder INSERT_INTO(\n\tref ClauseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<INSERT_INTO>\nThe body of the INSERT INTO clause.\n\n#### Return Value\n[SqlBuilder][1] \n A new [SqlBuilder][1] after calling [INSERT_INTO(SqlBuilder.ClauseStringHandler<INSERT_INTO>)][4].\n\nSee Also\n--------\n\n#### Reference\n[SQL Class][5] \n[DbExtensions Namespace][2] \n\n[1]: ../SqlBuilder/README.md\n[2]: ../README.md\n[3]: INSERT_INTO_1.md\n[4]: ../SqlBuilder/INSERT_INTO.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SQL/INSERT_INTO_1.md",
"content": "SQL.INSERT_INTO(String) Method\n==============================\nCreates and returns a new [SqlBuilder][1] initialized by appending the INSERT INTO clause using the provided *text*.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| [INSERT_INTO(SqlBuilder.ClauseStringHandler<INSERT_INTO>)][3] | Creates and returns a new [SqlBuilder][1] initialized by appending the INSERT INTO clause using the provided string interpolated *handler*. |\n| **INSERT_INTO(String)** | Creates and returns a new [SqlBuilder][1] initialized by appending the INSERT INTO clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic static SqlBuilder INSERT_INTO(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][4]\nThe body of the INSERT INTO clause.\n\n#### Return Value\n[SqlBuilder][1] \n A new [SqlBuilder][1] after calling [INSERT_INTO(String)][5].\n\nSee Also\n--------\n\n#### Reference\n[SQL Class][6] \n[DbExtensions Namespace][2] \n\n[1]: ../SqlBuilder/README.md\n[2]: ../README.md\n[3]: INSERT_INTO.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: ../SqlBuilder/INSERT_INTO_1.md\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SQL/README.md",
"content": "SQL Class\n=========\nProvides a set of static (Shared in Visual Basic) methods to create [SqlBuilder][1] instances.\n\n\nInheritance Hierarchy\n---------------------\n[System.Object][2] \n **DbExtensions.SQL** \n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic static class SQL\n```\n\nThe **SQL** type exposes the following members.\n\n\nMethods\n-------\n\n| Name | Description |\n| ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| [DELETE_FROM(SqlBuilder.ClauseStringHandler<DELETE_FROM>)][4] | Creates and returns a new [SqlBuilder][1] initialized by appending the DELETE FROM clause using the provided string interpolated *handler*. |\n| [DELETE_FROM(String)][5] | Creates and returns a new [SqlBuilder][1] initialized by appending the DELETE FROM clause using the provided *text*. |\n| [INSERT_INTO(SqlBuilder.ClauseStringHandler<INSERT_INTO>)][6] | Creates and returns a new [SqlBuilder][1] initialized by appending the INSERT INTO clause using the provided string interpolated *handler*. |\n| [INSERT_INTO(String)][7] | Creates and returns a new [SqlBuilder][1] initialized by appending the INSERT INTO clause using the provided *text*. |\n| [SELECT(SqlBuilder.ClauseStringHandler<SELECT>)][8] | Creates and returns a new [SqlBuilder][1] initialized by appending the SELECT clause using the provided string interpolated *handler*. |\n| [SELECT(String)][9] | Creates and returns a new [SqlBuilder][1] initialized by appending the SELECT clause using the provided *text*. |\n| [UPDATE(SqlBuilder.ClauseStringHandler<UPDATE>)][10] | Creates and returns a new [SqlBuilder][1] initialized by appending the UPDATE clause using the provided string interpolated *handler*. |\n| [UPDATE(String)][11] | Creates and returns a new [SqlBuilder][1] initialized by appending the UPDATE clause using the provided *text*. |\n| [WITH(SqlBuilder.ClauseStringHandler<WITH>)][12] | Creates and returns a new [SqlBuilder][1] initialized by appending the WITH clause using the provided string interpolated *handler*. |\n| [WITH(String)][13] | Creates and returns a new [SqlBuilder][1] initialized by appending the WITH clause using the provided *text*. |\n| [WITH(String, SqlBuilder)][14] | Creates and returns a new [SqlBuilder][1] initialized by appending the WITH clause using the provided *subQuery* and *alias*. |\n| [WITH(String, SqlSet)][15] | Creates and returns a new [SqlBuilder][1] initialized by appending the WITH clause using the provided *subQuery* and *alias*. |\n\n\nSee Also\n--------\n\n#### Reference\n[DbExtensions Namespace][3] \n\n[1]: ../SqlBuilder/README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: ../README.md\n[4]: DELETE_FROM.md\n[5]: DELETE_FROM_1.md\n[6]: INSERT_INTO.md\n[7]: INSERT_INTO_1.md\n[8]: SELECT.md\n[9]: SELECT_1.md\n[10]: UPDATE.md\n[11]: UPDATE_1.md\n[12]: WITH.md\n[13]: WITH_1.md\n[14]: WITH_2.md\n[15]: WITH_3.md"
},
{
"path": "docs/api/DbExtensions/SQL/SELECT.md",
"content": "SQL.SELECT(SqlBuilder.ClauseStringHandler<SqlClause.SELECT>) Method\n======================================================================\nCreates and returns a new [SqlBuilder][1] initialized by appending the SELECT clause using the provided string interpolated *handler*.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |\n| **SELECT(SqlBuilder.ClauseStringHandler<SELECT>)** | Creates and returns a new [SqlBuilder][1] initialized by appending the SELECT clause using the provided string interpolated *handler*. |\n| [SELECT(String)][3] | Creates and returns a new [SqlBuilder][1] initialized by appending the SELECT clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic static SqlBuilder SELECT(\n\tref ClauseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<SELECT>\nThe body of the SELECT clause.\n\n#### Return Value\n[SqlBuilder][1] \n A new [SqlBuilder][1] after calling [SELECT(SqlBuilder.ClauseStringHandler<SELECT>)][4].\n\nSee Also\n--------\n\n#### Reference\n[SQL Class][5] \n[DbExtensions Namespace][2] \n\n[1]: ../SqlBuilder/README.md\n[2]: ../README.md\n[3]: SELECT_1.md\n[4]: ../SqlBuilder/SELECT_1.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SQL/SELECT_1.md",
"content": "SQL.SELECT(String) Method\n=========================\nCreates and returns a new [SqlBuilder][1] initialized by appending the SELECT clause using the provided *text*.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- |\n| [SELECT(SqlBuilder.ClauseStringHandler<SELECT>)][3] | Creates and returns a new [SqlBuilder][1] initialized by appending the SELECT clause using the provided string interpolated *handler*. |\n| **SELECT(String)** | Creates and returns a new [SqlBuilder][1] initialized by appending the SELECT clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic static SqlBuilder SELECT(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][4]\nThe body of the SELECT clause.\n\n#### Return Value\n[SqlBuilder][1] \n A new [SqlBuilder][1] after calling [SELECT(String)][5].\n\nSee Also\n--------\n\n#### Reference\n[SQL Class][6] \n[DbExtensions Namespace][2] \n\n[1]: ../SqlBuilder/README.md\n[2]: ../README.md\n[3]: SELECT.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: ../SqlBuilder/SELECT_2.md\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SQL/UPDATE.md",
"content": "SQL.UPDATE(SqlBuilder.ClauseStringHandler<SqlClause.UPDATE>) Method\n======================================================================\nCreates and returns a new [SqlBuilder][1] initialized by appending the UPDATE clause using the provided string interpolated *handler*.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |\n| **UPDATE(SqlBuilder.ClauseStringHandler<UPDATE>)** | Creates and returns a new [SqlBuilder][1] initialized by appending the UPDATE clause using the provided string interpolated *handler*. |\n| [UPDATE(String)][3] | Creates and returns a new [SqlBuilder][1] initialized by appending the UPDATE clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic static SqlBuilder UPDATE(\n\tref ClauseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<UPDATE>\nThe body of the UPDATE clause.\n\n#### Return Value\n[SqlBuilder][1] \n A new [SqlBuilder][1] after calling [UPDATE(SqlBuilder.ClauseStringHandler<UPDATE>)][4].\n\nSee Also\n--------\n\n#### Reference\n[SQL Class][5] \n[DbExtensions Namespace][2] \n\n[1]: ../SqlBuilder/README.md\n[2]: ../README.md\n[3]: UPDATE_1.md\n[4]: ../SqlBuilder/UPDATE.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SQL/UPDATE_1.md",
"content": "SQL.UPDATE(String) Method\n=========================\nCreates and returns a new [SqlBuilder][1] initialized by appending the UPDATE clause using the provided *text*.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- |\n| [UPDATE(SqlBuilder.ClauseStringHandler<UPDATE>)][3] | Creates and returns a new [SqlBuilder][1] initialized by appending the UPDATE clause using the provided string interpolated *handler*. |\n| **UPDATE(String)** | Creates and returns a new [SqlBuilder][1] initialized by appending the UPDATE clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic static SqlBuilder UPDATE(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][4]\nThe body of the UPDATE clause.\n\n#### Return Value\n[SqlBuilder][1] \n A new [SqlBuilder][1] after calling [UPDATE(String)][5].\n\nSee Also\n--------\n\n#### Reference\n[SQL Class][6] \n[DbExtensions Namespace][2] \n\n[1]: ../SqlBuilder/README.md\n[2]: ../README.md\n[3]: UPDATE.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: ../SqlBuilder/UPDATE_1.md\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SQL/WITH.md",
"content": "SQL.WITH(SqlBuilder.ClauseStringHandler<SqlClause.WITH>) Method\n==================================================================\nCreates and returns a new [SqlBuilder][1] initialized by appending the WITH clause using the provided string interpolated *handler*.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |\n| **WITH(SqlBuilder.ClauseStringHandler<WITH>)** | Creates and returns a new [SqlBuilder][1] initialized by appending the WITH clause using the provided string interpolated *handler*. |\n| [WITH(String)][3] | Creates and returns a new [SqlBuilder][1] initialized by appending the WITH clause using the provided *text*. |\n| [WITH(String, SqlBuilder)][4] | Creates and returns a new [SqlBuilder][1] initialized by appending the WITH clause using the provided *subQuery* and *alias*. |\n| [WITH(String, SqlSet)][5] | Creates and returns a new [SqlBuilder][1] initialized by appending the WITH clause using the provided *subQuery* and *alias*. |\n\n\nSyntax\n------\n\n```csharp\npublic static SqlBuilder WITH(\n\tref ClauseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<WITH>\nThe body of the WITH clause.\n\n#### Return Value\n[SqlBuilder][1] \n A new [SqlBuilder][1] after calling [WITH(SqlBuilder.ClauseStringHandler<WITH>)][6].\n\nSee Also\n--------\n\n#### Reference\n[SQL Class][7] \n[DbExtensions Namespace][2] \n\n[1]: ../SqlBuilder/README.md\n[2]: ../README.md\n[3]: WITH_1.md\n[4]: WITH_2.md\n[5]: WITH_3.md\n[6]: ../SqlBuilder/WITH.md\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SQL/WITH_1.md",
"content": "SQL.WITH(String) Method\n=======================\nCreates and returns a new [SqlBuilder][1] initialized by appending the WITH clause using the provided *text*.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |\n| [WITH(SqlBuilder.ClauseStringHandler<WITH>)][3] | Creates and returns a new [SqlBuilder][1] initialized by appending the WITH clause using the provided string interpolated *handler*. |\n| **WITH(String)** | Creates and returns a new [SqlBuilder][1] initialized by appending the WITH clause using the provided *text*. |\n| [WITH(String, SqlBuilder)][4] | Creates and returns a new [SqlBuilder][1] initialized by appending the WITH clause using the provided *subQuery* and *alias*. |\n| [WITH(String, SqlSet)][5] | Creates and returns a new [SqlBuilder][1] initialized by appending the WITH clause using the provided *subQuery* and *alias*. |\n\n\nSyntax\n------\n\n```csharp\npublic static SqlBuilder WITH(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][6]\nThe body of the WITH clause.\n\n#### Return Value\n[SqlBuilder][1] \n A new [SqlBuilder][1] after calling [WITH(String)][7].\n\nSee Also\n--------\n\n#### Reference\n[SQL Class][8] \n[DbExtensions Namespace][2] \n\n[1]: ../SqlBuilder/README.md\n[2]: ../README.md\n[3]: WITH.md\n[4]: WITH_2.md\n[5]: WITH_3.md\n[6]: https://learn.microsoft.com/dotnet/api/system.string\n[7]: ../SqlBuilder/WITH_1.md\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/SQL/WITH_2.md",
"content": "SQL.WITH(String, SqlBuilder) Method\n===================================\nCreates and returns a new [SqlBuilder][1] initialized by appending the WITH clause using the provided *subQuery* and *alias*.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |\n| [WITH(SqlBuilder.ClauseStringHandler<WITH>)][3] | Creates and returns a new [SqlBuilder][1] initialized by appending the WITH clause using the provided string interpolated *handler*. |\n| [WITH(String)][4] | Creates and returns a new [SqlBuilder][1] initialized by appending the WITH clause using the provided *text*. |\n| **WITH(String, SqlBuilder)** | Creates and returns a new [SqlBuilder][1] initialized by appending the WITH clause using the provided *subQuery* and *alias*. |\n| [WITH(String, SqlSet)][5] | Creates and returns a new [SqlBuilder][1] initialized by appending the WITH clause using the provided *subQuery* and *alias*. |\n\n\nSyntax\n------\n\n```csharp\npublic static SqlBuilder WITH(\n\tstring alias,\n\tSqlBuilder subQuery\n)\n```\n\n#### Parameters\n\n##### *alias* [String][6]\nThe alias of the sub-query.\n\n##### *subQuery* [SqlBuilder][1]\nThe sub-query to use as the body of the WITH clause.\n\n#### Return Value\n[SqlBuilder][1] \n A new [SqlBuilder][1] after calling [WITH(String, SqlBuilder)][7].\n\nSee Also\n--------\n\n#### Reference\n[SQL Class][8] \n[DbExtensions Namespace][2] \n\n[1]: ../SqlBuilder/README.md\n[2]: ../README.md\n[3]: WITH.md\n[4]: WITH_1.md\n[5]: WITH_3.md\n[6]: https://learn.microsoft.com/dotnet/api/system.string\n[7]: ../SqlBuilder/WITH_2.md\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/SQL/WITH_3.md",
"content": "SQL.WITH(String, SqlSet) Method\n===============================\nCreates and returns a new [SqlBuilder][1] initialized by appending the WITH clause using the provided *subQuery* and *alias*.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |\n| [WITH(SqlBuilder.ClauseStringHandler<WITH>)][3] | Creates and returns a new [SqlBuilder][1] initialized by appending the WITH clause using the provided string interpolated *handler*. |\n| [WITH(String)][4] | Creates and returns a new [SqlBuilder][1] initialized by appending the WITH clause using the provided *text*. |\n| [WITH(String, SqlBuilder)][5] | Creates and returns a new [SqlBuilder][1] initialized by appending the WITH clause using the provided *subQuery* and *alias*. |\n| **WITH(String, SqlSet)** | Creates and returns a new [SqlBuilder][1] initialized by appending the WITH clause using the provided *subQuery* and *alias*. |\n\n\nSyntax\n------\n\n```csharp\npublic static SqlBuilder WITH(\n\tstring alias,\n\tSqlSet subQuery\n)\n```\n\n#### Parameters\n\n##### *alias* [String][6]\nThe alias of the sub-query.\n\n##### *subQuery* [SqlSet][7]\nThe sub-query to use as the body of the WITH clause.\n\n#### Return Value\n[SqlBuilder][1] \n A new [SqlBuilder][1] after calling [WITH(String, SqlSet)][8].\n\nSee Also\n--------\n\n#### Reference\n[SQL Class][9] \n[DbExtensions Namespace][2] \n\n[1]: ../SqlBuilder/README.md\n[2]: ../README.md\n[3]: WITH.md\n[4]: WITH_1.md\n[5]: WITH_2.md\n[6]: https://learn.microsoft.com/dotnet/api/system.string\n[7]: ../SqlSet/README.md\n[8]: ../SqlBuilder/WITH_3.md\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/Append.md",
"content": "SqlBuilder.Append(SqlBuilder.AppendStringHandler) Method\n========================================================\nAppends the interpolated string *handler* to this instance.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------- | ----------------------------------------------------------- |\n| **Append(AppendStringHandler)** | Appends the interpolated string *handler* to this instance. |\n| [Append(String)][2] | Appends *text* to this instance. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder Append(\n\tref AppendStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* AppendStringHandler\nThe interpolated string.\n\n#### Return Value\n[SqlBuilder][3] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Append_1.md\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/AppendClause.md",
"content": "SqlBuilder.AppendClause(SqlClause) Method\n=========================================\nAppends the SQL *clause*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------- | --------------------------------------------- |\n| **AppendClause(SqlClause)** | Appends the SQL *clause*. |\n| [AppendClause<TClause>()][2] | Appends the SQL clause identified by TClause. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder AppendClause(\n\tSqlClause clause\n)\n```\n\n#### Parameters\n\n##### *clause* [SqlClause][3]\nThe clause to append.\n\n#### Return Value\n[SqlBuilder][4] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: AppendClause__1.md\n[3]: ../SqlClause/README.md\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/AppendClause__1.md",
"content": "SqlBuilder.AppendClause<TClause> Method\n==========================================\nAppends the SQL clause identified by TClause.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------ | --------------------------------------------- |\n| [AppendClause(SqlClause)][2] | Appends the SQL *clause*. |\n| **AppendClause<TClause>()** | Appends the SQL clause identified by TClause. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder AppendClause()\nwhere TClause : new(), SqlClause\n\n```\n\n#### Type Parameters\n\n##### *TClause*\nThe type of the SQL clause.\n\n#### Return Value\n[SqlBuilder][3] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: AppendClause.md\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/AppendElse.md",
"content": "SqlBuilder.AppendElse Method\n============================\nAppends the interpolated string *handler* if an antecedent call to [AppendIf(Boolean, AppendStringHandler)][1] or [AppendElseIf(Boolean, AppendElseStringHandler)][2] used a `false` condition\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder AppendElse(\n\tref AppendElseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* AppendElseStringHandler\nThe interpolated string to append.\n\n#### Return Value\n[SqlBuilder][4] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][4] \n[DbExtensions Namespace][3] \n\n[1]: AppendIf.md\n[2]: AppendElseIf.md\n[3]: ../README.md\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/AppendElseIf.md",
"content": "SqlBuilder.AppendElseIf Method\n==============================\nAppends the interpolated string *handler* if *condition* is `true` and an antecedent call to [AppendIf(Boolean, AppendStringHandler)][1] or **AppendElseIf(Boolean, AppendElseStringHandler)** used a `false` condition.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder AppendElseIf(\n\tbool condition,\n\tref AppendElseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *condition* [Boolean][3]\n`true` to append *handler*; otherwise, `false`.\n\n##### *handler* AppendElseStringHandler\nThe interpolated string to append.\n\n#### Return Value\n[SqlBuilder][4] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][4] \n[DbExtensions Namespace][2] \n\n[1]: AppendIf.md\n[2]: ../README.md\n[3]: https://learn.microsoft.com/dotnet/api/system.boolean\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/AppendIf.md",
"content": "SqlBuilder.AppendIf Method\n==========================\nAppends the interpolated string *handler* if *condition* is `true`.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder AppendIf(\n\tbool condition,\n\tref AppendStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *condition* [Boolean][2]\n`true` to append *handler*; otherwise, `false`.\n\n##### *handler* AppendStringHandler\nThe interpolated string to append.\n\n#### Return Value\n[SqlBuilder][3] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.boolean\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/AppendLine.md",
"content": "SqlBuilder.AppendLine Method\n============================\nAppends the default line terminator to this instance.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder AppendLine()\n```\n\n#### Return Value\n[SqlBuilder][2] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][2] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/AppendSql.md",
"content": "SqlBuilder.AppendSql Method\n===========================\nAppends *sql* to this instance.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder AppendSql(\n\tSqlBuilder sql\n)\n```\n\n#### Parameters\n\n##### *sql* [SqlBuilder][2]\nA [SqlBuilder][2].\n\n#### Return Value\n[SqlBuilder][2] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][2] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/Append_1.md",
"content": "SqlBuilder.Append(String) Method\n================================\nAppends *text* to this instance.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------- | ----------------------------------------------------------- |\n| [Append(AppendStringHandler)][2] | Appends the interpolated string *handler* to this instance. |\n| **Append(String)** | Appends *text* to this instance. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder Append(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][3]\nThe string.\n\n#### Return Value\n[SqlBuilder][4] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Append.md\n[3]: https://learn.microsoft.com/dotnet/api/system.string\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/Buffer.md",
"content": "SqlBuilder.Buffer Property\n==========================\nThe underlying [StringBuilder][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic StringBuilder Buffer { get; }\n```\n\n#### Property Value\n[StringBuilder][1]\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][3] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.text.stringbuilder\n[2]: ../README.md\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/CROSS_JOIN.md",
"content": "SqlBuilder.CROSS_JOIN Method\n============================\nSets CROSS JOIN as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **CROSS_JOIN()** | Sets CROSS JOIN as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][1]. |\n| [CROSS_JOIN(SqlBuilder.ClauseStringHandler<CROSS_JOIN>)][3] | Appends the CROSS JOIN clause using the provided interpolated string *handler*. |\n| [CROSS_JOIN(String)][4] | Appends the CROSS JOIN clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder CROSS_JOIN()\n```\n\n#### Return Value\n[SqlBuilder][5] \nA reference to this instance after the operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][5] \n[DbExtensions Namespace][2] \n\n[1]: _If.md\n[2]: ../README.md\n[3]: CROSS_JOIN_1.md\n[4]: CROSS_JOIN_2.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/CROSS_JOIN_1.md",
"content": "SqlBuilder.CROSS_JOIN(SqlBuilder.ClauseStringHandler<SqlClause.CROSS_JOIN>) Method\n=====================================================================================\nAppends the CROSS JOIN clause using the provided interpolated string *handler*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [CROSS_JOIN()][2] | Sets CROSS JOIN as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| **CROSS_JOIN(SqlBuilder.ClauseStringHandler<CROSS_JOIN>)** | Appends the CROSS JOIN clause using the provided interpolated string *handler*. |\n| [CROSS_JOIN(String)][4] | Appends the CROSS JOIN clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder CROSS_JOIN(\n\tref ClauseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<CROSS_JOIN>\nThe interpolated string that represents the body of the CROSS JOIN clause.\n\n#### Return Value\n[SqlBuilder][5] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: CROSS_JOIN.md\n[3]: _If.md\n[4]: CROSS_JOIN_2.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/CROSS_JOIN_2.md",
"content": "SqlBuilder.CROSS_JOIN(String) Method\n====================================\nAppends the CROSS JOIN clause using the provided *text*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [CROSS_JOIN()][2] | Sets CROSS JOIN as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| [CROSS_JOIN(SqlBuilder.ClauseStringHandler<CROSS_JOIN>)][4] | Appends the CROSS JOIN clause using the provided interpolated string *handler*. |\n| **CROSS_JOIN(String)** | Appends the CROSS JOIN clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder CROSS_JOIN(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][5]\nThe text that represents the body of the CROSS JOIN clause.\n\n#### Return Value\n[SqlBuilder][6] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: CROSS_JOIN.md\n[3]: _If.md\n[4]: CROSS_JOIN_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.string\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/Clone.md",
"content": "SqlBuilder.Clone Method\n=======================\nCreates and returns a copy of this instance.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder Clone()\n```\n\n#### Return Value\n[SqlBuilder][2] \nA new [SqlBuilder][2] that is equivalent to this instance.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][2] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/CurrentClause.md",
"content": "SqlBuilder.CurrentClause Property\n=================================\nGets or sets the current SQL clause, used to identify consecutive appends to the same clause.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic SqlClause? CurrentClause { get; set; }\n```\n\n#### Property Value\n[SqlClause][2]\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: ../SqlClause/README.md\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/DELETE_FROM.md",
"content": "SqlBuilder.DELETE_FROM(SqlBuilder.ClauseStringHandler<SqlClause.DELETE_FROM>) Method\n=======================================================================================\nAppends the DELETE FROM clause using the provided interpolated string *handler*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------------------- | -------------------------------------------------------------------------------- |\n| **DELETE_FROM(SqlBuilder.ClauseStringHandler<DELETE_FROM>)** | Appends the DELETE FROM clause using the provided interpolated string *handler*. |\n| [DELETE_FROM(String)][2] | Appends the DELETE FROM clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder DELETE_FROM(\n\tref ClauseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<DELETE_FROM>\nThe interpolated string that represents the body of the DELETE FROM clause.\n\n#### Return Value\n[SqlBuilder][3] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: DELETE_FROM_1.md\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/DELETE_FROM_1.md",
"content": "SqlBuilder.DELETE_FROM(String) Method\n=====================================\nAppends the DELETE FROM clause using the provided *text*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------------------- | -------------------------------------------------------------------------------- |\n| [DELETE_FROM(SqlBuilder.ClauseStringHandler<DELETE_FROM>)][2] | Appends the DELETE FROM clause using the provided interpolated string *handler*. |\n| **DELETE_FROM(String)** | Appends the DELETE FROM clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder DELETE_FROM(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][3]\nThe text that represents the body of the DELETE FROM clause.\n\n#### Return Value\n[SqlBuilder][4] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: DELETE_FROM.md\n[3]: https://learn.microsoft.com/dotnet/api/system.string\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/FROM.md",
"content": "SqlBuilder.FROM Method\n======================\nSets FROM as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **FROM()** | Sets FROM as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][1]. |\n| [FROM(SqlBuilder.ClauseStringHandler<FROM>)][3] | Appends the FROM clause using the provided interpolated string *handler*. |\n| [FROM(String)][4] | Appends the FROM clause using the provided *text*. |\n| [FROM(SqlBuilder, String)][5] | Appends the FROM clause using the provided *subQuery* as body named after *alias*. |\n| [FROM(SqlSet, String)][6] | Appends the FROM clause using the provided *subQuery* as body named after *alias*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder FROM()\n```\n\n#### Return Value\n[SqlBuilder][7] \nA reference to this instance after the operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][7] \n[DbExtensions Namespace][2] \n\n[1]: _If.md\n[2]: ../README.md\n[3]: FROM_2.md\n[4]: FROM_4.md\n[5]: FROM_1.md\n[6]: FROM_3.md\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/FROM_1.md",
"content": "SqlBuilder.FROM(SqlBuilder, String) Method\n==========================================\nAppends the FROM clause using the provided *subQuery* as body named after *alias*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [FROM()][2] | Sets FROM as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| [FROM(SqlBuilder.ClauseStringHandler<FROM>)][4] | Appends the FROM clause using the provided interpolated string *handler*. |\n| [FROM(String)][5] | Appends the FROM clause using the provided *text*. |\n| **FROM(SqlBuilder, String)** | Appends the FROM clause using the provided *subQuery* as body named after *alias*. |\n| [FROM(SqlSet, String)][6] | Appends the FROM clause using the provided *subQuery* as body named after *alias*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder FROM(\n\tSqlBuilder subQuery,\n\tstring alias\n)\n```\n\n#### Parameters\n\n##### *subQuery* [SqlBuilder][7]\nThe sub-query to use as the body of the FROM clause.\n\n##### *alias* [String][8]\nThe alias of the sub-query.\n\n#### Return Value\n[SqlBuilder][7] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: FROM.md\n[3]: _If.md\n[4]: FROM_2.md\n[5]: FROM_4.md\n[6]: FROM_3.md\n[7]: README.md\n[8]: https://learn.microsoft.com/dotnet/api/system.string"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/FROM_2.md",
"content": "SqlBuilder.FROM(SqlBuilder.ClauseStringHandler<SqlClause.FROM>) Method\n=========================================================================\nAppends the FROM clause using the provided interpolated string *handler*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [FROM()][2] | Sets FROM as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| **FROM(SqlBuilder.ClauseStringHandler<FROM>)** | Appends the FROM clause using the provided interpolated string *handler*. |\n| [FROM(String)][4] | Appends the FROM clause using the provided *text*. |\n| [FROM(SqlBuilder, String)][5] | Appends the FROM clause using the provided *subQuery* as body named after *alias*. |\n| [FROM(SqlSet, String)][6] | Appends the FROM clause using the provided *subQuery* as body named after *alias*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder FROM(\n\tref ClauseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<FROM>\nThe interpolated string that represents the body of the FROM clause.\n\n#### Return Value\n[SqlBuilder][7] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: FROM.md\n[3]: _If.md\n[4]: FROM_4.md\n[5]: FROM_1.md\n[6]: FROM_3.md\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/FROM_3.md",
"content": "SqlBuilder.FROM(SqlSet, String) Method\n======================================\nAppends the FROM clause using the provided *subQuery* as body named after *alias*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [FROM()][2] | Sets FROM as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| [FROM(SqlBuilder.ClauseStringHandler<FROM>)][4] | Appends the FROM clause using the provided interpolated string *handler*. |\n| [FROM(String)][5] | Appends the FROM clause using the provided *text*. |\n| [FROM(SqlBuilder, String)][6] | Appends the FROM clause using the provided *subQuery* as body named after *alias*. |\n| **FROM(SqlSet, String)** | Appends the FROM clause using the provided *subQuery* as body named after *alias*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder FROM(\n\tSqlSet subQuery,\n\tstring alias\n)\n```\n\n#### Parameters\n\n##### *subQuery* [SqlSet][7]\nThe sub-query to use as the body of the FROM clause.\n\n##### *alias* [String][8]\nThe alias of the sub-query.\n\n#### Return Value\n[SqlBuilder][9] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][9] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: FROM.md\n[3]: _If.md\n[4]: FROM_2.md\n[5]: FROM_4.md\n[6]: FROM_1.md\n[7]: ../SqlSet/README.md\n[8]: https://learn.microsoft.com/dotnet/api/system.string\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/FROM_4.md",
"content": "SqlBuilder.FROM(String) Method\n==============================\nAppends the FROM clause using the provided *text*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [FROM()][2] | Sets FROM as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| [FROM(SqlBuilder.ClauseStringHandler<FROM>)][4] | Appends the FROM clause using the provided interpolated string *handler*. |\n| **FROM(String)** | Appends the FROM clause using the provided *text*. |\n| [FROM(SqlBuilder, String)][5] | Appends the FROM clause using the provided *subQuery* as body named after *alias*. |\n| [FROM(SqlSet, String)][6] | Appends the FROM clause using the provided *subQuery* as body named after *alias*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder FROM(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][7]\nThe text that represents the body of the FROM clause.\n\n#### Return Value\n[SqlBuilder][8] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][8] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: FROM.md\n[3]: _If.md\n[4]: FROM_2.md\n[5]: FROM_1.md\n[6]: FROM_3.md\n[7]: https://learn.microsoft.com/dotnet/api/system.string\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/GROUP_BY.md",
"content": "SqlBuilder.GROUP_BY Method\n==========================\nSets GROUP BY as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **GROUP_BY()** | Sets GROUP BY as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][1]. |\n| [GROUP_BY(SqlBuilder.ClauseStringHandler<GROUP_BY>)][3] | Appends the GROUP BY clause using the provided interpolated string *handler*. |\n| [GROUP_BY(String)][4] | Appends the GROUP BY clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder GROUP_BY()\n```\n\n#### Return Value\n[SqlBuilder][5] \nA reference to this instance after the operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][5] \n[DbExtensions Namespace][2] \n\n[1]: _If.md\n[2]: ../README.md\n[3]: GROUP_BY_1.md\n[4]: GROUP_BY_2.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/GROUP_BY_1.md",
"content": "SqlBuilder.GROUP_BY(SqlBuilder.ClauseStringHandler<SqlClause.GROUP_BY>) Method\n=================================================================================\nAppends the GROUP BY clause using the provided interpolated string *handler*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [GROUP_BY()][2] | Sets GROUP BY as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| **GROUP_BY(SqlBuilder.ClauseStringHandler<GROUP_BY>)** | Appends the GROUP BY clause using the provided interpolated string *handler*. |\n| [GROUP_BY(String)][4] | Appends the GROUP BY clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder GROUP_BY(\n\tref ClauseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<GROUP_BY>\nThe interpolated string that represents the body of the GROUP BY clause.\n\n#### Return Value\n[SqlBuilder][5] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: GROUP_BY.md\n[3]: _If.md\n[4]: GROUP_BY_2.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/GROUP_BY_2.md",
"content": "SqlBuilder.GROUP_BY(String) Method\n==================================\nAppends the GROUP BY clause using the provided *text*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [GROUP_BY()][2] | Sets GROUP BY as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| [GROUP_BY(SqlBuilder.ClauseStringHandler<GROUP_BY>)][4] | Appends the GROUP BY clause using the provided interpolated string *handler*. |\n| **GROUP_BY(String)** | Appends the GROUP BY clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder GROUP_BY(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][5]\nThe text that represents the body of the GROUP BY clause.\n\n#### Return Value\n[SqlBuilder][6] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: GROUP_BY.md\n[3]: _If.md\n[4]: GROUP_BY_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.string\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/HAVING.md",
"content": "SqlBuilder.HAVING Method\n========================\nSets HAVING as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **HAVING()** | Sets HAVING as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][1]. |\n| [HAVING(SqlBuilder.ClauseStringHandler<HAVING>)][3] | Appends the HAVING clause using the provided interpolated string *handler*. |\n| [HAVING(String)][4] | Appends the HAVING clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder HAVING()\n```\n\n#### Return Value\n[SqlBuilder][5] \nA reference to this instance after the operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][5] \n[DbExtensions Namespace][2] \n\n[1]: _If.md\n[2]: ../README.md\n[3]: HAVING_1.md\n[4]: HAVING_2.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/HAVING_1.md",
"content": "SqlBuilder.HAVING(SqlBuilder.ClauseStringHandler<SqlClause.HAVING>) Method\n=============================================================================\nAppends the HAVING clause using the provided interpolated string *handler*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [HAVING()][2] | Sets HAVING as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| **HAVING(SqlBuilder.ClauseStringHandler<HAVING>)** | Appends the HAVING clause using the provided interpolated string *handler*. |\n| [HAVING(String)][4] | Appends the HAVING clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder HAVING(\n\tref ClauseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<HAVING>\nThe interpolated string that represents the body of the HAVING clause.\n\n#### Return Value\n[SqlBuilder][5] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: HAVING.md\n[3]: _If.md\n[4]: HAVING_2.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/HAVING_2.md",
"content": "SqlBuilder.HAVING(String) Method\n================================\nAppends the HAVING clause using the provided *text*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [HAVING()][2] | Sets HAVING as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| [HAVING(SqlBuilder.ClauseStringHandler<HAVING>)][4] | Appends the HAVING clause using the provided interpolated string *handler*. |\n| **HAVING(String)** | Appends the HAVING clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder HAVING(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][5]\nThe text that represents the body of the HAVING clause.\n\n#### Return Value\n[SqlBuilder][6] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: HAVING.md\n[3]: _If.md\n[4]: HAVING_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.string\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/INNER_JOIN.md",
"content": "SqlBuilder.INNER_JOIN Method\n============================\nSets INNER JOIN as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **INNER_JOIN()** | Sets INNER JOIN as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][1]. |\n| [INNER_JOIN(SqlBuilder.ClauseStringHandler<INNER_JOIN>)][3] | Appends the INNER JOIN clause using the provided interpolated string *handler*. |\n| [INNER_JOIN(String)][4] | Appends the INNER JOIN clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder INNER_JOIN()\n```\n\n#### Return Value\n[SqlBuilder][5] \nA reference to this instance after the operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][5] \n[DbExtensions Namespace][2] \n\n[1]: _If.md\n[2]: ../README.md\n[3]: INNER_JOIN_1.md\n[4]: INNER_JOIN_2.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/INNER_JOIN_1.md",
"content": "SqlBuilder.INNER_JOIN(SqlBuilder.ClauseStringHandler<SqlClause.INNER_JOIN>) Method\n=====================================================================================\nAppends the INNER JOIN clause using the provided interpolated string *handler*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [INNER_JOIN()][2] | Sets INNER JOIN as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| **INNER_JOIN(SqlBuilder.ClauseStringHandler<INNER_JOIN>)** | Appends the INNER JOIN clause using the provided interpolated string *handler*. |\n| [INNER_JOIN(String)][4] | Appends the INNER JOIN clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder INNER_JOIN(\n\tref ClauseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<INNER_JOIN>\nThe interpolated string that represents the body of the INNER JOIN clause.\n\n#### Return Value\n[SqlBuilder][5] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: INNER_JOIN.md\n[3]: _If.md\n[4]: INNER_JOIN_2.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/INNER_JOIN_2.md",
"content": "SqlBuilder.INNER_JOIN(String) Method\n====================================\nAppends the INNER JOIN clause using the provided *text*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [INNER_JOIN()][2] | Sets INNER JOIN as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| [INNER_JOIN(SqlBuilder.ClauseStringHandler<INNER_JOIN>)][4] | Appends the INNER JOIN clause using the provided interpolated string *handler*. |\n| **INNER_JOIN(String)** | Appends the INNER JOIN clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder INNER_JOIN(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][5]\nThe text that represents the body of the INNER JOIN clause.\n\n#### Return Value\n[SqlBuilder][6] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: INNER_JOIN.md\n[3]: _If.md\n[4]: INNER_JOIN_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.string\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/INSERT_INTO.md",
"content": "SqlBuilder.INSERT_INTO(SqlBuilder.ClauseStringHandler<SqlClause.INSERT_INTO>) Method\n=======================================================================================\nAppends the INSERT INTO clause using the provided interpolated string *handler*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------------------- | -------------------------------------------------------------------------------- |\n| **INSERT_INTO(SqlBuilder.ClauseStringHandler<INSERT_INTO>)** | Appends the INSERT INTO clause using the provided interpolated string *handler*. |\n| [INSERT_INTO(String)][2] | Appends the INSERT INTO clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder INSERT_INTO(\n\tref ClauseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<INSERT_INTO>\nThe interpolated string that represents the body of the INSERT INTO clause.\n\n#### Return Value\n[SqlBuilder][3] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: INSERT_INTO_1.md\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/INSERT_INTO_1.md",
"content": "SqlBuilder.INSERT_INTO(String) Method\n=====================================\nAppends the INSERT INTO clause using the provided *text*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------------------- | -------------------------------------------------------------------------------- |\n| [INSERT_INTO(SqlBuilder.ClauseStringHandler<INSERT_INTO>)][2] | Appends the INSERT INTO clause using the provided interpolated string *handler*. |\n| **INSERT_INTO(String)** | Appends the INSERT INTO clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder INSERT_INTO(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][3]\nThe text that represents the body of the INSERT INTO clause.\n\n#### Return Value\n[SqlBuilder][4] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: INSERT_INTO.md\n[3]: https://learn.microsoft.com/dotnet/api/system.string\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/InsertText.md",
"content": "SqlBuilder.InsertText Method\n============================\nInserts a string into this instance at the specified character position.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder InsertText(\n\tint index,\n\tstring? value\n)\n```\n\n#### Parameters\n\n##### *index* [Int32][2]\nThe position in this instance where insertion begins.\n\n##### *value* [String][3]\nThe string to insert.\n\n#### Return Value\n[SqlBuilder][4] \nA reference to this instance after the insert operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.int32\n[3]: https://learn.microsoft.com/dotnet/api/system.string\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/IsEmpty.md",
"content": "SqlBuilder.IsEmpty Property\n===========================\nReturns `true` if the buffer is empty.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic bool IsEmpty { get; }\n```\n\n#### Property Value\n[Boolean][2]\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.boolean\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/JOIN.md",
"content": "SqlBuilder.JOIN Method\n======================\nSets JOIN as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **JOIN()** | Sets JOIN as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][1]. |\n| [JOIN(SqlBuilder.ClauseStringHandler<JOIN>)][3] | Appends the JOIN clause using the provided interpolated string *handler*. |\n| [JOIN(String)][4] | Appends the JOIN clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder JOIN()\n```\n\n#### Return Value\n[SqlBuilder][5] \nA reference to this instance after the operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][5] \n[DbExtensions Namespace][2] \n\n[1]: _If.md\n[2]: ../README.md\n[3]: JOIN_1.md\n[4]: JOIN_2.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/JOIN_1.md",
"content": "SqlBuilder.JOIN(SqlBuilder.ClauseStringHandler<SqlClause.JOIN>) Method\n=========================================================================\nAppends the JOIN clause using the provided interpolated string *handler*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [JOIN()][2] | Sets JOIN as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| **JOIN(SqlBuilder.ClauseStringHandler<JOIN>)** | Appends the JOIN clause using the provided interpolated string *handler*. |\n| [JOIN(String)][4] | Appends the JOIN clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder JOIN(\n\tref ClauseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<JOIN>\nThe interpolated string that represents the body of the JOIN clause.\n\n#### Return Value\n[SqlBuilder][5] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: JOIN.md\n[3]: _If.md\n[4]: JOIN_2.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/JOIN_2.md",
"content": "SqlBuilder.JOIN(String) Method\n==============================\nAppends the JOIN clause using the provided *text*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [JOIN()][2] | Sets JOIN as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| [JOIN(SqlBuilder.ClauseStringHandler<JOIN>)][4] | Appends the JOIN clause using the provided interpolated string *handler*. |\n| **JOIN(String)** | Appends the JOIN clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder JOIN(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][5]\nThe text that represents the body of the JOIN clause.\n\n#### Return Value\n[SqlBuilder][6] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: JOIN.md\n[3]: _If.md\n[4]: JOIN_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.string\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/JoinSql.md",
"content": "SqlBuilder.JoinSql(String, SqlBuilder[]) Method\n===============================================\nConcatenates a specified separator [String][1] between each element of a specified [SqlBuilder][2] array, yielding a single concatenated [SqlBuilder][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **JoinSql(String, SqlBuilder[])** | Concatenates a specified separator [String][1] between each element of a specified [SqlBuilder][2] array, yielding a single concatenated [SqlBuilder][2]. |\n| [JoinSql(String, IEnumerable<SqlBuilder>)][4] | Concatenates the members of a constructed [IEnumerable<T>][5] collection of type [SqlBuilder][2], using the specified *separator* between each member. |\n\n\nSyntax\n------\n\n```csharp\npublic static SqlBuilder JoinSql(\n\tstring? separator,\n\tparams SqlBuilder?[] values\n)\n```\n\n#### Parameters\n\n##### *separator* [String][1]\nThe string to use as a separator.\n\n##### *values* [SqlBuilder][2][]\nAn array of [SqlBuilder][2].\n\n#### Return Value\n[SqlBuilder][2] \n A [SqlBuilder][2] consisting of the elements of *values* interspersed with the *separator* string.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][2] \n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.string\n[2]: README.md\n[3]: ../README.md\n[4]: JoinSql_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/JoinSql_1.md",
"content": "SqlBuilder.JoinSql(String, IEnumerable<SqlBuilder>) Method\n=============================================================\nConcatenates the members of a constructed [IEnumerable<T>][1] collection of type [SqlBuilder][2], using the specified *separator* between each member.\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [JoinSql(String, SqlBuilder[])][4] | Concatenates a specified separator [String][5] between each element of a specified [SqlBuilder][2] array, yielding a single concatenated [SqlBuilder][2]. |\n| **JoinSql(String, IEnumerable<SqlBuilder>)** | Concatenates the members of a constructed [IEnumerable<T>][1] collection of type [SqlBuilder][2], using the specified *separator* between each member. |\n\n\nSyntax\n------\n\n```csharp\npublic static SqlBuilder JoinSql(\n\tstring? separator,\n\tIEnumerable values\n)\n```\n\n#### Parameters\n\n##### *separator* [String][5]\nThe string to use as a separator.\n\n##### *values* [IEnumerable][1]<[SqlBuilder][2]>\nA collection that contains the [SqlBuilder][2] objects to concatenate.\n\n#### Return Value\n[SqlBuilder][2] \n A [SqlBuilder][2] that consists of the members of *values* delimited by the *separator* string. If *values* has no members, the method returns an empty [SqlBuilder][2].\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][2] \n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1\n[2]: README.md\n[3]: ../README.md\n[4]: JoinSql.md\n[5]: https://learn.microsoft.com/dotnet/api/system.string"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/LEFT_JOIN.md",
"content": "SqlBuilder.LEFT_JOIN Method\n===========================\nSets LEFT JOIN as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| **LEFT_JOIN()** | Sets LEFT JOIN as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][1]. |\n| [LEFT_JOIN(SqlBuilder.ClauseStringHandler<LEFT_JOIN>)][3] | Appends the LEFT JOIN clause using the provided interpolated string *handler*. |\n| [LEFT_JOIN(String)][4] | Appends the LEFT JOIN clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder LEFT_JOIN()\n```\n\n#### Return Value\n[SqlBuilder][5] \nA reference to this instance after the operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][5] \n[DbExtensions Namespace][2] \n\n[1]: _If.md\n[2]: ../README.md\n[3]: LEFT_JOIN_1.md\n[4]: LEFT_JOIN_2.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/LEFT_JOIN_1.md",
"content": "SqlBuilder.LEFT_JOIN(SqlBuilder.ClauseStringHandler<SqlClause.LEFT_JOIN>) Method\n===================================================================================\nAppends the LEFT JOIN clause using the provided interpolated string *handler*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [LEFT_JOIN()][2] | Sets LEFT JOIN as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| **LEFT_JOIN(SqlBuilder.ClauseStringHandler<LEFT_JOIN>)** | Appends the LEFT JOIN clause using the provided interpolated string *handler*. |\n| [LEFT_JOIN(String)][4] | Appends the LEFT JOIN clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder LEFT_JOIN(\n\tref ClauseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<LEFT_JOIN>\nThe interpolated string that represents the body of the LEFT JOIN clause.\n\n#### Return Value\n[SqlBuilder][5] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: LEFT_JOIN.md\n[3]: _If.md\n[4]: LEFT_JOIN_2.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/LEFT_JOIN_2.md",
"content": "SqlBuilder.LEFT_JOIN(String) Method\n===================================\nAppends the LEFT JOIN clause using the provided *text*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [LEFT_JOIN()][2] | Sets LEFT JOIN as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| [LEFT_JOIN(SqlBuilder.ClauseStringHandler<LEFT_JOIN>)][4] | Appends the LEFT JOIN clause using the provided interpolated string *handler*. |\n| **LEFT_JOIN(String)** | Appends the LEFT JOIN clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder LEFT_JOIN(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][5]\nThe text that represents the body of the LEFT JOIN clause.\n\n#### Return Value\n[SqlBuilder][6] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: LEFT_JOIN.md\n[3]: _If.md\n[4]: LEFT_JOIN_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.string\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/LIMIT.md",
"content": "SqlBuilder.LIMIT Method\n=======================\nSets LIMIT as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **LIMIT()** | Sets LIMIT as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][1]. |\n| [LIMIT(SqlBuilder.ClauseStringHandler<LIMIT>)][3] | Appends the LIMIT clause using the provided interpolated string *handler*. |\n| [LIMIT(Int32)][4] | Appends the LIMIT clause using the provided *maxRecords* parameter. |\n| [LIMIT(String)][5] | Appends the LIMIT clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder LIMIT()\n```\n\n#### Return Value\n[SqlBuilder][6] \nA reference to this instance after the operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][6] \n[DbExtensions Namespace][2] \n\n[1]: _If.md\n[2]: ../README.md\n[3]: LIMIT_1.md\n[4]: LIMIT_2.md\n[5]: LIMIT_3.md\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/LIMIT_1.md",
"content": "SqlBuilder.LIMIT(SqlBuilder.ClauseStringHandler<SqlClause.LIMIT>) Method\n===========================================================================\nAppends the LIMIT clause using the provided interpolated string *handler*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [LIMIT()][2] | Sets LIMIT as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| **LIMIT(SqlBuilder.ClauseStringHandler<LIMIT>)** | Appends the LIMIT clause using the provided interpolated string *handler*. |\n| [LIMIT(Int32)][4] | Appends the LIMIT clause using the provided *maxRecords* parameter. |\n| [LIMIT(String)][5] | Appends the LIMIT clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder LIMIT(\n\tref ClauseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<LIMIT>\nThe interpolated string that represents the body of the LIMIT clause.\n\n#### Return Value\n[SqlBuilder][6] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: LIMIT.md\n[3]: _If.md\n[4]: LIMIT_2.md\n[5]: LIMIT_3.md\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/LIMIT_2.md",
"content": "SqlBuilder.LIMIT(Int32) Method\n==============================\nAppends the LIMIT clause using the provided *maxRecords* parameter.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [LIMIT()][2] | Sets LIMIT as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| [LIMIT(SqlBuilder.ClauseStringHandler<LIMIT>)][4] | Appends the LIMIT clause using the provided interpolated string *handler*. |\n| **LIMIT(Int32)** | Appends the LIMIT clause using the provided *maxRecords* parameter. |\n| [LIMIT(String)][5] | Appends the LIMIT clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder LIMIT(\n\tint maxRecords\n)\n```\n\n#### Parameters\n\n##### *maxRecords* [Int32][6]\nThe value to use as parameter.\n\n#### Return Value\n[SqlBuilder][7] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: LIMIT.md\n[3]: _If.md\n[4]: LIMIT_1.md\n[5]: LIMIT_3.md\n[6]: https://learn.microsoft.com/dotnet/api/system.int32\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/LIMIT_3.md",
"content": "SqlBuilder.LIMIT(String) Method\n===============================\nAppends the LIMIT clause using the provided *text*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [LIMIT()][2] | Sets LIMIT as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| [LIMIT(SqlBuilder.ClauseStringHandler<LIMIT>)][4] | Appends the LIMIT clause using the provided interpolated string *handler*. |\n| [LIMIT(Int32)][5] | Appends the LIMIT clause using the provided *maxRecords* parameter. |\n| **LIMIT(String)** | Appends the LIMIT clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder LIMIT(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][6]\nThe text that represents the body of the LIMIT clause.\n\n#### Return Value\n[SqlBuilder][7] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: LIMIT.md\n[3]: _If.md\n[4]: LIMIT_1.md\n[5]: LIMIT_2.md\n[6]: https://learn.microsoft.com/dotnet/api/system.string\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/NextClause.md",
"content": "SqlBuilder.NextClause Property\n==============================\nGets or sets the next SQL clause. Used by clause continuation methods, such as [_(String)][1] and [_If(Boolean, ConditionalStringHandler)][2].\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic SqlClause? NextClause { get; set; }\n```\n\n#### Property Value\n[SqlClause][4]\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][5] \n[DbExtensions Namespace][3] \n\n[1]: __1.md\n[2]: _If.md\n[3]: ../README.md\n[4]: ../SqlClause/README.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/OFFSET.md",
"content": "SqlBuilder.OFFSET Method\n========================\nSets OFFSET as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **OFFSET()** | Sets OFFSET as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][1]. |\n| [OFFSET(SqlBuilder.ClauseStringHandler<OFFSET>)][3] | Appends the OFFSET clause using the provided interpolated string *handler*. |\n| [OFFSET(Int32)][4] | Appends the OFFSET clause using the provided *startIndex* parameter. |\n| [OFFSET(String)][5] | Appends the OFFSET clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder OFFSET()\n```\n\n#### Return Value\n[SqlBuilder][6] \nA reference to this instance after the operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][6] \n[DbExtensions Namespace][2] \n\n[1]: _If.md\n[2]: ../README.md\n[3]: OFFSET_1.md\n[4]: OFFSET_2.md\n[5]: OFFSET_3.md\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/OFFSET_1.md",
"content": "SqlBuilder.OFFSET(SqlBuilder.ClauseStringHandler<SqlClause.OFFSET>) Method\n=============================================================================\nAppends the OFFSET clause using the provided interpolated string *handler*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [OFFSET()][2] | Sets OFFSET as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| **OFFSET(SqlBuilder.ClauseStringHandler<OFFSET>)** | Appends the OFFSET clause using the provided interpolated string *handler*. |\n| [OFFSET(Int32)][4] | Appends the OFFSET clause using the provided *startIndex* parameter. |\n| [OFFSET(String)][5] | Appends the OFFSET clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder OFFSET(\n\tref ClauseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<OFFSET>\nThe interpolated string that represents the body of the OFFSET clause.\n\n#### Return Value\n[SqlBuilder][6] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: OFFSET.md\n[3]: _If.md\n[4]: OFFSET_2.md\n[5]: OFFSET_3.md\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/OFFSET_2.md",
"content": "SqlBuilder.OFFSET(Int32) Method\n===============================\nAppends the OFFSET clause using the provided *startIndex* parameter.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [OFFSET()][2] | Sets OFFSET as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| [OFFSET(SqlBuilder.ClauseStringHandler<OFFSET>)][4] | Appends the OFFSET clause using the provided interpolated string *handler*. |\n| **OFFSET(Int32)** | Appends the OFFSET clause using the provided *startIndex* parameter. |\n| [OFFSET(String)][5] | Appends the OFFSET clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder OFFSET(\n\tint startIndex\n)\n```\n\n#### Parameters\n\n##### *startIndex* [Int32][6]\nThe value to use as parameter.\n\n#### Return Value\n[SqlBuilder][7] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: OFFSET.md\n[3]: _If.md\n[4]: OFFSET_1.md\n[5]: OFFSET_3.md\n[6]: https://learn.microsoft.com/dotnet/api/system.int32\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/OFFSET_3.md",
"content": "SqlBuilder.OFFSET(String) Method\n================================\nAppends the OFFSET clause using the provided *text*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [OFFSET()][2] | Sets OFFSET as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| [OFFSET(SqlBuilder.ClauseStringHandler<OFFSET>)][4] | Appends the OFFSET clause using the provided interpolated string *handler*. |\n| [OFFSET(Int32)][5] | Appends the OFFSET clause using the provided *startIndex* parameter. |\n| **OFFSET(String)** | Appends the OFFSET clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder OFFSET(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][6]\nThe text that represents the body of the OFFSET clause.\n\n#### Return Value\n[SqlBuilder][7] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: OFFSET.md\n[3]: _If.md\n[4]: OFFSET_1.md\n[5]: OFFSET_2.md\n[6]: https://learn.microsoft.com/dotnet/api/system.string\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/ORDER_BY.md",
"content": "SqlBuilder.ORDER_BY Method\n==========================\nSets ORDER BY as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **ORDER_BY()** | Sets ORDER BY as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][1]. |\n| [ORDER_BY(SqlBuilder.ClauseStringHandler<ORDER_BY>)][3] | Appends the ORDER BY clause using the provided interpolated string *handler*. |\n| [ORDER_BY(String)][4] | Appends the ORDER BY clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder ORDER_BY()\n```\n\n#### Return Value\n[SqlBuilder][5] \nA reference to this instance after the operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][5] \n[DbExtensions Namespace][2] \n\n[1]: _If.md\n[2]: ../README.md\n[3]: ORDER_BY_1.md\n[4]: ORDER_BY_2.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/ORDER_BY_1.md",
"content": "SqlBuilder.ORDER_BY(SqlBuilder.ClauseStringHandler<SqlClause.ORDER_BY>) Method\n=================================================================================\nAppends the ORDER BY clause using the provided interpolated string *handler*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [ORDER_BY()][2] | Sets ORDER BY as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| **ORDER_BY(SqlBuilder.ClauseStringHandler<ORDER_BY>)** | Appends the ORDER BY clause using the provided interpolated string *handler*. |\n| [ORDER_BY(String)][4] | Appends the ORDER BY clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder ORDER_BY(\n\tref ClauseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<ORDER_BY>\nThe interpolated string that represents the body of the ORDER BY clause.\n\n#### Return Value\n[SqlBuilder][5] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: ORDER_BY.md\n[3]: _If.md\n[4]: ORDER_BY_2.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/ORDER_BY_2.md",
"content": "SqlBuilder.ORDER_BY(String) Method\n==================================\nAppends the ORDER BY clause using the provided *text*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [ORDER_BY()][2] | Sets ORDER BY as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| [ORDER_BY(SqlBuilder.ClauseStringHandler<ORDER_BY>)][4] | Appends the ORDER BY clause using the provided interpolated string *handler*. |\n| **ORDER_BY(String)** | Appends the ORDER BY clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder ORDER_BY(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][5]\nThe text that represents the body of the ORDER BY clause.\n\n#### Return Value\n[SqlBuilder][6] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: ORDER_BY.md\n[3]: _If.md\n[4]: ORDER_BY_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.string\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/ParameterValues.md",
"content": "SqlBuilder.ParameterValues Property\n===================================\nThe parameter objects to be included in the database command.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic Collection ParameterValues { get; }\n```\n\n#### Property Value\n[Collection][2]<[Object][3]>\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.collections.objectmodel.collection-1\n[3]: https://learn.microsoft.com/dotnet/api/system.object\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/README.md",
"content": "SqlBuilder Class\n================\nRepresents a mutable SQL string.\n\n\nInheritance Hierarchy\n---------------------\n[System.Object][1] \n **DbExtensions.SqlBuilder** \n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic sealed class SqlBuilder\n```\n\nThe **SqlBuilder** type exposes the following members.\n\n\nProperties\n----------\n\n| Name | Description |\n| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |\n| [Buffer][3] | The underlying [StringBuilder][4]. |\n| [CurrentClause][5] | Gets or sets the current SQL clause, used to identify consecutive appends to the same clause. |\n| [IsEmpty][6] | Returns `true` if the buffer is empty. |\n| [NextClause][7] | Gets or sets the next SQL clause. Used by clause continuation methods, such as [_(String)][8] and [_If(Boolean, ConditionalStringHandler)][9]. |\n| [ParameterValues][10] | The parameter objects to be included in the database command. |\n\n\nMethods\n-------\n\n| Name | Description |\n| ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [_(SqlBuilder.ClauseStringHandler<Current>)][11] | Appends the interpolated string *handler* to the current clause. |\n| [_(String)][8] | Appends the *text* to the current clause. |\n| [_Else][12] | Appends *handler* to the current clause if an antecedent call to [_If(Boolean, ConditionalStringHandler)][9] or [_ElseIf(Boolean, ConditionalElseStringHandler)][13] used a `false` condition |\n| [_ElseIf][13] | Appends *handler* to the current clause if *condition* is `true` and an antecedent call to [_If(Boolean, ConditionalStringHandler)][9] or [_ElseIf(Boolean, ConditionalElseStringHandler)][13] used a `false` condition. |\n| [_If][9] | Appends the interpolated string *handler* to the current clause if *condition* is `true`. |\n| [Append(AppendStringHandler)][14] | Appends the interpolated string *handler* to this instance. |\n| [Append(String)][15] | Appends *text* to this instance. |\n| [AppendClause(SqlClause)][16] | Appends the SQL *clause*. |\n| [AppendClause<TClause>()][17] | Appends the SQL clause identified by TClause. |\n| [AppendElse][18] | Appends the interpolated string *handler* if an antecedent call to [AppendIf(Boolean, AppendStringHandler)][19] or [AppendElseIf(Boolean, AppendElseStringHandler)][20] used a `false` condition |\n| [AppendElseIf][20] | Appends the interpolated string *handler* if *condition* is `true` and an antecedent call to [AppendIf(Boolean, AppendStringHandler)][19] or [AppendElseIf(Boolean, AppendElseStringHandler)][20] used a `false` condition. |\n| [AppendIf][19] | Appends the interpolated string *handler* if *condition* is `true`. |\n| [AppendLine][21] | Appends the default line terminator to this instance. |\n| [AppendSql][22] | Appends *sql* to this instance. |\n| [Clone][23] | Creates and returns a copy of this instance. |\n| [CROSS_JOIN()][24] | Sets CROSS JOIN as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][9]. |\n| [CROSS_JOIN(SqlBuilder.ClauseStringHandler<CROSS_JOIN>)][25] | Appends the CROSS JOIN clause using the provided interpolated string *handler*. |\n| [CROSS_JOIN(String)][26] | Appends the CROSS JOIN clause using the provided *text*. |\n| [DELETE_FROM(SqlBuilder.ClauseStringHandler<DELETE_FROM>)][27] | Appends the DELETE FROM clause using the provided interpolated string *handler*. |\n| [DELETE_FROM(String)][28] | Appends the DELETE FROM clause using the provided *text*. |\n| [FROM()][29] | Sets FROM as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][9]. |\n| [FROM(SqlBuilder.ClauseStringHandler<FROM>)][30] | Appends the FROM clause using the provided interpolated string *handler*. |\n| [FROM(String)][31] | Appends the FROM clause using the provided *text*. |\n| [FROM(SqlBuilder, String)][32] | Appends the FROM clause using the provided *subQuery* as body named after *alias*. |\n| [FROM(SqlSet, String)][33] | Appends the FROM clause using the provided *subQuery* as body named after *alias*. |\n| [GROUP_BY()][34] | Sets GROUP BY as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][9]. |\n| [GROUP_BY(SqlBuilder.ClauseStringHandler<GROUP_BY>)][35] | Appends the GROUP BY clause using the provided interpolated string *handler*. |\n| [GROUP_BY(String)][36] | Appends the GROUP BY clause using the provided *text*. |\n| [HAVING()][37] | Sets HAVING as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][9]. |\n| [HAVING(SqlBuilder.ClauseStringHandler<HAVING>)][38] | Appends the HAVING clause using the provided interpolated string *handler*. |\n| [HAVING(String)][39] | Appends the HAVING clause using the provided *text*. |\n| [INNER_JOIN()][40] | Sets INNER JOIN as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][9]. |\n| [INNER_JOIN(SqlBuilder.ClauseStringHandler<INNER_JOIN>)][41] | Appends the INNER JOIN clause using the provided interpolated string *handler*. |\n| [INNER_JOIN(String)][42] | Appends the INNER JOIN clause using the provided *text*. |\n| [INSERT_INTO(SqlBuilder.ClauseStringHandler<INSERT_INTO>)][43] | Appends the INSERT INTO clause using the provided interpolated string *handler*. |\n| [INSERT_INTO(String)][44] | Appends the INSERT INTO clause using the provided *text*. |\n| [InsertText][45] | Inserts a string into this instance at the specified character position. |\n| [JOIN()][46] | Sets JOIN as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][9]. |\n| [JOIN(SqlBuilder.ClauseStringHandler<JOIN>)][47] | Appends the JOIN clause using the provided interpolated string *handler*. |\n| [JOIN(String)][48] | Appends the JOIN clause using the provided *text*. |\n| [JoinSql(String, SqlBuilder[])][49] | Concatenates a specified separator [String][50] between each element of a specified **SqlBuilder** array, yielding a single concatenated **SqlBuilder**. |\n| [JoinSql(String, IEnumerable<SqlBuilder>)][51] | Concatenates the members of a constructed [IEnumerable<T>][52] collection of type **SqlBuilder**, using the specified *separator* between each member. |\n| [LEFT_JOIN()][53] | Sets LEFT JOIN as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][9]. |\n| [LEFT_JOIN(SqlBuilder.ClauseStringHandler<LEFT_JOIN>)][54] | Appends the LEFT JOIN clause using the provided interpolated string *handler*. |\n| [LEFT_JOIN(String)][55] | Appends the LEFT JOIN clause using the provided *text*. |\n| [LIMIT()][56] | Sets LIMIT as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][9]. |\n| [LIMIT(SqlBuilder.ClauseStringHandler<LIMIT>)][57] | Appends the LIMIT clause using the provided interpolated string *handler*. |\n| [LIMIT(Int32)][58] | Appends the LIMIT clause using the provided *maxRecords* parameter. |\n| [LIMIT(String)][59] | Appends the LIMIT clause using the provided *text*. |\n| [OFFSET()][60] | Sets OFFSET as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][9]. |\n| [OFFSET(SqlBuilder.ClauseStringHandler<OFFSET>)][61] | Appends the OFFSET clause using the provided interpolated string *handler*. |\n| [OFFSET(Int32)][62] | Appends the OFFSET clause using the provided *startIndex* parameter. |\n| [OFFSET(String)][63] | Appends the OFFSET clause using the provided *text*. |\n| [ORDER_BY()][64] | Sets ORDER BY as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][9]. |\n| [ORDER_BY(SqlBuilder.ClauseStringHandler<ORDER_BY>)][65] | Appends the ORDER BY clause using the provided interpolated string *handler*. |\n| [ORDER_BY(String)][66] | Appends the ORDER BY clause using the provided *text*. |\n| [RIGHT_JOIN()][67] | Sets RIGHT JOIN as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][9]. |\n| [RIGHT_JOIN(SqlBuilder.ClauseStringHandler<RIGHT_JOIN>)][68] | Appends the RIGHT JOIN clause using the provided interpolated string *handler*. |\n| [RIGHT_JOIN(String)][69] | Appends the RIGHT JOIN clause using the provided *text*. |\n| [SELECT()][70] | Sets SELECT as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][9]. |\n| [SELECT(SqlBuilder.ClauseStringHandler<SELECT>)][71] | Appends the SELECT clause using the provided interpolated string *handler*. |\n| [SELECT(String)][72] | Appends the SELECT clause using the provided *text*. |\n| [SET(SqlBuilder.ClauseStringHandler<SET>)][73] | Appends the SET clause using the provided interpolated string *handler*. |\n| [SET(String)][74] | Appends the SET clause using the provided *text*. |\n| [SetCurrentClause(SqlClause)][75] | Sets *clause* as the current SQL clause. |\n| [SetCurrentClause<TClause>()][76] | Sets the clause identified by TClause as the current SQL clause. |\n| [SetNextClause(SqlClause)][77] | Sets *clause* as the next SQL clause. |\n| [SetNextClause<TClause>()][78] | Sets the clause identified by TClause as the next SQL clause. |\n| [ToString][79] | Converts the value of this instance to a [String][50]. handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<RIGHT_JOIN>\nThe interpolated string that represents the body of the RIGHT JOIN clause.\n\n#### Return Value\n[SqlBuilder][5] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: RIGHT_JOIN.md\n[3]: _If.md\n[4]: RIGHT_JOIN_2.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/RIGHT_JOIN_2.md",
"content": "SqlBuilder.RIGHT_JOIN(String) Method\n====================================\nAppends the RIGHT JOIN clause using the provided *text*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [RIGHT_JOIN()][2] | Sets RIGHT JOIN as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| [RIGHT_JOIN(SqlBuilder.ClauseStringHandler<RIGHT_JOIN>)][4] | Appends the RIGHT JOIN clause using the provided interpolated string *handler*. |\n| **RIGHT_JOIN(String)** | Appends the RIGHT JOIN clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder RIGHT_JOIN(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][5]\nThe text that represents the body of the RIGHT JOIN clause.\n\n#### Return Value\n[SqlBuilder][6] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: RIGHT_JOIN.md\n[3]: _If.md\n[4]: RIGHT_JOIN_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.string\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/SELECT.md",
"content": "SqlBuilder.SELECT Method\n========================\nSets SELECT as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **SELECT()** | Sets SELECT as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][1]. |\n| [SELECT(SqlBuilder.ClauseStringHandler<SELECT>)][3] | Appends the SELECT clause using the provided interpolated string *handler*. |\n| [SELECT(String)][4] | Appends the SELECT clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder SELECT()\n```\n\n#### Return Value\n[SqlBuilder][5] \nA reference to this instance after the operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][5] \n[DbExtensions Namespace][2] \n\n[1]: _If.md\n[2]: ../README.md\n[3]: SELECT_1.md\n[4]: SELECT_2.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/SELECT_1.md",
"content": "SqlBuilder.SELECT(SqlBuilder.ClauseStringHandler<SqlClause.SELECT>) Method\n=============================================================================\nAppends the SELECT clause using the provided interpolated string *handler*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [SELECT()][2] | Sets SELECT as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| **SELECT(SqlBuilder.ClauseStringHandler<SELECT>)** | Appends the SELECT clause using the provided interpolated string *handler*. |\n| [SELECT(String)][4] | Appends the SELECT clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder SELECT(\n\tref ClauseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<SELECT>\nThe interpolated string that represents the body of the SELECT clause.\n\n#### Return Value\n[SqlBuilder][5] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: SELECT.md\n[3]: _If.md\n[4]: SELECT_2.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/SELECT_2.md",
"content": "SqlBuilder.SELECT(String) Method\n================================\nAppends the SELECT clause using the provided *text*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [SELECT()][2] | Sets SELECT as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| [SELECT(SqlBuilder.ClauseStringHandler<SELECT>)][4] | Appends the SELECT clause using the provided interpolated string *handler*. |\n| **SELECT(String)** | Appends the SELECT clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder SELECT(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][5]\nThe text that represents the body of the SELECT clause.\n\n#### Return Value\n[SqlBuilder][6] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: SELECT.md\n[3]: _If.md\n[4]: SELECT_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.string\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/SET.md",
"content": "SqlBuilder.SET(SqlBuilder.ClauseStringHandler<SqlClause.SET>) Method\n=======================================================================\nAppends the SET clause using the provided interpolated string *handler*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------------- | ------------------------------------------------------------------------ |\n| **SET(SqlBuilder.ClauseStringHandler<SET>)** | Appends the SET clause using the provided interpolated string *handler*. |\n| [SET(String)][2] | Appends the SET clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder SET(\n\tref ClauseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<SET>\nThe interpolated string that represents the body of the SET clause.\n\n#### Return Value\n[SqlBuilder][3] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: SET_1.md\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/SET_1.md",
"content": "SqlBuilder.SET(String) Method\n=============================\nAppends the SET clause using the provided *text*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------ | ------------------------------------------------------------------------ |\n| [SET(SqlBuilder.ClauseStringHandler<SET>)][2] | Appends the SET clause using the provided interpolated string *handler*. |\n| **SET(String)** | Appends the SET clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder SET(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][3]\nThe text that represents the body of the SET clause.\n\n#### Return Value\n[SqlBuilder][4] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: SET.md\n[3]: https://learn.microsoft.com/dotnet/api/system.string\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/SetCurrentClause.md",
"content": "SqlBuilder.SetCurrentClause(SqlClause) Method\n=============================================\nSets *clause* as the current SQL clause.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------- | ---------------------------------------------------------------- |\n| **SetCurrentClause(SqlClause)** | Sets *clause* as the current SQL clause. |\n| [SetCurrentClause<TClause>()][2] | Sets the clause identified by TClause as the current SQL clause. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder SetCurrentClause(\n\tSqlClause? clause\n)\n```\n\n#### Parameters\n\n##### *clause* [SqlClause][3]\nThe SQL clause.\n\n#### Return Value\n[SqlBuilder][4] \nA reference to this instance after the operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][4] \n[DbExtensions Namespace][1] \n[CurrentClause][5] \n\n[1]: ../README.md\n[2]: SetCurrentClause__1.md\n[3]: ../SqlClause/README.md\n[4]: README.md\n[5]: CurrentClause.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/SetCurrentClause__1.md",
"content": "SqlBuilder.SetCurrentClause<TClause> Method\n==============================================\nSets the clause identified by TClause as the current SQL clause.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------- | ---------------------------------------------------------------- |\n| [SetCurrentClause(SqlClause)][2] | Sets *clause* as the current SQL clause. |\n| **SetCurrentClause<TClause>()** | Sets the clause identified by TClause as the current SQL clause. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder SetCurrentClause()\nwhere TClause : new(), SqlClause\n\n```\n\n#### Type Parameters\n\n##### *TClause*\nThe type of the SQL clause.\n\n#### Return Value\n[SqlBuilder][3] \nA reference to this instance after the operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][3] \n[DbExtensions Namespace][1] \n[CurrentClause][4] \n\n[1]: ../README.md\n[2]: SetCurrentClause.md\n[3]: README.md\n[4]: CurrentClause.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/SetNextClause.md",
"content": "SqlBuilder.SetNextClause(SqlClause) Method\n==========================================\nSets *clause* as the next SQL clause.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------- | ------------------------------------------------------------- |\n| **SetNextClause(SqlClause)** | Sets *clause* as the next SQL clause. |\n| [SetNextClause<TClause>()][2] | Sets the clause identified by TClause as the next SQL clause. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder SetNextClause(\n\tSqlClause? clause\n)\n```\n\n#### Parameters\n\n##### *clause* [SqlClause][3]\nThe SQL clause.\n\n#### Return Value\n[SqlBuilder][4] \nA reference to this instance after the operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][4] \n[DbExtensions Namespace][1] \n[NextClause][5] \n\n[1]: ../README.md\n[2]: SetNextClause__1.md\n[3]: ../SqlClause/README.md\n[4]: README.md\n[5]: NextClause.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/SetNextClause__1.md",
"content": "SqlBuilder.SetNextClause<TClause> Method\n===========================================\nSets the clause identified by TClause as the next SQL clause.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------- | ------------------------------------------------------------- |\n| [SetNextClause(SqlClause)][2] | Sets *clause* as the next SQL clause. |\n| **SetNextClause<TClause>()** | Sets the clause identified by TClause as the next SQL clause. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder SetNextClause()\nwhere TClause : new(), SqlClause\n\n```\n\n#### Type Parameters\n\n##### *TClause*\nThe type of the SQL clause.\n\n#### Return Value\n[SqlBuilder][3] \nA reference to this instance after the operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][3] \n[DbExtensions Namespace][1] \n[NextClause][4] \n\n[1]: ../README.md\n[2]: SetNextClause.md\n[3]: README.md\n[4]: NextClause.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/ToString.md",
"content": "SqlBuilder.ToString Method\n==========================\nConverts the value of this instance to a [String][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic override string ToString()\n```\n\n#### Return Value\n[String][1] \nA string whose value is the same as this instance.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][3] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.string\n[2]: ../README.md\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/UNION.md",
"content": "SqlBuilder.UNION Method\n=======================\nAppends the UNION clause.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder UNION()\n```\n\n#### Return Value\n[SqlBuilder][2] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][2] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/UPDATE.md",
"content": "SqlBuilder.UPDATE(SqlBuilder.ClauseStringHandler<SqlClause.UPDATE>) Method\n=============================================================================\nAppends the UPDATE clause using the provided interpolated string *handler*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------------------- | --------------------------------------------------------------------------- |\n| **UPDATE(SqlBuilder.ClauseStringHandler<UPDATE>)** | Appends the UPDATE clause using the provided interpolated string *handler*. |\n| [UPDATE(String)][2] | Appends the UPDATE clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder UPDATE(\n\tref ClauseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<UPDATE>\nThe interpolated string that represents the body of the UPDATE clause.\n\n#### Return Value\n[SqlBuilder][3] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: UPDATE_1.md\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/UPDATE_1.md",
"content": "SqlBuilder.UPDATE(String) Method\n================================\nAppends the UPDATE clause using the provided *text*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------ | --------------------------------------------------------------------------- |\n| [UPDATE(SqlBuilder.ClauseStringHandler<UPDATE>)][2] | Appends the UPDATE clause using the provided interpolated string *handler*. |\n| **UPDATE(String)** | Appends the UPDATE clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder UPDATE(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][3]\nThe text that represents the body of the UPDATE clause.\n\n#### Return Value\n[SqlBuilder][4] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: UPDATE.md\n[3]: https://learn.microsoft.com/dotnet/api/system.string\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/VALUES.md",
"content": "SqlBuilder.VALUES(SqlBuilder.ClauseStringHandler<SqlClause.VALUES>) Method\n=============================================================================\nAppends the VALUES clause using the provided interpolated string *handler*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------------------- | --------------------------------------------------------------------------- |\n| **VALUES(SqlBuilder.ClauseStringHandler<VALUES>)** | Appends the VALUES clause using the provided interpolated string *handler*. |\n| [VALUES(Object[])][2] | Appends the VALUES clause using the provided parameters. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder VALUES(\n\tref ClauseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<VALUES>\nThe interpolated string that represents the body of the VALUES clause.\n\n#### Return Value\n[SqlBuilder][3] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: VALUES_1.md\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/VALUES_1.md",
"content": "SqlBuilder.VALUES(Object[]) Method\n==================================\nAppends the VALUES clause using the provided parameters.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------ | --------------------------------------------------------------------------- |\n| [VALUES(SqlBuilder.ClauseStringHandler<VALUES>)][2] | Appends the VALUES clause using the provided interpolated string *handler*. |\n| **VALUES(Object[])** | Appends the VALUES clause using the provided parameters. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder VALUES(\n\tparams Object?[] args\n)\n```\n\n#### Parameters\n\n##### *args* [Object][3][]\nThe parameters of the clause body.\n\n#### Return Value\n[SqlBuilder][4] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: VALUES.md\n[3]: https://learn.microsoft.com/dotnet/api/system.object\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/WHERE.md",
"content": "SqlBuilder.WHERE Method\n=======================\nSets WHERE as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **WHERE()** | Sets WHERE as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][1]. |\n| [WHERE(SqlBuilder.ClauseStringHandler<WHERE>)][3] | Appends the WHERE clause using the provided interpolated string *handler*. |\n| [WHERE(String)][4] | Appends the WHERE clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder WHERE()\n```\n\n#### Return Value\n[SqlBuilder][5] \nA reference to this instance after the operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][5] \n[DbExtensions Namespace][2] \n\n[1]: _If.md\n[2]: ../README.md\n[3]: WHERE_1.md\n[4]: WHERE_2.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/WHERE_1.md",
"content": "SqlBuilder.WHERE(SqlBuilder.ClauseStringHandler<SqlClause.WHERE>) Method\n===========================================================================\nAppends the WHERE clause using the provided interpolated string *handler*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [WHERE()][2] | Sets WHERE as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| **WHERE(SqlBuilder.ClauseStringHandler<WHERE>)** | Appends the WHERE clause using the provided interpolated string *handler*. |\n| [WHERE(String)][4] | Appends the WHERE clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder WHERE(\n\tref ClauseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<WHERE>\nThe interpolated string that represents the body of the WHERE clause.\n\n#### Return Value\n[SqlBuilder][5] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: WHERE.md\n[3]: _If.md\n[4]: WHERE_2.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/WHERE_2.md",
"content": "SqlBuilder.WHERE(String) Method\n===============================\nAppends the WHERE clause using the provided *text*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [WHERE()][2] | Sets WHERE as the next clause, to be used by subsequent calls to clause continuation methods, such as [_If(Boolean, ConditionalStringHandler)][3]. |\n| [WHERE(SqlBuilder.ClauseStringHandler<WHERE>)][4] | Appends the WHERE clause using the provided interpolated string *handler*. |\n| **WHERE(String)** | Appends the WHERE clause using the provided *text*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder WHERE(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][5]\nThe text that represents the body of the WHERE clause.\n\n#### Return Value\n[SqlBuilder][6] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: WHERE.md\n[3]: _If.md\n[4]: WHERE_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.string\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/WITH.md",
"content": "SqlBuilder.WITH(SqlBuilder.ClauseStringHandler<SqlClause.WITH>) Method\n=========================================================================\nAppends the WITH clause using the provided interpolated string *handler*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------- | ---------------------------------------------------------------------------------- |\n| **WITH(SqlBuilder.ClauseStringHandler<WITH>)** | Appends the WITH clause using the provided interpolated string *handler*. |\n| [WITH(String)][2] | Appends the WITH clause using the provided *text*. |\n| [WITH(String, SqlBuilder)][3] | Appends the WITH clause using the provided *subQuery* as body named after *alias*. |\n| [WITH(String, SqlSet)][4] | Appends the WITH clause using the provided *subQuery* as body named after *alias*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder WITH(\n\tref ClauseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<WITH>\nThe interpolated string that represents the body of the WITH clause.\n\n#### Return Value\n[SqlBuilder][5] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: WITH_1.md\n[3]: WITH_2.md\n[4]: WITH_3.md\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/WITH_1.md",
"content": "SqlBuilder.WITH(String) Method\n==============================\nAppends the WITH clause using the provided *text*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------- | ---------------------------------------------------------------------------------- |\n| [WITH(SqlBuilder.ClauseStringHandler<WITH>)][2] | Appends the WITH clause using the provided interpolated string *handler*. |\n| **WITH(String)** | Appends the WITH clause using the provided *text*. |\n| [WITH(String, SqlBuilder)][3] | Appends the WITH clause using the provided *subQuery* as body named after *alias*. |\n| [WITH(String, SqlSet)][4] | Appends the WITH clause using the provided *subQuery* as body named after *alias*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder WITH(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][5]\nThe text that represents the body of the WITH clause.\n\n#### Return Value\n[SqlBuilder][6] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: WITH.md\n[3]: WITH_2.md\n[4]: WITH_3.md\n[5]: https://learn.microsoft.com/dotnet/api/system.string\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/WITH_2.md",
"content": "SqlBuilder.WITH(String, SqlBuilder) Method\n==========================================\nAppends the WITH clause using the provided *subQuery* as body named after *alias*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------- | ---------------------------------------------------------------------------------- |\n| [WITH(SqlBuilder.ClauseStringHandler<WITH>)][2] | Appends the WITH clause using the provided interpolated string *handler*. |\n| [WITH(String)][3] | Appends the WITH clause using the provided *text*. |\n| **WITH(String, SqlBuilder)** | Appends the WITH clause using the provided *subQuery* as body named after *alias*. |\n| [WITH(String, SqlSet)][4] | Appends the WITH clause using the provided *subQuery* as body named after *alias*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder WITH(\n\tstring alias,\n\tSqlBuilder subQuery\n)\n```\n\n#### Parameters\n\n##### *alias* [String][5]\nThe alias of the sub-query.\n\n##### *subQuery* [SqlBuilder][6]\nThe sub-query to use as the body of the WITH clause.\n\n#### Return Value\n[SqlBuilder][6] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: WITH.md\n[3]: WITH_1.md\n[4]: WITH_3.md\n[5]: https://learn.microsoft.com/dotnet/api/system.string\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/WITH_3.md",
"content": "SqlBuilder.WITH(String, SqlSet) Method\n======================================\nAppends the WITH clause using the provided *subQuery* as body named after *alias*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------- | ---------------------------------------------------------------------------------- |\n| [WITH(SqlBuilder.ClauseStringHandler<WITH>)][2] | Appends the WITH clause using the provided interpolated string *handler*. |\n| [WITH(String)][3] | Appends the WITH clause using the provided *text*. |\n| [WITH(String, SqlBuilder)][4] | Appends the WITH clause using the provided *subQuery* as body named after *alias*. |\n| **WITH(String, SqlSet)** | Appends the WITH clause using the provided *subQuery* as body named after *alias*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder WITH(\n\tstring alias,\n\tSqlSet subQuery\n)\n```\n\n#### Parameters\n\n##### *alias* [String][5]\nThe alias of the sub-query.\n\n##### *subQuery* [SqlSet][6]\nThe sub-query to use as the body of the WITH clause.\n\n#### Return Value\n[SqlBuilder][7] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: WITH.md\n[3]: WITH_1.md\n[4]: WITH_2.md\n[5]: https://learn.microsoft.com/dotnet/api/system.string\n[6]: ../SqlSet/README.md\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/_.md",
"content": "SqlBuilder._(SqlBuilder.ClauseStringHandler<SqlClause.Current>) Method\n=========================================================================\nAppends the interpolated string *handler* to the current clause.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------- | ---------------------------------------------------------------- |\n| **_(SqlBuilder.ClauseStringHandler<Current>)** | Appends the interpolated string *handler* to the current clause. |\n| [_(String)][2] | Appends the *text* to the current clause. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder _(\n\tref ClauseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ClauseStringHandler<Current>\nThe interpolated string that represents the body of the current clause.\n\n#### Return Value\n[SqlBuilder][3] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: __1.md\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/_Else.md",
"content": "SqlBuilder._Else Method\n=======================\nAppends *handler* to the current clause if an antecedent call to [_If(Boolean, ConditionalStringHandler)][1] or [_ElseIf(Boolean, ConditionalElseStringHandler)][2] used a `false` condition\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder _Else(\n\tref ConditionalElseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *handler* ConditionalElseStringHandler\nThe interpolated string that represents the body of the current clause.\n\n#### Return Value\n[SqlBuilder][4] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][4] \n[DbExtensions Namespace][3] \n\n[1]: _If.md\n[2]: _ElseIf.md\n[3]: ../README.md\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/_ElseIf.md",
"content": "SqlBuilder._ElseIf Method\n=========================\nAppends *handler* to the current clause if *condition* is `true` and an antecedent call to [_If(Boolean, ConditionalStringHandler)][1] or **_ElseIf(Boolean, ConditionalElseStringHandler)** used a `false` condition.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder _ElseIf(\n\tbool condition,\n\tref ConditionalElseStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *condition* [Boolean][3]\n`true` to append *handler* to the current clause; otherwise, `false`.\n\n##### *handler* ConditionalElseStringHandler\nThe interpolated string that represents the body of the current clause.\n\n#### Return Value\n[SqlBuilder][4] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][4] \n[DbExtensions Namespace][2] \n\n[1]: _If.md\n[2]: ../README.md\n[3]: https://learn.microsoft.com/dotnet/api/system.boolean\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/_If.md",
"content": "SqlBuilder._If Method\n=====================\nAppends the interpolated string *handler* to the current clause if *condition* is `true`.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder _If(\n\tbool condition,\n\tref ConditionalStringHandler handler\n)\n```\n\n#### Parameters\n\n##### *condition* [Boolean][2]\n`true` to append *handler* to the current clause; otherwise, `false`.\n\n##### *handler* ConditionalStringHandler\nThe interpolated string that represents the body of the current clause.\n\n#### Return Value\n[SqlBuilder][3] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.boolean\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlBuilder/__1.md",
"content": "SqlBuilder._(String) Method\n===========================\nAppends the *text* to the current clause.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------- | ---------------------------------------------------------------- |\n| [_(SqlBuilder.ClauseStringHandler<Current>)][2] | Appends the interpolated string *handler* to the current clause. |\n| **_(String)** | Appends the *text* to the current clause. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder _(\n\tstring? text\n)\n```\n\n#### Parameters\n\n##### *text* [String][3]\nThe text that represents the body of the current clause.\n\n#### Return Value\n[SqlBuilder][4] \nA reference to this instance after the append operation has completed.\n\nSee Also\n--------\n\n#### Reference\n[SqlBuilder Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: _.md\n[3]: https://learn.microsoft.com/dotnet/api/system.string\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlClause/Instance__1.md",
"content": "SqlClause.Instance<TClause> Method\n=====================================\nGets a singleton instance of the clause identified by TClause.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic static TClause Instance()\nwhere TClause : new(), SqlClause\n\n```\n\n#### Type Parameters\n\n##### *TClause*\nThe type of the clause.\n\n#### Return Value\n**TClause** \nAn instance of TClause.\n\nSee Also\n--------\n\n#### Reference\n[SqlClause Class][2] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlClause/Name.md",
"content": "SqlClause.Name Property\n=======================\nThe name of the clause.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic string? Name { get; init; }\n```\n\n#### Property Value\n[String][2]\n\nSee Also\n--------\n\n#### Reference\n[SqlClause Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.string\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlClause/README.md",
"content": "SqlClause Class\n===============\nProvides information about a SQL clause. Used by [SqlBuilder][1].\n\n\nInheritance Hierarchy\n---------------------\n[System.Object][2] \n **DbExtensions.SqlClause** \n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic abstract class SqlClause : IEquatable\n```\n\nThe **SqlClause** type exposes the following members.\n\n\nConstructors\n------------\n\n| Name | Description |\n| -------------- | ----------------------------------------------------------------- |\n| [SqlClause][4] | Provides information about a SQL clause. Used by [SqlBuilder][1]. |\n\n\nProperties\n----------\n\n| Name | Description |\n| -------------- | ---------------------------------------- |\n| [Name][5] | The name of the clause. |\n| [Separator][6] | The string to use for consecutive calls. |\n\n\nMethods\n-------\n\n| Name | Description |\n| ------------------------- | -------------------------------------------------------------- |\n| [Instance<TClause>][7] | Gets a singleton instance of the clause identified by TClause. |\n\n\nSee Also\n--------\n\n#### Reference\n[DbExtensions Namespace][3] \n\n[1]: ../SqlBuilder/README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: ../README.md\n[4]: _ctor.md\n[5]: Name.md\n[6]: Separator.md\n[7]: Instance__1.md"
},
{
"path": "docs/api/DbExtensions/SqlClause/Separator.md",
"content": "SqlClause.Separator Property\n============================\nThe string to use for consecutive calls.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic string? Separator { get; init; }\n```\n\n#### Property Value\n[String][2]\n\nSee Also\n--------\n\n#### Reference\n[SqlClause Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.string\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlClause/_ctor.md",
"content": "SqlClause Constructor\n=====================\nProvides information about a SQL clause. Used by [SqlBuilder][1].\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\nprotected SqlClause(\n\tstring? Name,\n\tstring? Separator\n)\n```\n\n#### Parameters\n\n##### *Name* [String][3]\nThe name of the clause.\n\n##### *Separator* [String][3]\nThe string to use for consecutive calls.\n\n\nSee Also\n--------\n\n#### Reference\n[SqlClause Class][4] \n[DbExtensions Namespace][2] \n\n[1]: ../SqlBuilder/README.md\n[2]: ../README.md\n[3]: https://learn.microsoft.com/dotnet/api/system.string\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/All.md",
"content": "SqlSet.All(SqlSet.OperatorStringHandler) Method\n===============================================\nDetermines whether all elements of the set satisfy a condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------ | --------------------------------------------------------------- |\n| **All(OperatorStringHandler)** | Determines whether all elements of the set satisfy a condition. |\n| [All(String)][2] | Determines whether all elements of the set satisfy a condition. |\n\n\nSyntax\n------\n\n```csharp\npublic bool All(\n\tref OperatorStringHandler predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[Boolean][3] \n`true` if every element of the set passes the test in the specified *predicate*, or if the set is empty; otherwise, `false`.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: All_1.md\n[3]: https://learn.microsoft.com/dotnet/api/system.boolean\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/AllAsync.md",
"content": "SqlSet.AllAsync(SqlSet.OperatorStringHandler, CancellationToken) Method\n=======================================================================\nDetermines whether all elements of the set satisfy a condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------ | --------------------------------------------------------------- |\n| **AllAsync(OperatorStringHandler, CancellationToken)** | Determines whether all elements of the set satisfy a condition. |\n| [AllAsync(String, CancellationToken)][2] | Determines whether all elements of the set satisfy a condition. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask AllAsync(\n\tOperatorStringHandler predicate,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n##### *cancellationToken* [CancellationToken][3] (Optional)\nThe [CancellationToken][3] to monitor for cancellation requests. The default is [None][4].\n\n#### Return Value\n[ValueTask][5]<[Boolean][6]> \n`true` if every element of the set passes the test in the specified *predicate*, or if the set is empty; otherwise, `false`.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: AllAsync_1.md\n[3]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[6]: https://learn.microsoft.com/dotnet/api/system.boolean\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/AllAsync_1.md",
"content": "SqlSet.AllAsync(String, CancellationToken) Method\n=================================================\nDetermines whether all elements of the set satisfy a condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------- | --------------------------------------------------------------- |\n| [AllAsync(OperatorStringHandler, CancellationToken)][2] | Determines whether all elements of the set satisfy a condition. |\n| **AllAsync(String, CancellationToken)** | Determines whether all elements of the set satisfy a condition. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask AllAsync(\n\tstring predicate,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][3]\nA SQL expression to test each row for a condition.\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]<[Boolean][7]> \n`true` if every element of the set passes the test in the specified *predicate*, or if the set is empty; otherwise, `false`.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][8] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: AllAsync.md\n[3]: https://learn.microsoft.com/dotnet/api/system.string\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[7]: https://learn.microsoft.com/dotnet/api/system.boolean\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/All_1.md",
"content": "SqlSet.All(String) Method\n=========================\nDetermines whether all elements of the set satisfy a condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------- | --------------------------------------------------------------- |\n| [All(OperatorStringHandler)][2] | Determines whether all elements of the set satisfy a condition. |\n| **All(String)** | Determines whether all elements of the set satisfy a condition. |\n\n\nSyntax\n------\n\n```csharp\npublic bool All(\n\tstring predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][3]\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[Boolean][4] \n`true` if every element of the set passes the test in the specified *predicate*, or if the set is empty; otherwise, `false`.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: All.md\n[3]: https://learn.microsoft.com/dotnet/api/system.string\n[4]: https://learn.microsoft.com/dotnet/api/system.boolean\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/Any.md",
"content": "SqlSet.Any Method\n=================\nDetermines whether the set contains any elements.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------- | ---------------------------------------------------------------- |\n| **Any()** | Determines whether the set contains any elements. |\n| [Any(OperatorStringHandler)][2] | Determines whether any element of the set satisfies a condition. |\n| [Any(String)][3] | Determines whether any element of the set satisfies a condition. |\n\n\nSyntax\n------\n\n```csharp\npublic bool Any()\n```\n\n#### Return Value\n[Boolean][4] \n`true` if the sequence contains any elements; otherwise, `false`.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Any_1.md\n[3]: Any_2.md\n[4]: https://learn.microsoft.com/dotnet/api/system.boolean\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/AnyAsync.md",
"content": "SqlSet.AnyAsync(SqlSet.OperatorStringHandler, CancellationToken) Method\n=======================================================================\nDetermines whether any element of the set satisfies a condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------ | ---------------------------------------------------------------- |\n| [AnyAsync(CancellationToken)][2] | Determines whether the set contains any elements. |\n| **AnyAsync(OperatorStringHandler, CancellationToken)** | Determines whether any element of the set satisfies a condition. |\n| [AnyAsync(String, CancellationToken)][3] | Determines whether any element of the set satisfies a condition. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask AnyAsync(\n\tOperatorStringHandler predicate,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]<[Boolean][7]> \n`true` if any elements in the set pass the test in the specified *predicate*; otherwise, `false`.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][8] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: AnyAsync_2.md\n[3]: AnyAsync_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[7]: https://learn.microsoft.com/dotnet/api/system.boolean\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/AnyAsync_1.md",
"content": "SqlSet.AnyAsync(String, CancellationToken) Method\n=================================================\nDetermines whether any element of the set satisfies a condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------- | ---------------------------------------------------------------- |\n| [AnyAsync(CancellationToken)][2] | Determines whether the set contains any elements. |\n| [AnyAsync(OperatorStringHandler, CancellationToken)][3] | Determines whether any element of the set satisfies a condition. |\n| **AnyAsync(String, CancellationToken)** | Determines whether any element of the set satisfies a condition. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask AnyAsync(\n\tstring predicate,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][4]\nA SQL expression to test each row for a condition.\n\n##### *cancellationToken* [CancellationToken][5] (Optional)\nThe [CancellationToken][5] to monitor for cancellation requests. The default is [None][6].\n\n#### Return Value\n[ValueTask][7]<[Boolean][8]> \n`true` if any elements in the set pass the test in the specified *predicate*; otherwise, `false`.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][9] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: AnyAsync_2.md\n[3]: AnyAsync.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[7]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[8]: https://learn.microsoft.com/dotnet/api/system.boolean\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/AnyAsync_2.md",
"content": "SqlSet.AnyAsync(CancellationToken) Method\n=========================================\nDetermines whether the set contains any elements.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------- | ---------------------------------------------------------------- |\n| **AnyAsync(CancellationToken)** | Determines whether the set contains any elements. |\n| [AnyAsync(OperatorStringHandler, CancellationToken)][2] | Determines whether any element of the set satisfies a condition. |\n| [AnyAsync(String, CancellationToken)][3] | Determines whether any element of the set satisfies a condition. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask AnyAsync(\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]<[Boolean][7]> \n`true` if the sequence contains any elements; otherwise, `false`.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][8] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: AnyAsync.md\n[3]: AnyAsync_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[7]: https://learn.microsoft.com/dotnet/api/system.boolean\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/Any_1.md",
"content": "SqlSet.Any(SqlSet.OperatorStringHandler) Method\n===============================================\nDetermines whether any element of the set satisfies a condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------ | ---------------------------------------------------------------- |\n| [Any()][2] | Determines whether the set contains any elements. |\n| **Any(OperatorStringHandler)** | Determines whether any element of the set satisfies a condition. |\n| [Any(String)][3] | Determines whether any element of the set satisfies a condition. |\n\n\nSyntax\n------\n\n```csharp\npublic bool Any(\n\tref OperatorStringHandler predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[Boolean][4] \n`true` if any elements in the set pass the test in the specified *predicate*; otherwise, `false`.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Any.md\n[3]: Any_2.md\n[4]: https://learn.microsoft.com/dotnet/api/system.boolean\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/Any_2.md",
"content": "SqlSet.Any(String) Method\n=========================\nDetermines whether any element of the set satisfies a condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------- | ---------------------------------------------------------------- |\n| [Any()][2] | Determines whether the set contains any elements. |\n| [Any(OperatorStringHandler)][3] | Determines whether any element of the set satisfies a condition. |\n| **Any(String)** | Determines whether any element of the set satisfies a condition. |\n\n\nSyntax\n------\n\n```csharp\npublic bool Any(\n\tstring predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][4]\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[Boolean][5] \n`true` if any elements in the set pass the test in the specified *predicate*; otherwise, `false`.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Any.md\n[3]: Any_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://learn.microsoft.com/dotnet/api/system.boolean\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/AsAsyncEnumerable.md",
"content": "SqlSet.AsAsyncEnumerable Method\n===============================\nGets all elements in the set. The query is deferred-executed.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic IAsyncEnumerable AsAsyncEnumerable()\n```\n\n#### Return Value\n[IAsyncEnumerable][2]<[Object][3]> \nAll elements in the set.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.collections.generic.iasyncenumerable-1\n[3]: https://learn.microsoft.com/dotnet/api/system.object\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/AsEnumerable.md",
"content": "SqlSet.AsEnumerable Method\n==========================\nGets all elements in the set. The query is deferred-executed.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic IEnumerable AsEnumerable()\n```\n\n#### Return Value\n[IEnumerable][2]<[Object][3]> \nAll elements in the set.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1\n[3]: https://learn.microsoft.com/dotnet/api/system.object\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/Cast.md",
"content": "SqlSet.Cast(Type) Method\n========================\nCasts the elements of the set to the specified type.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------- | ---------------------------------------------------- |\n| **Cast(Type)** | Casts the elements of the set to the specified type. |\n| [Cast<TResult>()][2] | Casts the elements of the set to the specified type. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlSet Cast(\n\tType resultType\n)\n```\n\n#### Parameters\n\n##### *resultType* [Type][3]\nThe type to cast the elements of the set to.\n\n#### Return Value\n[SqlSet][4] \nA new [SqlSet][4] that contains each element of the current set cast to the specified type.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Cast__1.md\n[3]: https://learn.microsoft.com/dotnet/api/system.type\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/Cast__1.md",
"content": "SqlSet.Cast<TResult> Method\n==============================\nCasts the elements of the set to the specified type.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------- | ---------------------------------------------------- |\n| [Cast(Type)][2] | Casts the elements of the set to the specified type. |\n| **Cast<TResult>()** | Casts the elements of the set to the specified type. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlSet Cast()\n\n```\n\n#### Type Parameters\n\n##### *TResult*\nThe type to cast the elements of the set to.\n\n#### Return Value\n[SqlSet][3]<**TResult**> \nA new [SqlSet<TResult>][3] that contains each element of the current set cast to the specified type.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Cast.md\n[3]: ../SqlSet_1/README.md\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/Contains.md",
"content": "SqlSet.Contains Method\n======================\nChecks the existance of the *entity*, using the primary key value.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic bool Contains(\n\tObject entity\n)\n```\n\n#### Parameters\n\n##### *entity* [Object][2]\nThe entity whose existance is to be checked.\n\n#### Return Value\n[Boolean][3] \n`true` if the primary key value exists in the database; otherwise, `false`.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | --------------------------------------------------------------------------------- |\n| [InvalidOperationException][4] | This method can only be used on sets where the result type is an annotated class. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: https://learn.microsoft.com/dotnet/api/system.boolean\n[4]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/ContainsAsync.md",
"content": "SqlSet.ContainsAsync Method\n===========================\nChecks the existance of the *entity*, using the primary key value.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic ValueTask ContainsAsync(\n\tObject entity,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *entity* [Object][2]\nThe entity whose existance is to be checked.\n\n##### *cancellationToken* [CancellationToken][3] (Optional)\nThe [CancellationToken][3] to monitor for cancellation requests. The default is [None][4].\n\n#### Return Value\n[ValueTask][5]<[Boolean][6]> \n`true` if the primary key value exists in the database; otherwise, `false`.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | --------------------------------------------------------------------------------- |\n| [InvalidOperationException][7] | This method can only be used on sets where the result type is an annotated class. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][8] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[6]: https://learn.microsoft.com/dotnet/api/system.boolean\n[7]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/ContainsKey.md",
"content": "SqlSet.ContainsKey Method\n=========================\nChecks the existance of an entity whose primary matches the *id* parameter.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic bool ContainsKey(\n\tObject id\n)\n```\n\n#### Parameters\n\n##### *id* [Object][2]\nThe primary key value.\n\n#### Return Value\n[Boolean][3] \n`true` if the primary key value exists in the database; otherwise, `false`.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | --------------------------------------------------------------------------------- |\n| [InvalidOperationException][4] | This method can only be used on sets where the result type is an annotated class. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: https://learn.microsoft.com/dotnet/api/system.boolean\n[4]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/ContainsKeyAsync.md",
"content": "SqlSet.ContainsKeyAsync Method\n==============================\nChecks the existance of an entity whose primary matches the *id* parameter.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic ValueTask ContainsKeyAsync(\n\tObject id,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *id* [Object][2]\nThe primary key value.\n\n##### *cancellationToken* [CancellationToken][3] (Optional)\nThe [CancellationToken][3] to monitor for cancellation requests. The default is [None][4].\n\n#### Return Value\n[ValueTask][5]<[Boolean][6]> \n`true` if the primary key value exists in the database; otherwise, `false`.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | --------------------------------------------------------------------------------- |\n| [InvalidOperationException][7] | This method can only be used on sets where the result type is an annotated class. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][8] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[6]: https://learn.microsoft.com/dotnet/api/system.boolean\n[7]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/Count.md",
"content": "SqlSet.Count Method\n===================\nReturns the number of elements in the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------- | ---------------------------------------------------------------------------------- |\n| **Count()** | Returns the number of elements in the set. |\n| [Count(OperatorStringHandler)][2] | Returns a number that represents how many elements in the set satisfy a condition. |\n| [Count(String)][3] | Returns a number that represents how many elements in the set satisfy a condition. |\n\n\nSyntax\n------\n\n```csharp\npublic int Count()\n```\n\n#### Return Value\n[Int32][4] \nThe number of elements in the set.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ---------------------- | ---------------------------------------------------- |\n| [OverflowException][5] | The number of elements is larger than [MaxValue][6]. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Count_1.md\n[3]: Count_2.md\n[4]: https://learn.microsoft.com/dotnet/api/system.int32\n[5]: https://learn.microsoft.com/dotnet/api/system.overflowexception\n[6]: https://learn.microsoft.com/dotnet/api/system.int32.maxvalue\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/CountAsync.md",
"content": "SqlSet.CountAsync(SqlSet.OperatorStringHandler, CancellationToken) Method\n=========================================================================\nReturns a number that represents how many elements in the set satisfy a condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------------- | ---------------------------------------------------------------------------------- |\n| [CountAsync(CancellationToken)][2] | Returns the number of elements in the set. |\n| **CountAsync(OperatorStringHandler, CancellationToken)** | Returns a number that represents how many elements in the set satisfy a condition. |\n| [CountAsync(String, CancellationToken)][3] | Returns a number that represents how many elements in the set satisfy a condition. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask CountAsync(\n\tOperatorStringHandler predicate,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]<[Int32][7]> \nA number that represents how many elements in the set satisfy the condition in the *predicate*.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ---------------------- | ------------------------------------------------------ |\n| [OverflowException][8] | The number of matching elements exceeds [MaxValue][9]. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][10] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: CountAsync_2.md\n[3]: CountAsync_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[7]: https://learn.microsoft.com/dotnet/api/system.int32\n[8]: https://learn.microsoft.com/dotnet/api/system.overflowexception\n[9]: https://learn.microsoft.com/dotnet/api/system.int32.maxvalue\n[10]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/CountAsync_1.md",
"content": "SqlSet.CountAsync(String, CancellationToken) Method\n===================================================\nReturns a number that represents how many elements in the set satisfy a condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------------- | ---------------------------------------------------------------------------------- |\n| [CountAsync(CancellationToken)][2] | Returns the number of elements in the set. |\n| [CountAsync(OperatorStringHandler, CancellationToken)][3] | Returns a number that represents how many elements in the set satisfy a condition. |\n| **CountAsync(String, CancellationToken)** | Returns a number that represents how many elements in the set satisfy a condition. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask CountAsync(\n\tstring predicate,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][4]\nA SQL expression to test each row for a condition.\n\n##### *cancellationToken* [CancellationToken][5] (Optional)\nThe [CancellationToken][5] to monitor for cancellation requests. The default is [None][6].\n\n#### Return Value\n[ValueTask][7]<[Int32][8]> \nA number that represents how many elements in the set satisfy the condition in the *predicate*.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ---------------------- | ------------------------------------------------------- |\n| [OverflowException][9] | The number of matching elements exceeds [MaxValue][10]. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][11] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: CountAsync_2.md\n[3]: CountAsync.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[7]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[8]: https://learn.microsoft.com/dotnet/api/system.int32\n[9]: https://learn.microsoft.com/dotnet/api/system.overflowexception\n[10]: https://learn.microsoft.com/dotnet/api/system.int32.maxvalue\n[11]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/CountAsync_2.md",
"content": "SqlSet.CountAsync(CancellationToken) Method\n===========================================\nReturns the number of elements in the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------------- | ---------------------------------------------------------------------------------- |\n| **CountAsync(CancellationToken)** | Returns the number of elements in the set. |\n| [CountAsync(OperatorStringHandler, CancellationToken)][2] | Returns a number that represents how many elements in the set satisfy a condition. |\n| [CountAsync(String, CancellationToken)][3] | Returns a number that represents how many elements in the set satisfy a condition. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask CountAsync(\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]<[Int32][7]> \nThe number of elements in the set.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ---------------------- | ---------------------------------------------------- |\n| [OverflowException][8] | The number of elements is larger than [MaxValue][9]. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][10] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: CountAsync.md\n[3]: CountAsync_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[7]: https://learn.microsoft.com/dotnet/api/system.int32\n[8]: https://learn.microsoft.com/dotnet/api/system.overflowexception\n[9]: https://learn.microsoft.com/dotnet/api/system.int32.maxvalue\n[10]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/Count_1.md",
"content": "SqlSet.Count(SqlSet.OperatorStringHandler) Method\n=================================================\nReturns a number that represents how many elements in the set satisfy a condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------- | ---------------------------------------------------------------------------------- |\n| [Count()][2] | Returns the number of elements in the set. |\n| **Count(OperatorStringHandler)** | Returns a number that represents how many elements in the set satisfy a condition. |\n| [Count(String)][3] | Returns a number that represents how many elements in the set satisfy a condition. |\n\n\nSyntax\n------\n\n```csharp\npublic int Count(\n\tref OperatorStringHandler predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[Int32][4] \nA number that represents how many elements in the set satisfy the condition in the *predicate*.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ---------------------- | ------------------------------------------------------ |\n| [OverflowException][5] | The number of matching elements exceeds [MaxValue][6]. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Count.md\n[3]: Count_2.md\n[4]: https://learn.microsoft.com/dotnet/api/system.int32\n[5]: https://learn.microsoft.com/dotnet/api/system.overflowexception\n[6]: https://learn.microsoft.com/dotnet/api/system.int32.maxvalue\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/Count_2.md",
"content": "SqlSet.Count(String) Method\n===========================\nReturns a number that represents how many elements in the set satisfy a condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------- | ---------------------------------------------------------------------------------- |\n| [Count()][2] | Returns the number of elements in the set. |\n| [Count(OperatorStringHandler)][3] | Returns a number that represents how many elements in the set satisfy a condition. |\n| **Count(String)** | Returns a number that represents how many elements in the set satisfy a condition. |\n\n\nSyntax\n------\n\n```csharp\npublic int Count(\n\tstring predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][4]\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[Int32][5] \nA number that represents how many elements in the set satisfy the condition in the *predicate*.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ---------------------- | ------------------------------------------------------ |\n| [OverflowException][6] | The number of matching elements exceeds [MaxValue][7]. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][8] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Count.md\n[3]: Count_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://learn.microsoft.com/dotnet/api/system.int32\n[6]: https://learn.microsoft.com/dotnet/api/system.overflowexception\n[7]: https://learn.microsoft.com/dotnet/api/system.int32.maxvalue\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/Database.md",
"content": "SqlSet.Database Property\n========================\nThe [Database][1] this set is connected to.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic Database Database { get; }\n```\n\n#### Property Value\n[Database][1]\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][3] \n[DbExtensions Namespace][2] \n\n[1]: ../Database/README.md\n[2]: ../README.md\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/Find.md",
"content": "SqlSet.Find Method\n==================\nGets the entity whose primary key matches the *id* parameter.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic Object? Find(\n\tObject id\n)\n```\n\n#### Parameters\n\n##### *id* [Object][2]\nThe primary key value.\n\n#### Return Value\n[Object][2] \n The entity whose primary key matches the *id* parameter, or null if the *id* does not exist.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | --------------------------------------------------------------------------------- |\n| [InvalidOperationException][3] | This method can only be used on sets where the result type is an annotated class. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/FindAsync.md",
"content": "SqlSet.FindAsync Method\n=======================\nGets the entity whose primary key matches the *id* parameter.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic ValueTask FindAsync(\n\tObject id,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *id* [Object][2]\nThe primary key value.\n\n##### *cancellationToken* [CancellationToken][3] (Optional)\nThe [CancellationToken][3] to monitor for cancellation requests. The default is [None][4].\n\n#### Return Value\n[ValueTask][5]<[Object][2]> \n The entity whose primary key matches the *id* parameter, or null if the *id* does not exist.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | --------------------------------------------------------------------------------- |\n| [InvalidOperationException][6] | This method can only be used on sets where the result type is an annotated class. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[6]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/First.md",
"content": "SqlSet.First Method\n===================\nReturns the first element of the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------- | -------------------------------------------------------------------------- |\n| **First()** | Returns the first element of the set. |\n| [First(OperatorStringHandler)][2] | Returns the first element in the set that satisfies a specified condition. |\n| [First(String)][3] | Returns the first element in the set that satisfies a specified condition. |\n\n\nSyntax\n------\n\n```csharp\npublic Object First()\n```\n\n#### Return Value\n[Object][4] \nThe first element in the set.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | ----------------- |\n| [InvalidOperationException][5] | The set is empty. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: First_1.md\n[3]: First_2.md\n[4]: https://learn.microsoft.com/dotnet/api/system.object\n[5]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/FirstAsync.md",
"content": "SqlSet.FirstAsync(SqlSet.OperatorStringHandler, CancellationToken) Method\n=========================================================================\nReturns the first element in the set that satisfies a specified condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------------- | -------------------------------------------------------------------------- |\n| [FirstAsync(CancellationToken)][2] | Returns the first element of the set. |\n| **FirstAsync(OperatorStringHandler, CancellationToken)** | Returns the first element in the set that satisfies a specified condition. |\n| [FirstAsync(String, CancellationToken)][3] | Returns the first element in the set that satisfies a specified condition. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask FirstAsync(\n\tOperatorStringHandler predicate,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]<[Object][7]> \nThe first element in the set that passes the test in the specified *predicate*.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | ----------------------------------------------------------------------- |\n| [InvalidOperationException][8] | No element satisfies the condition in *predicate*.-or-The set is empty. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][9] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: FirstAsync_2.md\n[3]: FirstAsync_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[7]: https://learn.microsoft.com/dotnet/api/system.object\n[8]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/FirstAsync_1.md",
"content": "SqlSet.FirstAsync(String, CancellationToken) Method\n===================================================\nReturns the first element in the set that satisfies a specified condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------------- | -------------------------------------------------------------------------- |\n| [FirstAsync(CancellationToken)][2] | Returns the first element of the set. |\n| [FirstAsync(OperatorStringHandler, CancellationToken)][3] | Returns the first element in the set that satisfies a specified condition. |\n| **FirstAsync(String, CancellationToken)** | Returns the first element in the set that satisfies a specified condition. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask FirstAsync(\n\tstring predicate,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][4]\nA SQL expression to test each row for a condition.\n\n##### *cancellationToken* [CancellationToken][5] (Optional)\nThe [CancellationToken][5] to monitor for cancellation requests. The default is [None][6].\n\n#### Return Value\n[ValueTask][7]<[Object][8]> \nThe first element in the set that passes the test in the specified *predicate*.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | ----------------------------------------------------------------------- |\n| [InvalidOperationException][9] | No element satisfies the condition in *predicate*.-or-The set is empty. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][10] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: FirstAsync_2.md\n[3]: FirstAsync.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[7]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[8]: https://learn.microsoft.com/dotnet/api/system.object\n[9]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception\n[10]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/FirstAsync_2.md",
"content": "SqlSet.FirstAsync(CancellationToken) Method\n===========================================\nReturns the first element of the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------------- | -------------------------------------------------------------------------- |\n| **FirstAsync(CancellationToken)** | Returns the first element of the set. |\n| [FirstAsync(OperatorStringHandler, CancellationToken)][2] | Returns the first element in the set that satisfies a specified condition. |\n| [FirstAsync(String, CancellationToken)][3] | Returns the first element in the set that satisfies a specified condition. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask FirstAsync(\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]<[Object][7]> \nThe first element in the set.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | ----------------- |\n| [InvalidOperationException][8] | The set is empty. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][9] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: FirstAsync.md\n[3]: FirstAsync_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[7]: https://learn.microsoft.com/dotnet/api/system.object\n[8]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/FirstOrDefault.md",
"content": "SqlSet.FirstOrDefault Method\n============================\nReturns the first element of the set, or a default value if the set contains no elements.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------ | --------------------------------------------------------------------------------------------------------------- |\n| **FirstOrDefault()** | Returns the first element of the set, or a default value if the set contains no elements. |\n| [FirstOrDefault(OperatorStringHandler)][2] | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n| [FirstOrDefault(String)][3] | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n\n\nSyntax\n------\n\n```csharp\npublic Object? FirstOrDefault()\n```\n\n#### Return Value\n[Object][4] \nA default value if the set is empty; otherwise, the first element.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: FirstOrDefault_1.md\n[3]: FirstOrDefault_2.md\n[4]: https://learn.microsoft.com/dotnet/api/system.object\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/FirstOrDefaultAsync.md",
"content": "SqlSet.FirstOrDefaultAsync(SqlSet.OperatorStringHandler, CancellationToken) Method\n==================================================================================\nReturns the first element of the set that satisfies a condition or a default value if no such element is found.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |\n| [FirstOrDefaultAsync(CancellationToken)][2] | Returns the first element of the set, or a default value if the set contains no elements. |\n| **FirstOrDefaultAsync(OperatorStringHandler, CancellationToken)** | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n| [FirstOrDefaultAsync(String, CancellationToken)][3] | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask FirstOrDefaultAsync(\n\tOperatorStringHandler predicate,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]<[Object][7]> \n A default value if the set is empty or if no element passes the test specified by *predicate*; otherwise, the first element that passes the test specified by *predicate*.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][8] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: FirstOrDefaultAsync_2.md\n[3]: FirstOrDefaultAsync_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[7]: https://learn.microsoft.com/dotnet/api/system.object\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/FirstOrDefaultAsync_1.md",
"content": "SqlSet.FirstOrDefaultAsync(String, CancellationToken) Method\n============================================================\nReturns the first element of the set that satisfies a condition or a default value if no such element is found.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- |\n| [FirstOrDefaultAsync(CancellationToken)][2] | Returns the first element of the set, or a default value if the set contains no elements. |\n| [FirstOrDefaultAsync(OperatorStringHandler, CancellationToken)][3] | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n| **FirstOrDefaultAsync(String, CancellationToken)** | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask FirstOrDefaultAsync(\n\tstring predicate,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][4]\nA SQL expression to test each row for a condition.\n\n##### *cancellationToken* [CancellationToken][5] (Optional)\nThe [CancellationToken][5] to monitor for cancellation requests. The default is [None][6].\n\n#### Return Value\n[ValueTask][7]<[Object][8]> \n A default value if the set is empty or if no element passes the test specified by *predicate*; otherwise, the first element that passes the test specified by *predicate*.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][9] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: FirstOrDefaultAsync_2.md\n[3]: FirstOrDefaultAsync.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[7]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[8]: https://learn.microsoft.com/dotnet/api/system.object\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/FirstOrDefaultAsync_2.md",
"content": "SqlSet.FirstOrDefaultAsync(CancellationToken) Method\n====================================================\nReturns the first element of the set, or a default value if the set contains no elements.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- |\n| **FirstOrDefaultAsync(CancellationToken)** | Returns the first element of the set, or a default value if the set contains no elements. |\n| [FirstOrDefaultAsync(OperatorStringHandler, CancellationToken)][2] | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n| [FirstOrDefaultAsync(String, CancellationToken)][3] | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask FirstOrDefaultAsync(\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]<[Object][7]> \nA default value if the set is empty; otherwise, the first element.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][8] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: FirstOrDefaultAsync.md\n[3]: FirstOrDefaultAsync_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[7]: https://learn.microsoft.com/dotnet/api/system.object\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/FirstOrDefault_1.md",
"content": "SqlSet.FirstOrDefault(SqlSet.OperatorStringHandler) Method\n==========================================================\nReturns the first element of the set that satisfies a condition or a default value if no such element is found.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------- | --------------------------------------------------------------------------------------------------------------- |\n| [FirstOrDefault()][2] | Returns the first element of the set, or a default value if the set contains no elements. |\n| **FirstOrDefault(OperatorStringHandler)** | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n| [FirstOrDefault(String)][3] | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n\n\nSyntax\n------\n\n```csharp\npublic Object? FirstOrDefault(\n\tref OperatorStringHandler? predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[Object][4] \n A default value if the set is empty or if no element passes the test specified by *predicate*; otherwise, the first element that passes the test specified by *predicate*.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: FirstOrDefault.md\n[3]: FirstOrDefault_2.md\n[4]: https://learn.microsoft.com/dotnet/api/system.object\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/FirstOrDefault_2.md",
"content": "SqlSet.FirstOrDefault(String) Method\n====================================\nReturns the first element of the set that satisfies a condition or a default value if no such element is found.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------ | --------------------------------------------------------------------------------------------------------------- |\n| [FirstOrDefault()][2] | Returns the first element of the set, or a default value if the set contains no elements. |\n| [FirstOrDefault(OperatorStringHandler)][3] | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n| **FirstOrDefault(String)** | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n\n\nSyntax\n------\n\n```csharp\npublic Object? FirstOrDefault(\n\tstring predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][4]\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[Object][5] \n A default value if the set is empty or if no element passes the test specified by *predicate*; otherwise, the first element that passes the test specified by *predicate*.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: FirstOrDefault.md\n[3]: FirstOrDefault_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://learn.microsoft.com/dotnet/api/system.object\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/First_1.md",
"content": "SqlSet.First(SqlSet.OperatorStringHandler) Method\n=================================================\nReturns the first element in the set that satisfies a specified condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------- | -------------------------------------------------------------------------- |\n| [First()][2] | Returns the first element of the set. |\n| **First(OperatorStringHandler)** | Returns the first element in the set that satisfies a specified condition. |\n| [First(String)][3] | Returns the first element in the set that satisfies a specified condition. |\n\n\nSyntax\n------\n\n```csharp\npublic Object First(\n\tref OperatorStringHandler predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[Object][4] \nThe first element in the set that passes the test in the specified *predicate*.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | ----------------------------------------------------------------------- |\n| [InvalidOperationException][5] | No element satisfies the condition in *predicate*.-or-The set is empty. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: First.md\n[3]: First_2.md\n[4]: https://learn.microsoft.com/dotnet/api/system.object\n[5]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/First_2.md",
"content": "SqlSet.First(String) Method\n===========================\nReturns the first element in the set that satisfies a specified condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------- | -------------------------------------------------------------------------- |\n| [First()][2] | Returns the first element of the set. |\n| [First(OperatorStringHandler)][3] | Returns the first element in the set that satisfies a specified condition. |\n| **First(String)** | Returns the first element in the set that satisfies a specified condition. |\n\n\nSyntax\n------\n\n```csharp\npublic Object First(\n\tstring predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][4]\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[Object][5] \nThe first element in the set that passes the test in the specified *predicate*.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | ----------------------------------------------------------------------- |\n| [InvalidOperationException][6] | No element satisfies the condition in *predicate*.-or-The set is empty. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: First.md\n[3]: First_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://learn.microsoft.com/dotnet/api/system.object\n[6]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/GetAsyncEnumerator.md",
"content": "SqlSet.GetAsyncEnumerator Method\n================================\nReturns an async enumerator that iterates through the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic IAsyncEnumerator GetAsyncEnumerator(\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *cancellationToken* [CancellationToken][2] (Optional)\nThe [CancellationToken][2] to monitor for cancellation requests. The default is [None][3].\n\n#### Return Value\n[IAsyncEnumerator][4]<[Object][5]> \nA [IAsyncEnumerator<T>][4] for the set.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[3]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[4]: https://learn.microsoft.com/dotnet/api/system.collections.generic.iasyncenumerator-1\n[5]: https://learn.microsoft.com/dotnet/api/system.object\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/GetDefiningQuery.md",
"content": "SqlSet.GetDefiningQuery Method\n==============================\nReturns the SQL query that is the source of data for the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic SqlBuilder GetDefiningQuery()\n```\n\n#### Return Value\n[SqlBuilder][2] \nThe SQL query that is the source of data for the set\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: ../SqlBuilder/README.md\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/GetEnumerator.md",
"content": "SqlSet.GetEnumerator Method\n===========================\nReturns an enumerator that iterates through the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic IEnumerator GetEnumerator()\n```\n\n#### Return Value\n[IEnumerator][2]<[Object][3]> \nA [IEnumerator<T>][2] for the set.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerator-1\n[3]: https://learn.microsoft.com/dotnet/api/system.object\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/Include.md",
"content": "SqlSet.Include Method\n=====================\nSpecifies the related objects to include in the query results.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic SqlSet Include(\n\tstring path\n)\n```\n\n#### Parameters\n\n##### *path* [String][2]\nDot-separated list of related objects to return in the query results.\n\n#### Return Value\n[SqlSet][3] \nA new [SqlSet][3] with the defined query path.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | --------------------------------------------------------------------------------- |\n| [InvalidOperationException][4] | This method can only be used on sets where the result type is an annotated class. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.string\n[3]: README.md\n[4]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception"
},
{
"path": "docs/api/DbExtensions/SqlSet/IncludeMany.md",
"content": "SqlSet.IncludeMany Method\n=========================\nSpecifies which collections to include in the query results.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic SqlSet IncludeMany(\n\tstring path,\n\tFunc? manySetup = null\n)\n```\n\n#### Parameters\n\n##### *path* [String][2]\nDot-separated list of one or more related objects that ends with the collection to load.\n\n##### *manySetup* [Func][3]<[SqlSet][4], [SqlSet][4]> (Optional)\nA function to customize how the collection is loaded.\n\n#### Return Value\n[SqlSet][4] \nA new [SqlSet][4].\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | --------------------------------------------------------------------------------- |\n| [InvalidOperationException][5] | This method can only be used on sets where the result type is an annotated class. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.string\n[3]: https://learn.microsoft.com/dotnet/api/system.func-2\n[4]: README.md\n[5]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception"
},
{
"path": "docs/api/DbExtensions/SqlSet/LongCount.md",
"content": "SqlSet.LongCount Method\n=======================\nReturns an [Int64][1] that represents the total number of elements in the set.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------- | --------------------------------------------------------------------------------------- |\n| **LongCount()** | Returns an [Int64][1] that represents the total number of elements in the set. |\n| [LongCount(OperatorStringHandler)][3] | Returns an [Int64][1] that represents how many elements in the set satisfy a condition. |\n| [LongCount(String)][4] | Returns an [Int64][1] that represents how many elements in the set satisfy a condition. |\n\n\nSyntax\n------\n\n```csharp\npublic long LongCount()\n```\n\n#### Return Value\n[Int64][1] \nThe number of elements in the set.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ---------------------- | ---------------------------------------------------- |\n| [OverflowException][5] | The number of elements is larger than [MaxValue][6]. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][7] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.int64\n[2]: ../README.md\n[3]: LongCount_1.md\n[4]: LongCount_2.md\n[5]: https://learn.microsoft.com/dotnet/api/system.overflowexception\n[6]: https://learn.microsoft.com/dotnet/api/system.int64.maxvalue\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/LongCountAsync.md",
"content": "SqlSet.LongCountAsync(SqlSet.OperatorStringHandler, CancellationToken) Method\n=============================================================================\nReturns an [Int64][1] that represents how many elements in the set satisfy a condition.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------------ | --------------------------------------------------------------------------------------- |\n| [LongCountAsync(CancellationToken)][3] | Returns an [Int64][1] that represents the total number of elements in the set. |\n| **LongCountAsync(OperatorStringHandler, CancellationToken)** | Returns an [Int64][1] that represents how many elements in the set satisfy a condition. |\n| [LongCountAsync(String, CancellationToken)][4] | Returns an [Int64][1] that represents how many elements in the set satisfy a condition. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask LongCountAsync(\n\tOperatorStringHandler predicate,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n##### *cancellationToken* [CancellationToken][5] (Optional)\nThe [CancellationToken][5] to monitor for cancellation requests. The default is [None][6].\n\n#### Return Value\n[ValueTask][7]<[Int64][1]> \nA number that represents how many elements in the set satisfy the condition in the *predicate*.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ---------------------- | ------------------------------------------------------ |\n| [OverflowException][8] | The number of matching elements exceeds [MaxValue][9]. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][10] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.int64\n[2]: ../README.md\n[3]: LongCountAsync_2.md\n[4]: LongCountAsync_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[7]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[8]: https://learn.microsoft.com/dotnet/api/system.overflowexception\n[9]: https://learn.microsoft.com/dotnet/api/system.int64.maxvalue\n[10]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/LongCountAsync_1.md",
"content": "SqlSet.LongCountAsync(String, CancellationToken) Method\n=======================================================\nReturns an [Int64][1] that represents how many elements in the set satisfy a condition.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------------- | --------------------------------------------------------------------------------------- |\n| [LongCountAsync(CancellationToken)][3] | Returns an [Int64][1] that represents the total number of elements in the set. |\n| [LongCountAsync(OperatorStringHandler, CancellationToken)][4] | Returns an [Int64][1] that represents how many elements in the set satisfy a condition. |\n| **LongCountAsync(String, CancellationToken)** | Returns an [Int64][1] that represents how many elements in the set satisfy a condition. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask LongCountAsync(\n\tstring predicate,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][5]\nA SQL expression to test each row for a condition.\n\n##### *cancellationToken* [CancellationToken][6] (Optional)\nThe [CancellationToken][6] to monitor for cancellation requests. The default is [None][7].\n\n#### Return Value\n[ValueTask][8]<[Int64][1]> \nA number that represents how many elements in the set satisfy the condition in the *predicate*.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ---------------------- | ------------------------------------------------------- |\n| [OverflowException][9] | The number of matching elements exceeds [MaxValue][10]. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][11] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.int64\n[2]: ../README.md\n[3]: LongCountAsync_2.md\n[4]: LongCountAsync.md\n[5]: https://learn.microsoft.com/dotnet/api/system.string\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[7]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[8]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[9]: https://learn.microsoft.com/dotnet/api/system.overflowexception\n[10]: https://learn.microsoft.com/dotnet/api/system.int64.maxvalue\n[11]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/LongCountAsync_2.md",
"content": "SqlSet.LongCountAsync(CancellationToken) Method\n===============================================\nReturns an [Int64][1] that represents the total number of elements in the set.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------------- | --------------------------------------------------------------------------------------- |\n| **LongCountAsync(CancellationToken)** | Returns an [Int64][1] that represents the total number of elements in the set. |\n| [LongCountAsync(OperatorStringHandler, CancellationToken)][3] | Returns an [Int64][1] that represents how many elements in the set satisfy a condition. |\n| [LongCountAsync(String, CancellationToken)][4] | Returns an [Int64][1] that represents how many elements in the set satisfy a condition. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask LongCountAsync(\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *cancellationToken* [CancellationToken][5] (Optional)\nThe [CancellationToken][5] to monitor for cancellation requests. The default is [None][6].\n\n#### Return Value\n[ValueTask][7]<[Int64][1]> \nThe number of elements in the set.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ---------------------- | ---------------------------------------------------- |\n| [OverflowException][8] | The number of elements is larger than [MaxValue][9]. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][10] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.int64\n[2]: ../README.md\n[3]: LongCountAsync.md\n[4]: LongCountAsync_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[7]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[8]: https://learn.microsoft.com/dotnet/api/system.overflowexception\n[9]: https://learn.microsoft.com/dotnet/api/system.int64.maxvalue\n[10]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/LongCount_1.md",
"content": "SqlSet.LongCount(SqlSet.OperatorStringHandler) Method\n=====================================================\nReturns an [Int64][1] that represents how many elements in the set satisfy a condition.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------ | --------------------------------------------------------------------------------------- |\n| [LongCount()][3] | Returns an [Int64][1] that represents the total number of elements in the set. |\n| **LongCount(OperatorStringHandler)** | Returns an [Int64][1] that represents how many elements in the set satisfy a condition. |\n| [LongCount(String)][4] | Returns an [Int64][1] that represents how many elements in the set satisfy a condition. |\n\n\nSyntax\n------\n\n```csharp\npublic long LongCount(\n\tref OperatorStringHandler predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[Int64][1] \nA number that represents how many elements in the set satisfy the condition in the *predicate*.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ---------------------- | ------------------------------------------------------ |\n| [OverflowException][5] | The number of matching elements exceeds [MaxValue][6]. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][7] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.int64\n[2]: ../README.md\n[3]: LongCount.md\n[4]: LongCount_2.md\n[5]: https://learn.microsoft.com/dotnet/api/system.overflowexception\n[6]: https://learn.microsoft.com/dotnet/api/system.int64.maxvalue\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/LongCount_2.md",
"content": "SqlSet.LongCount(String) Method\n===============================\nReturns an [Int64][1] that represents how many elements in the set satisfy a condition.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------- | --------------------------------------------------------------------------------------- |\n| [LongCount()][3] | Returns an [Int64][1] that represents the total number of elements in the set. |\n| [LongCount(OperatorStringHandler)][4] | Returns an [Int64][1] that represents how many elements in the set satisfy a condition. |\n| **LongCount(String)** | Returns an [Int64][1] that represents how many elements in the set satisfy a condition. |\n\n\nSyntax\n------\n\n```csharp\npublic long LongCount(\n\tstring predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][5]\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[Int64][1] \nA number that represents how many elements in the set satisfy the condition in the *predicate*.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ---------------------- | ------------------------------------------------------ |\n| [OverflowException][6] | The number of matching elements exceeds [MaxValue][7]. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][8] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.int64\n[2]: ../README.md\n[3]: LongCount.md\n[4]: LongCount_1.md\n[5]: https://learn.microsoft.com/dotnet/api/system.string\n[6]: https://learn.microsoft.com/dotnet/api/system.overflowexception\n[7]: https://learn.microsoft.com/dotnet/api/system.int64.maxvalue\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/OrderBy.md",
"content": "SqlSet.OrderBy(SqlSet.OperatorStringHandler) Method\n===================================================\nSorts the elements of the set according to the *columnList*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------- | ------------------------------------------------------------ |\n| **OrderBy(OperatorStringHandler)** | Sorts the elements of the set according to the *columnList*. |\n| [OrderBy(String)][2] | Sorts the elements of the set according to the *columnList*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlSet OrderBy(\n\tref OperatorStringHandler columnList\n)\n```\n\n#### Parameters\n\n##### *columnList* OperatorStringHandler\nThe list of columns to base the sort on.\n\n#### Return Value\n[SqlSet][3] \nA new [SqlSet][3] whose elements are sorted according to *columnList*.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: OrderBy_1.md\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/OrderBy_1.md",
"content": "SqlSet.OrderBy(String) Method\n=============================\nSorts the elements of the set according to the *columnList*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------- | ------------------------------------------------------------ |\n| [OrderBy(OperatorStringHandler)][2] | Sorts the elements of the set according to the *columnList*. |\n| **OrderBy(String)** | Sorts the elements of the set according to the *columnList*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlSet OrderBy(\n\tstring columnList\n)\n```\n\n#### Parameters\n\n##### *columnList* [String][3]\nThe list of columns to base the sort on.\n\n#### Return Value\n[SqlSet][4] \nA new [SqlSet][4] whose elements are sorted according to *columnList*.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: OrderBy.md\n[3]: https://learn.microsoft.com/dotnet/api/system.string\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/README.md",
"content": "SqlSet Class\n============\nRepresents an immutable, connected SQL query. This class cannot be instantiated, to get an instance use one of the [Database.From][1] or [Database.FromQuery][2] overloads.\n\n\nInheritance Hierarchy\n---------------------\n[System.Object][3] \n **DbExtensions.SqlSet** \n [DbExtensions.SqlSet<TResult>][4] \n [DbExtensions.SqlTable][5] \n \n**Namespace:** [DbExtensions][6] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic class SqlSet\n```\n\nThe **SqlSet** type exposes the following members.\n\n\nProperties\n----------\n\n| Name | Description |\n| --------------- | ---------------------------------------------------------------- |\n| [Database][7] | The [Database][8] this set is connected to. |\n| [ResultType][9] | The type of objects this set returns. This property can be null. |\n\n\nMethods\n-------\n\n| Name | Description |\n| ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [All(OperatorStringHandler)][10] | Determines whether all elements of the set satisfy a condition. |\n| [All(String)][11] | Determines whether all elements of the set satisfy a condition. |\n| [AllAsync(OperatorStringHandler, CancellationToken)][12] | Determines whether all elements of the set satisfy a condition. |\n| [AllAsync(String, CancellationToken)][13] | Determines whether all elements of the set satisfy a condition. |\n| [Any()][14] | Determines whether the set contains any elements. |\n| [Any(OperatorStringHandler)][15] | Determines whether any element of the set satisfies a condition. |\n| [Any(String)][16] | Determines whether any element of the set satisfies a condition. |\n| [AnyAsync(CancellationToken)][17] | Determines whether the set contains any elements. |\n| [AnyAsync(OperatorStringHandler, CancellationToken)][18] | Determines whether any element of the set satisfies a condition. |\n| [AnyAsync(String, CancellationToken)][19] | Determines whether any element of the set satisfies a condition. |\n| [AsAsyncEnumerable][20] | Gets all elements in the set. The query is deferred-executed. |\n| [AsEnumerable][21] | Gets all elements in the set. The query is deferred-executed. |\n| [Cast(Type)][22] | Casts the elements of the set to the specified type. |\n| [Cast<TResult>()][23] | Casts the elements of the set to the specified type. |\n| [Contains][24] | Checks the existance of the *entity*, using the primary key value. |\n| [ContainsAsync][25] | Checks the existance of the *entity*, using the primary key value. |\n| [ContainsKey][26] | Checks the existance of an entity whose primary matches the *id* parameter. |\n| [ContainsKeyAsync][27] | Checks the existance of an entity whose primary matches the *id* parameter. |\n| [Count()][28] | Returns the number of elements in the set. |\n| [Count(OperatorStringHandler)][29] | Returns a number that represents how many elements in the set satisfy a condition. |\n| [Count(String)][30] | Returns a number that represents how many elements in the set satisfy a condition. |\n| [CountAsync(CancellationToken)][31] | Returns the number of elements in the set. |\n| [CountAsync(OperatorStringHandler, CancellationToken)][32] | Returns a number that represents how many elements in the set satisfy a condition. |\n| [CountAsync(String, CancellationToken)][33] | Returns a number that represents how many elements in the set satisfy a condition. |\n| [Find][34] | Gets the entity whose primary key matches the *id* parameter. |\n| [FindAsync][35] | Gets the entity whose primary key matches the *id* parameter. |\n| [First()][36] | Returns the first element of the set. |\n| [First(OperatorStringHandler)][37] | Returns the first element in the set that satisfies a specified condition. |\n| [First(String)][38] | Returns the first element in the set that satisfies a specified condition. |\n| [FirstAsync(CancellationToken)][39] | Returns the first element of the set. |\n| [FirstAsync(OperatorStringHandler, CancellationToken)][40] | Returns the first element in the set that satisfies a specified condition. |\n| [FirstAsync(String, CancellationToken)][41] | Returns the first element in the set that satisfies a specified condition. |\n| [FirstOrDefault()][42] | Returns the first element of the set, or a default value if the set contains no elements. |\n| [FirstOrDefault(OperatorStringHandler)][43] | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n| [FirstOrDefault(String)][44] | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n| [FirstOrDefaultAsync(CancellationToken)][45] | Returns the first element of the set, or a default value if the set contains no elements. |\n| [FirstOrDefaultAsync(OperatorStringHandler, CancellationToken)][46] | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n| [FirstOrDefaultAsync(String, CancellationToken)][47] | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n| [GetAsyncEnumerator][48] | Returns an async enumerator that iterates through the set. |\n| [GetDefiningQuery][49] | Returns the SQL query that is the source of data for the set. |\n| [GetEnumerator][50] | Returns an enumerator that iterates through the set. |\n| [Include][51] | Specifies the related objects to include in the query results. |\n| [IncludeMany][52] | Specifies which collections to include in the query results. |\n| [LongCount()][53] | Returns an [Int64][54] that represents the total number of elements in the set. |\n| [LongCount(OperatorStringHandler)][55] | Returns an [Int64][54] that represents how many elements in the set satisfy a condition. |\n| [LongCount(String)][56] | Returns an [Int64][54] that represents how many elements in the set satisfy a condition. |\n| [LongCountAsync(CancellationToken)][57] | Returns an [Int64][54] that represents the total number of elements in the set. |\n| [LongCountAsync(OperatorStringHandler, CancellationToken)][58] | Returns an [Int64][54] that represents how many elements in the set satisfy a condition. |\n| [LongCountAsync(String, CancellationToken)][59] | Returns an [Int64][54] that represents how many elements in the set satisfy a condition. |\n| [OrderBy(OperatorStringHandler)][60] | Sorts the elements of the set according to the *columnList*. |\n| [OrderBy(String)][61] | Sorts the elements of the set according to the *columnList*. |\n| [Select(OperatorStringHandler)][62] | Projects each element of the set into a new form. |\n| [Select(String)][63] | Projects each element of the set into a new form. |\n| [Select(OperatorStringHandler, Type)][64] | Projects each element of the set into a new form. |\n| [Select(String, Type)][65] | Projects each element of the set into a new form. |\n| [Select<TResult>(OperatorStringHandler)][66] | Projects each element of the set into a new form. |\n| [Select<TResult>(String)][67] | Projects each element of the set into a new form. |\n| [Select<TResult>(OperatorStringHandler, Func<DbDataReader, TResult>)][68] | Projects each element of the set into a new form. |\n| [Select<TResult>(String, Func<DbDataReader, TResult>)][69] | Projects each element of the set into a new form. |\n| [Single()][70] | The single element of the set. |\n| [Single(OperatorStringHandler)][71] | Returns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists. |\n| [Single(String)][72] | Returns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists. |\n| [SingleAsync(CancellationToken)][73] | The single element of the set. |\n| [SingleAsync(OperatorStringHandler, CancellationToken)][74] | Returns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists. |\n| [SingleAsync(String, CancellationToken)][75] | Returns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists. |\n| [SingleOrDefault()][76] | Returns the only element of the set, or a default value if the set is empty; this method throws an exception if there is more than one element in the set. |\n| [SingleOrDefault(OperatorStringHandler)][77] | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n| [SingleOrDefault(String)][78] | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n| [SingleOrDefaultAsync(CancellationToken)][79] | Returns the only element of the set, or a default value if the set is empty; this method throws an exception if there is more than one element in the set. |\n| [SingleOrDefaultAsync(OperatorStringHandler, CancellationToken)][80] | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n| [SingleOrDefaultAsync(String, CancellationToken)][81] | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n| [Skip][82] | Bypasses a specified number of elements in the set and then returns the remaining elements. |\n| [Take][83] | Returns a specified number of contiguous elements from the start of the set. |\n| [ToArray][84] | Creates an array from the set. |\n| [ToArrayAsync][85] | Creates an array from the set. |\n| [ToList][86] | Creates a [List<T>][87] from the set. |\n| [ToListAsync][88] | Creates a [List<T>][87] from the set. |\n| [ToString][89] | Returns the SQL query of the set. Select(\n\tref OperatorStringHandler columnList\n)\n\n```\n\n#### Parameters\n\n##### *columnList* OperatorStringHandler\nThe list of columns that maps to properties on TResult.\n\n#### Type Parameters\n\n##### *TResult*\nThe type that *columnList* maps to.\n\n#### Return Value\n[SqlSet][9]<**TResult**> \nA new [SqlSet<TResult>][9].\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][10] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Select.md\n[3]: Select_2.md\n[4]: Select_1.md\n[5]: Select_3.md\n[6]: Select__1_2.md\n[7]: Select__1_1.md\n[8]: Select__1_3.md\n[9]: ../SqlSet_1/README.md\n[10]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/Select__1_1.md",
"content": "SqlSet.Select<TResult>(SqlSet.OperatorStringHandler, Func<DbDataReader, TResult>) Method\n==============================================================================================\nProjects each element of the set into a new form.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------------------------------------------- | ------------------------------------------------- |\n| [Select(OperatorStringHandler)][2] | Projects each element of the set into a new form. |\n| [Select(String)][3] | Projects each element of the set into a new form. |\n| [Select(OperatorStringHandler, Type)][4] | Projects each element of the set into a new form. |\n| [Select(String, Type)][5] | Projects each element of the set into a new form. |\n| [Select<TResult>(OperatorStringHandler)][6] | Projects each element of the set into a new form. |\n| [Select<TResult>(String)][7] | Projects each element of the set into a new form. |\n| **Select<TResult>(OperatorStringHandler, Func<DbDataReader, TResult>)** | Projects each element of the set into a new form. |\n| [Select<TResult>(String, Func<DbDataReader, TResult>)][8] | Projects each element of the set into a new form. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlSet Select(\n\tref OperatorStringHandler columnList,\n\tFunc mapper\n)\n\n```\n\n#### Parameters\n\n##### *columnList* OperatorStringHandler\nThe list of columns that are used by *mapper*.\n\n##### *mapper* [Func][9]<[DbDataReader][10], **TResult**>\nA custom mapper function that creates TResult instances from the rows in the set.\n\n#### Type Parameters\n\n##### *TResult*\nThe type that *mapper* returns.\n\n#### Return Value\n[SqlSet][11]<**TResult**> \nA new [SqlSet<TResult>][11].\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][12] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Select.md\n[3]: Select_2.md\n[4]: Select_1.md\n[5]: Select_3.md\n[6]: Select__1.md\n[7]: Select__1_2.md\n[8]: Select__1_3.md\n[9]: https://learn.microsoft.com/dotnet/api/system.func-2\n[10]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[11]: ../SqlSet_1/README.md\n[12]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/Select__1_2.md",
"content": "SqlSet.Select<TResult>(String) Method\n========================================\nProjects each element of the set into a new form.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------------------------------ | ------------------------------------------------- |\n| [Select(OperatorStringHandler)][2] | Projects each element of the set into a new form. |\n| [Select(String)][3] | Projects each element of the set into a new form. |\n| [Select(OperatorStringHandler, Type)][4] | Projects each element of the set into a new form. |\n| [Select(String, Type)][5] | Projects each element of the set into a new form. |\n| [Select<TResult>(OperatorStringHandler)][6] | Projects each element of the set into a new form. |\n| **Select<TResult>(String)** | Projects each element of the set into a new form. |\n| [Select<TResult>(OperatorStringHandler, Func<DbDataReader, TResult>)][7] | Projects each element of the set into a new form. |\n| [Select<TResult>(String, Func<DbDataReader, TResult>)][8] | Projects each element of the set into a new form. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlSet Select(\n\tstring columnList\n)\n\n```\n\n#### Parameters\n\n##### *columnList* [String][9]\nThe list of columns that maps to properties on TResult.\n\n#### Type Parameters\n\n##### *TResult*\nThe type that *columnList* maps to.\n\n#### Return Value\n[SqlSet][10]<**TResult**> \nA new [SqlSet<TResult>][10].\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][11] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Select.md\n[3]: Select_2.md\n[4]: Select_1.md\n[5]: Select_3.md\n[6]: Select__1.md\n[7]: Select__1_1.md\n[8]: Select__1_3.md\n[9]: https://learn.microsoft.com/dotnet/api/system.string\n[10]: ../SqlSet_1/README.md\n[11]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/Select__1_3.md",
"content": "SqlSet.Select<TResult>(String, Func<DbDataReader, TResult>) Method\n========================================================================\nProjects each element of the set into a new form.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------------------------------ | ------------------------------------------------- |\n| [Select(OperatorStringHandler)][2] | Projects each element of the set into a new form. |\n| [Select(String)][3] | Projects each element of the set into a new form. |\n| [Select(OperatorStringHandler, Type)][4] | Projects each element of the set into a new form. |\n| [Select(String, Type)][5] | Projects each element of the set into a new form. |\n| [Select<TResult>(OperatorStringHandler)][6] | Projects each element of the set into a new form. |\n| [Select<TResult>(String)][7] | Projects each element of the set into a new form. |\n| [Select<TResult>(OperatorStringHandler, Func<DbDataReader, TResult>)][8] | Projects each element of the set into a new form. |\n| **Select<TResult>(String, Func<DbDataReader, TResult>)** | Projects each element of the set into a new form. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlSet Select(\n\tstring columnList,\n\tFunc mapper\n)\n\n```\n\n#### Parameters\n\n##### *columnList* [String][9]\nThe list of columns that are used by *mapper*.\n\n##### *mapper* [Func][10]<[DbDataReader][11], **TResult**>\nA custom mapper function that creates TResult instances from the rows in the set.\n\n#### Type Parameters\n\n##### *TResult*\nThe type that *mapper* returns.\n\n#### Return Value\n[SqlSet][12]<**TResult**> \nA new [SqlSet<TResult>][12].\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][13] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Select.md\n[3]: Select_2.md\n[4]: Select_1.md\n[5]: Select_3.md\n[6]: Select__1.md\n[7]: Select__1_2.md\n[8]: Select__1_1.md\n[9]: https://learn.microsoft.com/dotnet/api/system.string\n[10]: https://learn.microsoft.com/dotnet/api/system.func-2\n[11]: https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader\n[12]: ../SqlSet_1/README.md\n[13]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/Single.md",
"content": "SqlSet.Single Method\n====================\nThe single element of the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| **Single()** | The single element of the set. |\n| [Single(OperatorStringHandler)][2] | Returns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists. |\n| [Single(String)][3] | Returns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists. |\n\n\nSyntax\n------\n\n```csharp\npublic Object Single()\n```\n\n#### Return Value\n[Object][4] \nThe single element of the set.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | ------------------------------------------------------------ |\n| [InvalidOperationException][5] | The set contains more than one element.-or-The set is empty. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Single_1.md\n[3]: Single_2.md\n[4]: https://learn.microsoft.com/dotnet/api/system.object\n[5]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/SingleAsync.md",
"content": "SqlSet.SingleAsync(SqlSet.OperatorStringHandler, CancellationToken) Method\n==========================================================================\nReturns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| [SingleAsync(CancellationToken)][2] | The single element of the set. |\n| **SingleAsync(OperatorStringHandler, CancellationToken)** | Returns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists. |\n| [SingleAsync(String, CancellationToken)][3] | Returns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask SingleAsync(\n\tOperatorStringHandler predicate,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]<[Object][7]> \nThe single element of the set that passes the test in the specified *predicate*.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |\n| [InvalidOperationException][8] | No element satisfies the condition in *predicate*.-or-More than one element satisfies the condition in *predicate*.-or-The set is empty. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][9] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: SingleAsync_2.md\n[3]: SingleAsync_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[7]: https://learn.microsoft.com/dotnet/api/system.object\n[8]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/SingleAsync_1.md",
"content": "SqlSet.SingleAsync(String, CancellationToken) Method\n====================================================\nReturns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| [SingleAsync(CancellationToken)][2] | The single element of the set. |\n| [SingleAsync(OperatorStringHandler, CancellationToken)][3] | Returns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists. |\n| **SingleAsync(String, CancellationToken)** | Returns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask SingleAsync(\n\tstring predicate,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][4]\nA SQL expression to test each row for a condition.\n\n##### *cancellationToken* [CancellationToken][5] (Optional)\nThe [CancellationToken][5] to monitor for cancellation requests. The default is [None][6].\n\n#### Return Value\n[ValueTask][7]<[Object][8]> \nThe single element of the set that passes the test in the specified *predicate*.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |\n| [InvalidOperationException][9] | No element satisfies the condition in *predicate*.-or-More than one element satisfies the condition in *predicate*.-or-The set is empty. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][10] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: SingleAsync_2.md\n[3]: SingleAsync.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[7]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[8]: https://learn.microsoft.com/dotnet/api/system.object\n[9]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception\n[10]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/SingleAsync_2.md",
"content": "SqlSet.SingleAsync(CancellationToken) Method\n============================================\nThe single element of the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| **SingleAsync(CancellationToken)** | The single element of the set. |\n| [SingleAsync(OperatorStringHandler, CancellationToken)][2] | Returns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists. |\n| [SingleAsync(String, CancellationToken)][3] | Returns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask SingleAsync(\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]<[Object][7]> \nThe single element of the set.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | ------------------------------------------------------------ |\n| [InvalidOperationException][8] | The set contains more than one element.-or-The set is empty. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][9] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: SingleAsync.md\n[3]: SingleAsync_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[7]: https://learn.microsoft.com/dotnet/api/system.object\n[8]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/SingleOrDefault.md",
"content": "SqlSet.SingleOrDefault Method\n=============================\nReturns the only element of the set, or a default value if the set is empty; this method throws an exception if there is more than one element in the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **SingleOrDefault()** | Returns the only element of the set, or a default value if the set is empty; this method throws an exception if there is more than one element in the set. |\n| [SingleOrDefault(OperatorStringHandler)][2] | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n| [SingleOrDefault(String)][3] | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n\n\nSyntax\n------\n\n```csharp\npublic Object? SingleOrDefault()\n```\n\n#### Return Value\n[Object][4] \nThe single element of the set, or a default value if the set contains no elements.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | --------------------------------------- |\n| [InvalidOperationException][5] | The set contains more than one element. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: SingleOrDefault_1.md\n[3]: SingleOrDefault_2.md\n[4]: https://learn.microsoft.com/dotnet/api/system.object\n[5]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/SingleOrDefaultAsync.md",
"content": "SqlSet.SingleOrDefaultAsync(SqlSet.OperatorStringHandler, CancellationToken) Method\n===================================================================================\nReturns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [SingleOrDefaultAsync(CancellationToken)][2] | Returns the only element of the set, or a default value if the set is empty; this method throws an exception if there is more than one element in the set. |\n| **SingleOrDefaultAsync(OperatorStringHandler, CancellationToken)** | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n| [SingleOrDefaultAsync(String, CancellationToken)][3] | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask SingleOrDefaultAsync(\n\tOperatorStringHandler predicate,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]<[Object][7]> \nThe single element of the set that satisfies the condition, or a default value if no such element is found.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][8] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: SingleOrDefaultAsync_2.md\n[3]: SingleOrDefaultAsync_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[7]: https://learn.microsoft.com/dotnet/api/system.object\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/SingleOrDefaultAsync_1.md",
"content": "SqlSet.SingleOrDefaultAsync(String, CancellationToken) Method\n=============================================================\nReturns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [SingleOrDefaultAsync(CancellationToken)][2] | Returns the only element of the set, or a default value if the set is empty; this method throws an exception if there is more than one element in the set. |\n| [SingleOrDefaultAsync(OperatorStringHandler, CancellationToken)][3] | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n| **SingleOrDefaultAsync(String, CancellationToken)** | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask SingleOrDefaultAsync(\n\tstring predicate,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][4]\nA SQL expression to test each row for a condition.\n\n##### *cancellationToken* [CancellationToken][5] (Optional)\nThe [CancellationToken][5] to monitor for cancellation requests. The default is [None][6].\n\n#### Return Value\n[ValueTask][7]<[Object][8]> \nThe single element of the set that satisfies the condition, or a default value if no such element is found.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][9] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: SingleOrDefaultAsync_2.md\n[3]: SingleOrDefaultAsync.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[7]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[8]: https://learn.microsoft.com/dotnet/api/system.object\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/SingleOrDefaultAsync_2.md",
"content": "SqlSet.SingleOrDefaultAsync(CancellationToken) Method\n=====================================================\nReturns the only element of the set, or a default value if the set is empty; this method throws an exception if there is more than one element in the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **SingleOrDefaultAsync(CancellationToken)** | Returns the only element of the set, or a default value if the set is empty; this method throws an exception if there is more than one element in the set. |\n| [SingleOrDefaultAsync(OperatorStringHandler, CancellationToken)][2] | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n| [SingleOrDefaultAsync(String, CancellationToken)][3] | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask SingleOrDefaultAsync(\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]<[Object][7]> \nThe single element of the set, or a default value if the set contains no elements.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | --------------------------------------- |\n| [InvalidOperationException][8] | The set contains more than one element. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][9] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: SingleOrDefaultAsync.md\n[3]: SingleOrDefaultAsync_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[7]: https://learn.microsoft.com/dotnet/api/system.object\n[8]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception\n[9]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/SingleOrDefault_1.md",
"content": "SqlSet.SingleOrDefault(SqlSet.OperatorStringHandler) Method\n===========================================================\nReturns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [SingleOrDefault()][2] | Returns the only element of the set, or a default value if the set is empty; this method throws an exception if there is more than one element in the set. |\n| **SingleOrDefault(OperatorStringHandler)** | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n| [SingleOrDefault(String)][3] | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n\n\nSyntax\n------\n\n```csharp\npublic Object? SingleOrDefault(\n\tref OperatorStringHandler? predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[Object][4] \nThe single element of the set that satisfies the condition, or a default value if no such element is found.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: SingleOrDefault.md\n[3]: SingleOrDefault_2.md\n[4]: https://learn.microsoft.com/dotnet/api/system.object\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/SingleOrDefault_2.md",
"content": "SqlSet.SingleOrDefault(String) Method\n=====================================\nReturns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [SingleOrDefault()][2] | Returns the only element of the set, or a default value if the set is empty; this method throws an exception if there is more than one element in the set. |\n| [SingleOrDefault(OperatorStringHandler)][3] | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n| **SingleOrDefault(String)** | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n\n\nSyntax\n------\n\n```csharp\npublic Object? SingleOrDefault(\n\tstring predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][4]\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[Object][5] \nThe single element of the set that satisfies the condition, or a default value if no such element is found.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: SingleOrDefault.md\n[3]: SingleOrDefault_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://learn.microsoft.com/dotnet/api/system.object\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/Single_1.md",
"content": "SqlSet.Single(SqlSet.OperatorStringHandler) Method\n==================================================\nReturns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| [Single()][2] | The single element of the set. |\n| **Single(OperatorStringHandler)** | Returns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists. |\n| [Single(String)][3] | Returns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists. |\n\n\nSyntax\n------\n\n```csharp\npublic Object Single(\n\tref OperatorStringHandler predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[Object][4] \nThe single element of the set that passes the test in the specified *predicate*.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |\n| [InvalidOperationException][5] | No element satisfies the condition in *predicate*.-or-More than one element satisfies the condition in *predicate*.-or-The set is empty. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Single.md\n[3]: Single_2.md\n[4]: https://learn.microsoft.com/dotnet/api/system.object\n[5]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/Single_2.md",
"content": "SqlSet.Single(String) Method\n============================\nReturns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| [Single()][2] | The single element of the set. |\n| [Single(OperatorStringHandler)][3] | Returns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists. |\n| **Single(String)** | Returns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists. |\n\n\nSyntax\n------\n\n```csharp\npublic Object Single(\n\tstring predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][4]\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[Object][5] \nThe single element of the set that passes the test in the specified *predicate*.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |\n| [InvalidOperationException][6] | No element satisfies the condition in *predicate*.-or-More than one element satisfies the condition in *predicate*.-or-The set is empty. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Single.md\n[3]: Single_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://learn.microsoft.com/dotnet/api/system.object\n[6]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/Skip.md",
"content": "SqlSet.Skip Method\n==================\nBypasses a specified number of elements in the set and then returns the remaining elements.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic SqlSet Skip(\n\tint count\n)\n```\n\n#### Parameters\n\n##### *count* [Int32][2]\nThe number of elements to skip before returning the remaining elements.\n\n#### Return Value\n[SqlSet][3] \nA new [SqlSet][3] that contains the elements that occur after the specified index in the current set.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.int32\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/Take.md",
"content": "SqlSet.Take Method\n==================\nReturns a specified number of contiguous elements from the start of the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic SqlSet Take(\n\tint count\n)\n```\n\n#### Parameters\n\n##### *count* [Int32][2]\nThe number of elements to return.\n\n#### Return Value\n[SqlSet][3] \nA new [SqlSet][3] that contains the specified number of elements from the start of the current set.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.int32\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/ToArray.md",
"content": "SqlSet.ToArray Method\n=====================\nCreates an array from the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic Object[] ToArray()\n```\n\n#### Return Value\n[Object][2][] \nAn array that contains the elements from the set.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/ToArrayAsync.md",
"content": "SqlSet.ToArrayAsync Method\n==========================\nCreates an array from the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic ValueTask ToArrayAsync(\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *cancellationToken* [CancellationToken][2] (Optional)\nThe [CancellationToken][2] to monitor for cancellation requests. The default is [None][3].\n\n#### Return Value\n[ValueTask][4]<[Object][5][]> \nAn array that contains the elements from the set.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[3]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[5]: https://learn.microsoft.com/dotnet/api/system.object\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/ToList.md",
"content": "SqlSet.ToList Method\n====================\nCreates a [List<T>][1] from the set.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic List ToList()\n```\n\n#### Return Value\n[List][1]<[Object][3]> \nA [List<T>][1] that contains elements from the set.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][4] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1\n[2]: ../README.md\n[3]: https://learn.microsoft.com/dotnet/api/system.object\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/ToListAsync.md",
"content": "SqlSet.ToListAsync Method\n=========================\nCreates a [List<T>][1] from the set.\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic ValueTask> ToListAsync(\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *cancellationToken* [CancellationToken][3] (Optional)\nThe [CancellationToken][3] to monitor for cancellation requests. The default is [None][4].\n\n#### Return Value\n[ValueTask][5]<[List][1]<[Object][6]>> \nA [List<T>][1] that contains elements from the set.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][7] \n[DbExtensions Namespace][2] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1\n[2]: ../README.md\n[3]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[6]: https://learn.microsoft.com/dotnet/api/system.object\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/ToString.md",
"content": "SqlSet.ToString Method\n======================\nReturns the SQL query of the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic override string ToString()\n```\n\n#### Return Value\n[String][2] \nThe SQL query of the set.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.string\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/Where.md",
"content": "SqlSet.Where(SqlSet.OperatorStringHandler) Method\n=================================================\nFilters the set based on a predicate.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------- | ------------------------------------- |\n| **Where(OperatorStringHandler)** | Filters the set based on a predicate. |\n| [Where(String)][2] | Filters the set based on a predicate. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlSet Where(\n\tref OperatorStringHandler predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[SqlSet][3] \nA new [SqlSet][3] that contains elements from the current set that satisfy the condition.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Where_1.md\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet/Where_1.md",
"content": "SqlSet.Where(String) Method\n===========================\nFilters the set based on a predicate.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------- | ------------------------------------- |\n| [Where(OperatorStringHandler)][2] | Filters the set based on a predicate. |\n| **Where(String)** | Filters the set based on a predicate. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlSet Where(\n\tstring predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][3]\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[SqlSet][4] \nA new [SqlSet][4] that contains elements from the current set that satisfy the condition.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Where.md\n[3]: https://learn.microsoft.com/dotnet/api/system.string\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/AsAsyncEnumerable.md",
"content": "SqlSet<TResult>.AsAsyncEnumerable Method\n===========================================\nGets all TResult objects in the set. The query is deferred-executed.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic IAsyncEnumerable AsAsyncEnumerable()\n```\n\n#### Return Value\n[IAsyncEnumerable][2]<[TResult][3]> \nAll TResult objects in the set.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.collections.generic.iasyncenumerable-1\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/AsEnumerable.md",
"content": "SqlSet<TResult>.AsEnumerable Method\n======================================\nGets all TResult objects in the set. The query is deferred-executed.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic IEnumerable AsEnumerable()\n```\n\n#### Return Value\n[IEnumerable][2]<[TResult][3]> \nAll TResult objects in the set.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/Contains.md",
"content": "SqlSet<TResult>.Contains(TResult) Method\n===========================================\nChecks the existance of the *entity*, using the primary key value.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------- | ------------------------------------------------------------------ |\n| [Contains(Object)][2] | Checks the existance of the *entity*, using the primary key value. |\n| **Contains(TResult)** | Checks the existance of the *entity*, using the primary key value. |\n\n\nSyntax\n------\n\n```csharp\npublic bool Contains(\n\tTResult entity\n)\n```\n\n#### Parameters\n\n##### *entity* [TResult][3]\nThe entity whose existance is to be checked.\n\n#### Return Value\n[Boolean][4] \n`true` if the primary key value exists in the database; otherwise, `false`.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | --------------------------------------------------------------------------------- |\n| [InvalidOperationException][5] | This method can only be used on sets where the result type is an annotated class. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: ../SqlSet/Contains.md\n[3]: README.md\n[4]: https://learn.microsoft.com/dotnet/api/system.boolean\n[5]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/ContainsAsync.md",
"content": "SqlSet<TResult>.ContainsAsync(TResult, CancellationToken) Method\n===================================================================\nChecks the existance of the *entity*, using the primary key value.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------- | ------------------------------------------------------------------ |\n| [ContainsAsync(Object, CancellationToken)][2] | Checks the existance of the *entity*, using the primary key value. |\n| **ContainsAsync(TResult, CancellationToken)** | Checks the existance of the *entity*, using the primary key value. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask ContainsAsync(\n\tTResult entity,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *entity* [TResult][3]\nThe entity whose existance is to be checked.\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]<[Boolean][7]> \n`true` if the primary key value exists in the database; otherwise, `false`.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | --------------------------------------------------------------------------------- |\n| [InvalidOperationException][8] | This method can only be used on sets where the result type is an annotated class. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: ../SqlSet/ContainsAsync.md\n[3]: README.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[7]: https://learn.microsoft.com/dotnet/api/system.boolean\n[8]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/Find.md",
"content": "SqlSet<TResult>.Find Method\n==============================\nGets the entity whose primary key matches the *id* parameter.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic TResult Find(\n\tObject id\n)\n```\n\n#### Parameters\n\n##### *id* [Object][2]\nThe primary key value.\n\n#### Return Value\n[TResult][3] \n The entity whose primary key matches the *id* parameter, or null if the *id* does not exist.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | --------------------------------------------------------------------------------- |\n| [InvalidOperationException][4] | This method can only be used on sets where the result type is an annotated class. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: README.md\n[4]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/FindAsync.md",
"content": "SqlSet<TResult>.FindAsync Method\n===================================\nGets the entity whose primary key matches the *id* parameter.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic ValueTask FindAsync(\n\tObject id,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *id* [Object][2]\nThe primary key value.\n\n##### *cancellationToken* [CancellationToken][3] (Optional)\nThe [CancellationToken][3] to monitor for cancellation requests. The default is [None][4].\n\n#### Return Value\n[ValueTask][5]<[TResult][6]> \n The entity whose primary key matches the *id* parameter, or null if the *id* does not exist.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | --------------------------------------------------------------------------------- |\n| [InvalidOperationException][7] | This method can only be used on sets where the result type is an annotated class. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[6]: README.md\n[7]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/First.md",
"content": "SqlSet<TResult>.First Method\n===============================\nReturns the first element of the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------- | -------------------------------------------------------------------------- |\n| **First()** | Returns the first element of the set. |\n| [First(OperatorStringHandler)][2] | Returns the first element in the set that satisfies a specified condition. |\n| [First(String)][3] | Returns the first element in the set that satisfies a specified condition. |\n\n\nSyntax\n------\n\n```csharp\npublic TResult First()\n```\n\n#### Return Value\n[TResult][4] \nThe first element in the set.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | ----------------- |\n| [InvalidOperationException][5] | The set is empty. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: First_1.md\n[3]: First_2.md\n[4]: README.md\n[5]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/FirstAsync.md",
"content": "SqlSet<TResult>.FirstAsync(SqlSet.OperatorStringHandler, CancellationToken) Method\n=====================================================================================\nReturns the first element in the set that satisfies a specified condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------------- | -------------------------------------------------------------------------- |\n| [FirstAsync(CancellationToken)][2] | Returns the first element of the set. |\n| **FirstAsync(OperatorStringHandler, CancellationToken)** | Returns the first element in the set that satisfies a specified condition. |\n| [FirstAsync(String, CancellationToken)][3] | Returns the first element in the set that satisfies a specified condition. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask FirstAsync(\n\tOperatorStringHandler predicate,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]<[TResult][7]> \nThe first element in the set that passes the test in the specified *predicate*.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | ----------------------------------------------------------------------- |\n| [InvalidOperationException][8] | No element satisfies the condition in *predicate*.-or-The set is empty. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: FirstAsync_2.md\n[3]: FirstAsync_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[7]: README.md\n[8]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/FirstAsync_1.md",
"content": "SqlSet<TResult>.FirstAsync(String, CancellationToken) Method\n===============================================================\nReturns the first element in the set that satisfies a specified condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------------- | -------------------------------------------------------------------------- |\n| [FirstAsync(CancellationToken)][2] | Returns the first element of the set. |\n| [FirstAsync(OperatorStringHandler, CancellationToken)][3] | Returns the first element in the set that satisfies a specified condition. |\n| **FirstAsync(String, CancellationToken)** | Returns the first element in the set that satisfies a specified condition. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask FirstAsync(\n\tstring predicate,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][4]\nA SQL expression to test each row for a condition.\n\n##### *cancellationToken* [CancellationToken][5] (Optional)\nThe [CancellationToken][5] to monitor for cancellation requests. The default is [None][6].\n\n#### Return Value\n[ValueTask][7]<[TResult][8]> \nThe first element in the set that passes the test in the specified *predicate*.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | ----------------------------------------------------------------------- |\n| [InvalidOperationException][9] | No element satisfies the condition in *predicate*.-or-The set is empty. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][8] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: FirstAsync_2.md\n[3]: FirstAsync.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[7]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[8]: README.md\n[9]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/FirstAsync_2.md",
"content": "SqlSet<TResult>.FirstAsync(CancellationToken) Method\n=======================================================\nReturns the first element of the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------------- | -------------------------------------------------------------------------- |\n| **FirstAsync(CancellationToken)** | Returns the first element of the set. |\n| [FirstAsync(OperatorStringHandler, CancellationToken)][2] | Returns the first element in the set that satisfies a specified condition. |\n| [FirstAsync(String, CancellationToken)][3] | Returns the first element in the set that satisfies a specified condition. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask FirstAsync(\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]<[TResult][7]> \nThe first element in the set.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | ----------------- |\n| [InvalidOperationException][8] | The set is empty. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: FirstAsync.md\n[3]: FirstAsync_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[7]: README.md\n[8]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/FirstOrDefault.md",
"content": "SqlSet<TResult>.FirstOrDefault Method\n========================================\nReturns the first element of the set, or a default value if the set contains no elements.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------ | --------------------------------------------------------------------------------------------------------------- |\n| **FirstOrDefault()** | Returns the first element of the set, or a default value if the set contains no elements. |\n| [FirstOrDefault(OperatorStringHandler)][2] | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n| [FirstOrDefault(String)][3] | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n\n\nSyntax\n------\n\n```csharp\npublic TResult FirstOrDefault()\n```\n\n#### Return Value\n[TResult][4] \nA default value if the set is empty; otherwise, the first element.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: FirstOrDefault_1.md\n[3]: FirstOrDefault_2.md\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/FirstOrDefaultAsync.md",
"content": "SqlSet<TResult>.FirstOrDefaultAsync(SqlSet.OperatorStringHandler, CancellationToken) Method\n==============================================================================================\nReturns the first element of the set that satisfies a condition or a default value if no such element is found.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |\n| [FirstOrDefaultAsync(CancellationToken)][2] | Returns the first element of the set, or a default value if the set contains no elements. |\n| **FirstOrDefaultAsync(OperatorStringHandler, CancellationToken)** | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n| [FirstOrDefaultAsync(String, CancellationToken)][3] | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask FirstOrDefaultAsync(\n\tOperatorStringHandler predicate,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]<[TResult][7]> \n A default value if the set is empty or if no element passes the test specified by *predicate*; otherwise, the first element that passes the test specified by *predicate*.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: FirstOrDefaultAsync_2.md\n[3]: FirstOrDefaultAsync_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/FirstOrDefaultAsync_1.md",
"content": "SqlSet<TResult>.FirstOrDefaultAsync(String, CancellationToken) Method\n========================================================================\nReturns the first element of the set that satisfies a condition or a default value if no such element is found.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- |\n| [FirstOrDefaultAsync(CancellationToken)][2] | Returns the first element of the set, or a default value if the set contains no elements. |\n| [FirstOrDefaultAsync(OperatorStringHandler, CancellationToken)][3] | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n| **FirstOrDefaultAsync(String, CancellationToken)** | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask FirstOrDefaultAsync(\n\tstring predicate,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][4]\nA SQL expression to test each row for a condition.\n\n##### *cancellationToken* [CancellationToken][5] (Optional)\nThe [CancellationToken][5] to monitor for cancellation requests. The default is [None][6].\n\n#### Return Value\n[ValueTask][7]<[TResult][8]> \n A default value if the set is empty or if no element passes the test specified by *predicate*; otherwise, the first element that passes the test specified by *predicate*.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][8] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: FirstOrDefaultAsync_2.md\n[3]: FirstOrDefaultAsync.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[7]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/FirstOrDefaultAsync_2.md",
"content": "SqlSet<TResult>.FirstOrDefaultAsync(CancellationToken) Method\n================================================================\nReturns the first element of the set, or a default value if the set contains no elements.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- |\n| **FirstOrDefaultAsync(CancellationToken)** | Returns the first element of the set, or a default value if the set contains no elements. |\n| [FirstOrDefaultAsync(OperatorStringHandler, CancellationToken)][2] | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n| [FirstOrDefaultAsync(String, CancellationToken)][3] | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask FirstOrDefaultAsync(\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]<[TResult][7]> \nA default value if the set is empty; otherwise, the first element.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: FirstOrDefaultAsync.md\n[3]: FirstOrDefaultAsync_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/FirstOrDefault_1.md",
"content": "SqlSet<TResult>.FirstOrDefault(SqlSet.OperatorStringHandler) Method\n======================================================================\nReturns the first element of the set that satisfies a condition or a default value if no such element is found.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------- | --------------------------------------------------------------------------------------------------------------- |\n| [FirstOrDefault()][2] | Returns the first element of the set, or a default value if the set contains no elements. |\n| **FirstOrDefault(OperatorStringHandler)** | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n| [FirstOrDefault(String)][3] | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n\n\nSyntax\n------\n\n```csharp\npublic TResult FirstOrDefault(\n\tref OperatorStringHandler? predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[TResult][4] \n A default value if the set is empty or if no element passes the test specified by *predicate*; otherwise, the first element that passes the test specified by *predicate*.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: FirstOrDefault.md\n[3]: FirstOrDefault_2.md\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/FirstOrDefault_2.md",
"content": "SqlSet<TResult>.FirstOrDefault(String) Method\n================================================\nReturns the first element of the set that satisfies a condition or a default value if no such element is found.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------ | --------------------------------------------------------------------------------------------------------------- |\n| [FirstOrDefault()][2] | Returns the first element of the set, or a default value if the set contains no elements. |\n| [FirstOrDefault(OperatorStringHandler)][3] | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n| **FirstOrDefault(String)** | Returns the first element of the set that satisfies a condition or a default value if no such element is found. |\n\n\nSyntax\n------\n\n```csharp\npublic TResult FirstOrDefault(\n\tstring predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][4]\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[TResult][5] \n A default value if the set is empty or if no element passes the test specified by *predicate*; otherwise, the first element that passes the test specified by *predicate*.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: FirstOrDefault.md\n[3]: FirstOrDefault_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/First_1.md",
"content": "SqlSet<TResult>.First(SqlSet.OperatorStringHandler) Method\n=============================================================\nReturns the first element in the set that satisfies a specified condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------- | -------------------------------------------------------------------------- |\n| [First()][2] | Returns the first element of the set. |\n| **First(OperatorStringHandler)** | Returns the first element in the set that satisfies a specified condition. |\n| [First(String)][3] | Returns the first element in the set that satisfies a specified condition. |\n\n\nSyntax\n------\n\n```csharp\npublic TResult First(\n\tref OperatorStringHandler predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[TResult][4] \nThe first element in the set that passes the test in the specified *predicate*.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | ----------------------------------------------------------------------- |\n| [InvalidOperationException][5] | No element satisfies the condition in *predicate*.-or-The set is empty. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: First.md\n[3]: First_2.md\n[4]: README.md\n[5]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/First_2.md",
"content": "SqlSet<TResult>.First(String) Method\n=======================================\nReturns the first element in the set that satisfies a specified condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------- | -------------------------------------------------------------------------- |\n| [First()][2] | Returns the first element of the set. |\n| [First(OperatorStringHandler)][3] | Returns the first element in the set that satisfies a specified condition. |\n| **First(String)** | Returns the first element in the set that satisfies a specified condition. |\n\n\nSyntax\n------\n\n```csharp\npublic TResult First(\n\tstring predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][4]\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[TResult][5] \nThe first element in the set that passes the test in the specified *predicate*.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | ----------------------------------------------------------------------- |\n| [InvalidOperationException][6] | No element satisfies the condition in *predicate*.-or-The set is empty. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: First.md\n[3]: First_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: README.md\n[6]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/GetAsyncEnumerator.md",
"content": "SqlSet<TResult>.GetAsyncEnumerator Method\n============================================\nReturns an async enumerator that iterates through the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic IAsyncEnumerator GetAsyncEnumerator(\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *cancellationToken* [CancellationToken][2] (Optional)\nThe [CancellationToken][2] to monitor for cancellation requests. The default is [None][3].\n\n#### Return Value\n[IAsyncEnumerator][4]<[TResult][5]> \nA [IAsyncEnumerator<T>][4] for the set.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[3]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[4]: https://learn.microsoft.com/dotnet/api/system.collections.generic.iasyncenumerator-1\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/GetEnumerator.md",
"content": "SqlSet<TResult>.GetEnumerator Method\n=======================================\nReturns an enumerator that iterates through the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic IEnumerator GetEnumerator()\n```\n\n#### Return Value\n[IEnumerator][2]<[TResult][3]> \nA [IEnumerator<T>][2] for the set.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerator-1\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/Include.md",
"content": "SqlSet<TResult>.Include(Func<TResult, Object>, String) Method\n===================================================================\nSpecifies the related objects to include in the query results.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------- | -------------------------------------------------------------- |\n| [Include(String)][2] | Specifies the related objects to include in the query results. |\n| **Include(Func<TResult, Object>, String)** | Specifies the related objects to include in the query results. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlSet Include(\n\tFunc path,\n\tstring pathExpr = \"\"\n)\n```\n\n#### Parameters\n\n##### *path* [Func][3]<[TResult][4], [Object][5]>\nLambda expression that returns the deepest related object to return in the query results.\n\n##### *pathExpr* [String][6] (Optional)\nThis argument is compiler generated.\n\n#### Return Value\n[SqlSet][4]<[TResult][4]> \nA new [SqlSet<TResult>][4] with the defined query path.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | --------------------------------------------------------------------------------- |\n| [InvalidOperationException][7] | This method can only be used on sets where the result type is an annotated class. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Include_1.md\n[3]: https://learn.microsoft.com/dotnet/api/system.func-2\n[4]: README.md\n[5]: https://learn.microsoft.com/dotnet/api/system.object\n[6]: https://learn.microsoft.com/dotnet/api/system.string\n[7]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/IncludeMany.md",
"content": "SqlSet<TResult>.IncludeMany(String, Func<SqlSet, SqlSet>) Method\n======================================================================\nSpecifies which collections to include in the query results.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------ |\n| **IncludeMany(String, Func<SqlSet, SqlSet>)** | Specifies which collections to include in the query results. |\n| [IncludeMany<TElement>(Func<TResult, ICollection<TElement>>, Func<SqlSet<TElement>, SqlSet<TElement>>, String)][2] | Specifies which collections to include in the query results. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlSet IncludeMany(\n\tstring path,\n\tFunc? manySetup = null\n)\n```\n\n#### Parameters\n\n##### *path* [String][3]\nDot-separated list of one or more related objects that ends with the collection to load.\n\n##### *manySetup* [Func][4]<[SqlSet][5], [SqlSet][5]> (Optional)\nA function to customize how the collection is loaded.\n\n#### Return Value\n[SqlSet][6]<[TResult][6]> \nA new [SqlSet<TResult>][6].\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | --------------------------------------------------------------------------------- |\n| [InvalidOperationException][7] | This method can only be used on sets where the result type is an annotated class. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: IncludeMany__1.md\n[3]: https://learn.microsoft.com/dotnet/api/system.string\n[4]: https://learn.microsoft.com/dotnet/api/system.func-2\n[5]: ../SqlSet/README.md\n[6]: README.md\n[7]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/IncludeMany__1.md",
"content": "SqlSet<TResult>.IncludeMany<TElement>(Func<TResult, ICollection<TElement>>, Func<SqlSet<TElement>, SqlSet<TElement>>, String) Method\n=========================================================================================================================================================\nSpecifies which collections to include in the query results.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |\n| [IncludeMany(String, Func<SqlSet, SqlSet>)][2] | Specifies which collections to include in the query results. |\n| **IncludeMany<TElement>(Func<TResult, ICollection<TElement>>, Func<SqlSet<TElement>, SqlSet<TElement>>, String)** | Specifies which collections to include in the query results. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlSet IncludeMany(\n\tFunc?> path,\n\tFunc, SqlSet>? manySetup = null,\n\tstring pathExpr = \"\"\n)\n\n```\n\n#### Parameters\n\n##### *path* [Func][3]<[TResult][4], [ICollection][5]<**TElement**>>\nLambda expression that returns the collection to load.\n\n##### *manySetup* [Func][3]<[SqlSet][4]<**TElement**>, [SqlSet][4]<**TElement**>> (Optional)\nA function to customize how the collection is loaded.\n\n##### *pathExpr* [String][6] (Optional)\nThis argument is compiler generated.\n\n#### Type Parameters\n\n##### *TElement*\nThe type of objects the collection holds.\n\n#### Return Value\n[SqlSet][4]<[TResult][4]> \nA new [SqlSet<TResult>][4].\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | --------------------------------------------------------------------------------- |\n| [InvalidOperationException][7] | This method can only be used on sets where the result type is an annotated class. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: IncludeMany.md\n[3]: https://learn.microsoft.com/dotnet/api/system.func-2\n[4]: README.md\n[5]: https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1\n[6]: https://learn.microsoft.com/dotnet/api/system.string\n[7]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/Include_1.md",
"content": "SqlSet<TResult>.Include(String) Method\n=========================================\nSpecifies the related objects to include in the query results.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------- | -------------------------------------------------------------- |\n| **Include(String)** | Specifies the related objects to include in the query results. |\n| [Include(Func<TResult, Object>, String)][2] | Specifies the related objects to include in the query results. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlSet Include(\n\tstring path\n)\n```\n\n#### Parameters\n\n##### *path* [String][3]\nDot-separated list of related objects to return in the query results.\n\n#### Return Value\n[SqlSet][4]<[TResult][4]> \nA new [SqlSet<TResult>][4] with the defined query path.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | --------------------------------------------------------------------------------- |\n| [InvalidOperationException][5] | This method can only be used on sets where the result type is an annotated class. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Include.md\n[3]: https://learn.microsoft.com/dotnet/api/system.string\n[4]: README.md\n[5]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/OrderBy.md",
"content": "SqlSet<TResult>.OrderBy(SqlSet.OperatorStringHandler) Method\n===============================================================\nSorts the elements of the set according to the *columnList*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------- | ------------------------------------------------------------ |\n| **OrderBy(OperatorStringHandler)** | Sorts the elements of the set according to the *columnList*. |\n| [OrderBy(String)][2] | Sorts the elements of the set according to the *columnList*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlSet OrderBy(\n\tref OperatorStringHandler columnList\n)\n```\n\n#### Parameters\n\n##### *columnList* OperatorStringHandler\nThe list of columns to base the sort on.\n\n#### Return Value\n[SqlSet][3]<[TResult][3]> \nA new [SqlSet<TResult>][3] whose elements are sorted according to *columnList*.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: OrderBy_1.md\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/OrderBy_1.md",
"content": "SqlSet<TResult>.OrderBy(String) Method\n=========================================\nSorts the elements of the set according to the *columnList*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------- | ------------------------------------------------------------ |\n| [OrderBy(OperatorStringHandler)][2] | Sorts the elements of the set according to the *columnList*. |\n| **OrderBy(String)** | Sorts the elements of the set according to the *columnList*. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlSet OrderBy(\n\tstring columnList\n)\n```\n\n#### Parameters\n\n##### *columnList* [String][3]\nThe list of columns to base the sort on.\n\n#### Return Value\n[SqlSet][4]<[TResult][4]> \nA new [SqlSet<TResult>][4] whose elements are sorted according to *columnList*.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: OrderBy.md\n[3]: https://learn.microsoft.com/dotnet/api/system.string\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/README.md",
"content": "SqlSet<TResult> Class\n========================\nRepresents an immutable, connected SQL query that maps to TResult objects. This class cannot be instantiated, to get an instance use one of the [Database.From<TResult>(String)][1] or [Database.FromQuery<TResult>(SqlBuilder)][2] overloads.\n\n\nInheritance Hierarchy\n---------------------\n[System.Object][3] \n [DbExtensions.SqlSet][4] \n **DbExtensions.SqlSet<TResult>** \n [DbExtensions.SqlTable<TEntity>][5] \n \n**Namespace:** [DbExtensions][6] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic class SqlSet : SqlSet\n\n```\n\n#### Type Parameters\n\n##### *TResult*\nThe type of objects to map the results to.\n\nThe **SqlSet<TResult>** type exposes the following members.\n\n\nProperties\n----------\n\n| Name | Description |\n| --------------- | -------------------------------------------------------------------------------------------------- |\n| [Database][7] | The [Database][8] this set is connected to. SingleAsync(\n\tOperatorStringHandler predicate,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]<[TResult][7]> \nThe single element of the set that passes the test in the specified *predicate*.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |\n| [InvalidOperationException][8] | No element satisfies the condition in *predicate*.-or-More than one element satisfies the condition in *predicate*.-or-The set is empty. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: SingleAsync_2.md\n[3]: SingleAsync_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[7]: README.md\n[8]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/SingleAsync_1.md",
"content": "SqlSet<TResult>.SingleAsync(String, CancellationToken) Method\n================================================================\nReturns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| [SingleAsync(CancellationToken)][2] | The single element of the set. |\n| [SingleAsync(OperatorStringHandler, CancellationToken)][3] | Returns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists. |\n| **SingleAsync(String, CancellationToken)** | Returns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask SingleAsync(\n\tstring predicate,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][4]\nA SQL expression to test each row for a condition.\n\n##### *cancellationToken* [CancellationToken][5] (Optional)\nThe [CancellationToken][5] to monitor for cancellation requests. The default is [None][6].\n\n#### Return Value\n[ValueTask][7]<[TResult][8]> \nThe single element of the set that passes the test in the specified *predicate*.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |\n| [InvalidOperationException][9] | No element satisfies the condition in *predicate*.-or-More than one element satisfies the condition in *predicate*.-or-The set is empty. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][8] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: SingleAsync_2.md\n[3]: SingleAsync.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[7]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[8]: README.md\n[9]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/SingleAsync_2.md",
"content": "SqlSet<TResult>.SingleAsync(CancellationToken) Method\n========================================================\nThe single element of the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| **SingleAsync(CancellationToken)** | The single element of the set. |\n| [SingleAsync(OperatorStringHandler, CancellationToken)][2] | Returns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists. |\n| [SingleAsync(String, CancellationToken)][3] | Returns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask SingleAsync(\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]<[TResult][7]> \nThe single element of the set.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | ------------------------------------------------------------ |\n| [InvalidOperationException][8] | The set contains more than one element.-or-The set is empty. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: SingleAsync.md\n[3]: SingleAsync_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[7]: README.md\n[8]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/SingleOrDefault.md",
"content": "SqlSet<TResult>.SingleOrDefault Method\n=========================================\nReturns the only element of the set, or a default value if the set is empty; this method throws an exception if there is more than one element in the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **SingleOrDefault()** | Returns the only element of the set, or a default value if the set is empty; this method throws an exception if there is more than one element in the set. |\n| [SingleOrDefault(OperatorStringHandler)][2] | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n| [SingleOrDefault(String)][3] | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n\n\nSyntax\n------\n\n```csharp\npublic TResult SingleOrDefault()\n```\n\n#### Return Value\n[TResult][4] \nThe single element of the set, or a default value if the set contains no elements.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | --------------------------------------- |\n| [InvalidOperationException][5] | The set contains more than one element. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: SingleOrDefault_1.md\n[3]: SingleOrDefault_2.md\n[4]: README.md\n[5]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/SingleOrDefaultAsync.md",
"content": "SqlSet<TResult>.SingleOrDefaultAsync(SqlSet.OperatorStringHandler, CancellationToken) Method\n===============================================================================================\nReturns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [SingleOrDefaultAsync(CancellationToken)][2] | Returns the only element of the set, or a default value if the set is empty; this method throws an exception if there is more than one element in the set. |\n| **SingleOrDefaultAsync(OperatorStringHandler, CancellationToken)** | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n| [SingleOrDefaultAsync(String, CancellationToken)][3] | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask SingleOrDefaultAsync(\n\tOperatorStringHandler predicate,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]<[TResult][7]> \nThe single element of the set that satisfies the condition, or a default value if no such element is found.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: SingleOrDefaultAsync_2.md\n[3]: SingleOrDefaultAsync_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/SingleOrDefaultAsync_1.md",
"content": "SqlSet<TResult>.SingleOrDefaultAsync(String, CancellationToken) Method\n=========================================================================\nReturns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [SingleOrDefaultAsync(CancellationToken)][2] | Returns the only element of the set, or a default value if the set is empty; this method throws an exception if there is more than one element in the set. |\n| [SingleOrDefaultAsync(OperatorStringHandler, CancellationToken)][3] | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n| **SingleOrDefaultAsync(String, CancellationToken)** | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask SingleOrDefaultAsync(\n\tstring predicate,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][4]\nA SQL expression to test each row for a condition.\n\n##### *cancellationToken* [CancellationToken][5] (Optional)\nThe [CancellationToken][5] to monitor for cancellation requests. The default is [None][6].\n\n#### Return Value\n[ValueTask][7]<[TResult][8]> \nThe single element of the set that satisfies the condition, or a default value if no such element is found.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][8] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: SingleOrDefaultAsync_2.md\n[3]: SingleOrDefaultAsync.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[7]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/SingleOrDefaultAsync_2.md",
"content": "SqlSet<TResult>.SingleOrDefaultAsync(CancellationToken) Method\n=================================================================\nReturns the only element of the set, or a default value if the set is empty; this method throws an exception if there is more than one element in the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **SingleOrDefaultAsync(CancellationToken)** | Returns the only element of the set, or a default value if the set is empty; this method throws an exception if there is more than one element in the set. |\n| [SingleOrDefaultAsync(OperatorStringHandler, CancellationToken)][2] | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n| [SingleOrDefaultAsync(String, CancellationToken)][3] | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask SingleOrDefaultAsync(\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]<[TResult][7]> \nThe single element of the set, or a default value if the set contains no elements.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | --------------------------------------- |\n| [InvalidOperationException][8] | The set contains more than one element. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: SingleOrDefaultAsync.md\n[3]: SingleOrDefaultAsync_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[7]: README.md\n[8]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/SingleOrDefault_1.md",
"content": "SqlSet<TResult>.SingleOrDefault(SqlSet.OperatorStringHandler) Method\n=======================================================================\nReturns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [SingleOrDefault()][2] | Returns the only element of the set, or a default value if the set is empty; this method throws an exception if there is more than one element in the set. |\n| **SingleOrDefault(OperatorStringHandler)** | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n| [SingleOrDefault(String)][3] | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n\n\nSyntax\n------\n\n```csharp\npublic TResult SingleOrDefault(\n\tref OperatorStringHandler? predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[TResult][4] \nThe single element of the set that satisfies the condition, or a default value if no such element is found.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: SingleOrDefault.md\n[3]: SingleOrDefault_2.md\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/SingleOrDefault_2.md",
"content": "SqlSet<TResult>.SingleOrDefault(String) Method\n=================================================\nReturns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [SingleOrDefault()][2] | Returns the only element of the set, or a default value if the set is empty; this method throws an exception if there is more than one element in the set. |\n| [SingleOrDefault(OperatorStringHandler)][3] | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n| **SingleOrDefault(String)** | Returns the only element of the set that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. |\n\n\nSyntax\n------\n\n```csharp\npublic TResult SingleOrDefault(\n\tstring predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][4]\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[TResult][5] \nThe single element of the set that satisfies the condition, or a default value if no such element is found.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: SingleOrDefault.md\n[3]: SingleOrDefault_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/Single_1.md",
"content": "SqlSet<TResult>.Single(SqlSet.OperatorStringHandler) Method\n==============================================================\nReturns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| [Single()][2] | The single element of the set. |\n| **Single(OperatorStringHandler)** | Returns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists. |\n| [Single(String)][3] | Returns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists. |\n\n\nSyntax\n------\n\n```csharp\npublic TResult Single(\n\tref OperatorStringHandler predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[TResult][4] \nThe single element of the set that passes the test in the specified *predicate*.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |\n| [InvalidOperationException][5] | No element satisfies the condition in *predicate*.-or-More than one element satisfies the condition in *predicate*.-or-The set is empty. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Single.md\n[3]: Single_2.md\n[4]: README.md\n[5]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/Single_2.md",
"content": "SqlSet<TResult>.Single(String) Method\n========================================\nReturns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| [Single()][2] | The single element of the set. |\n| [Single(OperatorStringHandler)][3] | Returns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists. |\n| **Single(String)** | Returns the only element of the set that satisfies a specified condition, and throws an exception if more than one such element exists. |\n\n\nSyntax\n------\n\n```csharp\npublic TResult Single(\n\tstring predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][4]\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[TResult][5] \nThe single element of the set that passes the test in the specified *predicate*.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |\n| [InvalidOperationException][6] | No element satisfies the condition in *predicate*.-or-More than one element satisfies the condition in *predicate*.-or-The set is empty. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Single.md\n[3]: Single_1.md\n[4]: https://learn.microsoft.com/dotnet/api/system.string\n[5]: README.md\n[6]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/Skip.md",
"content": "SqlSet<TResult>.Skip Method\n==============================\nBypasses a specified number of elements in the set and then returns the remaining elements.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic SqlSet Skip(\n\tint count\n)\n```\n\n#### Parameters\n\n##### *count* [Int32][2]\nThe number of elements to skip before returning the remaining elements.\n\n#### Return Value\n[SqlSet][3]<[TResult][3]> \nA new [SqlSet<TResult>][3] that contains the elements that occur after the specified index in the current set.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.int32\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/Take.md",
"content": "SqlSet<TResult>.Take Method\n==============================\nReturns a specified number of contiguous elements from the start of the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic SqlSet Take(\n\tint count\n)\n```\n\n#### Parameters\n\n##### *count* [Int32][2]\nThe number of elements to return.\n\n#### Return Value\n[SqlSet][3]<[TResult][3]> \nA new [SqlSet<TResult>][3] that contains the specified number of elements from the start of the current set.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.int32\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/ToArray.md",
"content": "SqlSet<TResult>.ToArray Method\n=================================\nCreates an array from the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic TResult[] ToArray()\n```\n\n#### Return Value\n[TResult][2][] \nAn array that contains the elements from the set.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][2] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/ToArrayAsync.md",
"content": "SqlSet<TResult>.ToArrayAsync Method\n======================================\nCreates an array from the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic ValueTask ToArrayAsync(\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *cancellationToken* [CancellationToken][2] (Optional)\nThe [CancellationToken][2] to monitor for cancellation requests. The default is [None][3].\n\n#### Return Value\n[ValueTask][4]<[TResult][5][]> \nAn array that contains the elements from the set.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[3]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/ToList.md",
"content": "SqlSet<TResult>.ToList Method\n================================\nCreates a List<TResult> from the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic List ToList()\n```\n\n#### Return Value\n[List][2]<[TResult][3]> \nA List<TResult> that contains elements from the set.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/ToListAsync.md",
"content": "SqlSet<TResult>.ToListAsync Method\n=====================================\nCreates a List<TResult> from the set.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic ValueTask> ToListAsync(\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *cancellationToken* [CancellationToken][2] (Optional)\nThe [CancellationToken][2] to monitor for cancellation requests. The default is [None][3].\n\n#### Return Value\n[ValueTask][4]<[List][5]<[TResult][6]>> \nA List<TResult> that contains elements from the set.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[3]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[5]: https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/Where.md",
"content": "SqlSet<TResult>.Where(SqlSet.OperatorStringHandler) Method\n=============================================================\nFilters the set based on a predicate.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------- | ------------------------------------- |\n| **Where(OperatorStringHandler)** | Filters the set based on a predicate. |\n| [Where(String)][2] | Filters the set based on a predicate. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlSet Where(\n\tref OperatorStringHandler predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* OperatorStringHandler\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[SqlSet][3]<[TResult][3]> \nA new [SqlSet<TResult>][3] that contains elements from the current set that satisfy the condition.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Where_1.md\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlSet_1/Where_1.md",
"content": "SqlSet<TResult>.Where(String) Method\n=======================================\nFilters the set based on a predicate.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------- | ------------------------------------- |\n| [Where(OperatorStringHandler)][2] | Filters the set based on a predicate. |\n| **Where(String)** | Filters the set based on a predicate. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlSet Where(\n\tstring predicate\n)\n```\n\n#### Parameters\n\n##### *predicate* [String][3]\nA SQL expression to test each row for a condition.\n\n#### Return Value\n[SqlSet][4]<[TResult][4]> \nA new [SqlSet<TResult>][4] that contains elements from the current set that satisfy the condition.\n\nSee Also\n--------\n\n#### Reference\n[SqlSet<TResult> Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Where.md\n[3]: https://learn.microsoft.com/dotnet/api/system.string\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable/Add.md",
"content": "SqlTable.Add Method\n===================\nRecursively executes INSERT commands for the specified *entity* and all its one-to-one and one-to-many associations.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic void Add(\n\tObject entity\n)\n```\n\n#### Parameters\n\n##### *entity* [Object][2]\nThe object whose INSERT command is to be executed. This parameter is named entity for consistency with the other CRUD methods, but in this case it doesn't need to be an actual entity, which means it doesn't need to have a primary key.\n\n\nSee Also\n--------\n\n#### Reference\n[SqlTable Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable/AddAsync.md",
"content": "SqlTable.AddAsync Method\n========================\nRecursively executes INSERT commands for the specified *entity* and all its one-to-one and one-to-many associations.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic ValueTask AddAsync(\n\tObject entity,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *entity* [Object][2]\nThe object whose INSERT command is to be executed. This parameter is named entity for consistency with the other CRUD methods, but in this case it doesn't need to be an actual entity, which means it doesn't need to have a primary key.\n\n##### *cancellationToken* [CancellationToken][3] (Optional)\nThe [CancellationToken][3] to monitor for cancellation requests. The default is [None][4].\n\n#### Return Value\n[ValueTask][5]\n\nSee Also\n--------\n\n#### Reference\n[SqlTable Class][6] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask\n[6]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable/AddRange.md",
"content": "SqlTable.AddRange(IEnumerable<Object>) Method\n================================================\nRecursively executes INSERT commands for the specified *entities* and all their one-to-one and one-to-many associations.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |\n| **AddRange(IEnumerable<Object>)** | Recursively executes INSERT commands for the specified *entities* and all their one-to-one and one-to-many associations. |\n| [AddRange(Object[])][2] | Recursively executes INSERT commands for the specified *entities* and all their one-to-one and one-to-many associations. |\n\n\nSyntax\n------\n\n```csharp\npublic void AddRange(\n\tIEnumerable entities\n)\n```\n\n#### Parameters\n\n##### *entities* [IEnumerable][3]<[Object][4]>\nThe entities whose INSERT commands are to be executed.\n\n\nSee Also\n--------\n\n#### Reference\n[SqlTable Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: AddRange_1.md\n[3]: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1\n[4]: https://learn.microsoft.com/dotnet/api/system.object\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable/AddRangeAsync.md",
"content": "SqlTable.AddRangeAsync(IEnumerable<Object>, CancellationToken) Method\n========================================================================\nRecursively executes INSERT commands for the specified *entities* and all their one-to-one and one-to-many associations.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |\n| [AddRangeAsync(Object[])][2] | Recursively executes INSERT commands for the specified *entities* and all their one-to-one and one-to-many associations. |\n| **AddRangeAsync(IEnumerable<Object>, CancellationToken)** | Recursively executes INSERT commands for the specified *entities* and all their one-to-one and one-to-many associations. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask AddRangeAsync(\n\tIEnumerable entities,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *entities* [IEnumerable][3]<[Object][4]>\nThe entities whose INSERT commands are to be executed.\n\n##### *cancellationToken* [CancellationToken][5] (Optional)\nThe [CancellationToken][5] to monitor for cancellation requests. The default is [None][6].\n\n#### Return Value\n[ValueTask][7]\n\nSee Also\n--------\n\n#### Reference\n[SqlTable Class][8] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: AddRangeAsync_1.md\n[3]: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1\n[4]: https://learn.microsoft.com/dotnet/api/system.object\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[7]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable/AddRangeAsync_1.md",
"content": "SqlTable.AddRangeAsync(Object[]) Method\n=======================================\nRecursively executes INSERT commands for the specified *entities* and all their one-to-one and one-to-many associations.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |\n| **AddRangeAsync(Object[])** | Recursively executes INSERT commands for the specified *entities* and all their one-to-one and one-to-many associations. |\n| [AddRangeAsync(IEnumerable<Object>, CancellationToken)][2] | Recursively executes INSERT commands for the specified *entities* and all their one-to-one and one-to-many associations. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask AddRangeAsync(\n\tparams Object[] entities\n)\n```\n\n#### Parameters\n\n##### *entities* [Object][3][]\nThe entities whose INSERT commands are to be executed.\n\n#### Return Value\n[ValueTask][4]\n\nSee Also\n--------\n\n#### Reference\n[SqlTable Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: AddRangeAsync.md\n[3]: https://learn.microsoft.com/dotnet/api/system.object\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable/AddRange_1.md",
"content": "SqlTable.AddRange(Object[]) Method\n==================================\nRecursively executes INSERT commands for the specified *entities* and all their one-to-one and one-to-many associations.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |\n| [AddRange(IEnumerable<Object>)][2] | Recursively executes INSERT commands for the specified *entities* and all their one-to-one and one-to-many associations. |\n| **AddRange(Object[])** | Recursively executes INSERT commands for the specified *entities* and all their one-to-one and one-to-many associations. |\n\n\nSyntax\n------\n\n```csharp\npublic void AddRange(\n\tparams Object[] entities\n)\n```\n\n#### Parameters\n\n##### *entities* [Object][3][]\nThe entities whose INSERT commands are to be executed.\n\n\nSee Also\n--------\n\n#### Reference\n[SqlTable Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: AddRange.md\n[3]: https://learn.microsoft.com/dotnet/api/system.object\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable/Cast__1.md",
"content": "SqlTable.Cast<TEntity> Method\n================================\nCasts the current [SqlTable][1] to the generic [SqlTable<TEntity>][2] instance.\n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------- | ---------------------------------------------------------------------------------- |\n| [Cast(Type)][4] | Casts the elements of the set to the specified type. |\n| **Cast<TEntity>()** | Casts the current [SqlTable][1] to the generic [SqlTable<TEntity>][2] instance. |\n\n\nSyntax\n------\n\n```csharp\npublic SqlTable Cast()\nwhere TEntity : class\n\n```\n\n#### Type Parameters\n\n##### *TEntity*\nThe type of the entity.\n\n#### Return Value\n[SqlTable][2]<**TEntity**> \nThe [SqlTable<TEntity>][2] instance for TEntity.\n\nExceptions\n----------\n\n| Exception | Condition |\n| ------------------------------ | ----------------------------------------------------- |\n| [InvalidOperationException][5] | The specified TEntity is not valid for this instance. |\n\n\nSee Also\n--------\n\n#### Reference\n[SqlTable Class][1] \n[DbExtensions Namespace][3] \n\n[1]: README.md\n[2]: ../SqlTable_1/README.md\n[3]: ../README.md\n[4]: ../SqlSet/Cast.md\n[5]: https://learn.microsoft.com/dotnet/api/system.invalidoperationexception"
},
{
"path": "docs/api/DbExtensions/SqlTable/Name.md",
"content": "SqlTable.Name Property\n======================\nGets the name of the table.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic string Name { get; }\n```\n\n#### Property Value\n[String][2]\n\nSee Also\n--------\n\n#### Reference\n[SqlTable Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.string\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable/README.md",
"content": "SqlTable Class\n==============\nA non-generic version of [SqlTable<TEntity>][1] which can be used when the type of the entity is not known at build time. This class cannot be instantiated, to get an instance use the [Database.Table(Type)][2] method.\n\n\nInheritance Hierarchy\n---------------------\n[System.Object][3] \n [DbExtensions.SqlSet][4] \n **DbExtensions.SqlTable** \n \n**Namespace:** [DbExtensions][5] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic sealed class SqlTable : SqlSet\n```\n\nThe **SqlTable** type exposes the following members.\n\n\nProperties\n----------\n\n| Name | Description |\n| --------------- | -------------------------------------------------------------------------------------------------- |\n| [Database][6] | The [Database][7] this set is connected to. RemoveAsync(\n\tObject entity,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *entity* [Object][2]\nThe entity whose DELETE command is to be executed.\n\n##### *cancellationToken* [CancellationToken][3] (Optional)\nThe [CancellationToken][3] to monitor for cancellation requests. The default is [None][4].\n\n#### Return Value\n[ValueTask][5]<[Boolean][6]> \n`true` if *entity* is deleted; otherwise, `false`.\n\nSee Also\n--------\n\n#### Reference\n[SqlTable Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[6]: https://learn.microsoft.com/dotnet/api/system.boolean\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable/RemoveKey.md",
"content": "SqlTable.RemoveKey Method\n=========================\nExecutes a DELETE command for the entity whose primary key matches the *id* parameter.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic bool RemoveKey(\n\tObject id\n)\n```\n\n#### Parameters\n\n##### *id* [Object][2]\nThe primary key value.\n\n#### Return Value\n[Boolean][3] \n`true` if a record that matches *id* was found and deleted; otherwise, `false`.\n\nSee Also\n--------\n\n#### Reference\n[SqlTable Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: https://learn.microsoft.com/dotnet/api/system.boolean\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable/RemoveKeyAsync.md",
"content": "SqlTable.RemoveKeyAsync Method\n==============================\nExecutes a DELETE command for the entity whose primary key matches the *id* parameter.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic ValueTask RemoveKeyAsync(\n\tObject id,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *id* [Object][2]\nThe primary key value.\n\n##### *cancellationToken* [CancellationToken][3] (Optional)\nThe [CancellationToken][3] to monitor for cancellation requests. The default is [None][4].\n\n#### Return Value\n[ValueTask][5]<[Boolean][6]> \n`true` if a record that matches *id* was found and deleted; otherwise, `false`.\n\nSee Also\n--------\n\n#### Reference\n[SqlTable Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[6]: https://learn.microsoft.com/dotnet/api/system.boolean\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable/RemoveRange.md",
"content": "SqlTable.RemoveRange(IEnumerable<Object>) Method\n===================================================\nExecutes DELETE commands for the specified *entities*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------- | ------------------------------------------------------ |\n| **RemoveRange(IEnumerable<Object>)** | Executes DELETE commands for the specified *entities*. |\n| [RemoveRange(Object[])][2] | Executes DELETE commands for the specified *entities*. |\n\n\nSyntax\n------\n\n```csharp\npublic void RemoveRange(\n\tIEnumerable entities\n)\n```\n\n#### Parameters\n\n##### *entities* [IEnumerable][3]<[Object][4]>\nThe entities whose DELETE commands are to be executed.\n\n\nSee Also\n--------\n\n#### Reference\n[SqlTable Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: RemoveRange_1.md\n[3]: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1\n[4]: https://learn.microsoft.com/dotnet/api/system.object\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable/RemoveRangeAsync.md",
"content": "SqlTable.RemoveRangeAsync(IEnumerable<Object>, CancellationToken) Method\n===========================================================================\nExecutes DELETE commands for the specified *entities*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------------------- | ------------------------------------------------------ |\n| [RemoveRangeAsync(Object[])][2] | Executes DELETE commands for the specified *entities*. |\n| **RemoveRangeAsync(IEnumerable<Object>, CancellationToken)** | Executes DELETE commands for the specified *entities*. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask RemoveRangeAsync(\n\tIEnumerable entities,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *entities* [IEnumerable][3]<[Object][4]>\nThe entities whose DELETE commands are to be executed.\n\n##### *cancellationToken* [CancellationToken][5] (Optional)\nThe [CancellationToken][5] to monitor for cancellation requests. The default is [None][6].\n\n#### Return Value\n[ValueTask][7]\n\nSee Also\n--------\n\n#### Reference\n[SqlTable Class][8] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: RemoveRangeAsync_1.md\n[3]: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1\n[4]: https://learn.microsoft.com/dotnet/api/system.object\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[7]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable/RemoveRangeAsync_1.md",
"content": "SqlTable.RemoveRangeAsync(Object[]) Method\n==========================================\nExecutes DELETE commands for the specified *entities*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------------------- | ------------------------------------------------------ |\n| **RemoveRangeAsync(Object[])** | Executes DELETE commands for the specified *entities*. |\n| [RemoveRangeAsync(IEnumerable<Object>, CancellationToken)][2] | Executes DELETE commands for the specified *entities*. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask RemoveRangeAsync(\n\tparams Object[] entities\n)\n```\n\n#### Parameters\n\n##### *entities* [Object][3][]\nThe entities whose DELETE commands are to be executed.\n\n#### Return Value\n[ValueTask][4]\n\nSee Also\n--------\n\n#### Reference\n[SqlTable Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: RemoveRangeAsync.md\n[3]: https://learn.microsoft.com/dotnet/api/system.object\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable/RemoveRange_1.md",
"content": "SqlTable.RemoveRange(Object[]) Method\n=====================================\nExecutes DELETE commands for the specified *entities*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------- | ------------------------------------------------------ |\n| [RemoveRange(IEnumerable<Object>)][2] | Executes DELETE commands for the specified *entities*. |\n| **RemoveRange(Object[])** | Executes DELETE commands for the specified *entities*. |\n\n\nSyntax\n------\n\n```csharp\npublic void RemoveRange(\n\tparams Object[] entities\n)\n```\n\n#### Parameters\n\n##### *entities* [Object][3][]\nThe entities whose DELETE commands are to be executed.\n\n\nSee Also\n--------\n\n#### Reference\n[SqlTable Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: RemoveRange.md\n[3]: https://learn.microsoft.com/dotnet/api/system.object\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable/Update.md",
"content": "SqlTable.Update(Object) Method\n==============================\nExecutes an UPDATE command for the specified *entity*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------- | ------------------------------------------------------ |\n| **Update(Object)** | Executes an UPDATE command for the specified *entity*. |\n| [Update(Object, Object)][2] | Executes an UPDATE command for the specified *entity*. |\n\n\nSyntax\n------\n\n```csharp\npublic void Update(\n\tObject entity\n)\n```\n\n#### Parameters\n\n##### *entity* [Object][3]\nThe entity whose UPDATE command is to be executed.\n\n\nSee Also\n--------\n\n#### Reference\n[SqlTable Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Update_1.md\n[3]: https://learn.microsoft.com/dotnet/api/system.object\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable/UpdateAsync.md",
"content": "SqlTable.UpdateAsync(Object, Object, CancellationToken) Method\n==============================================================\nExecutes an UPDATE command for the specified *entity*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------- | ------------------------------------------------------ |\n| [UpdateAsync(Object, CancellationToken)][2] | Executes an UPDATE command for the specified *entity*. |\n| **UpdateAsync(Object, Object, CancellationToken)** | Executes an UPDATE command for the specified *entity*. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask UpdateAsync(\n\tObject entity,\n\tObject? originalId,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *entity* [Object][3]\nThe entity whose UPDATE command is to be executed.\n\n##### *originalId* [Object][3]\nThe original primary key value.\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]\n\nRemarks\n-------\nThis overload is helpful when the entity uses an assigned primary key.\n\nSee Also\n--------\n\n#### Reference\n[SqlTable Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: UpdateAsync_1.md\n[3]: https://learn.microsoft.com/dotnet/api/system.object\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable/UpdateAsync_1.md",
"content": "SqlTable.UpdateAsync(Object, CancellationToken) Method\n======================================================\nExecutes an UPDATE command for the specified *entity*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------- | ------------------------------------------------------ |\n| **UpdateAsync(Object, CancellationToken)** | Executes an UPDATE command for the specified *entity*. |\n| [UpdateAsync(Object, Object, CancellationToken)][2] | Executes an UPDATE command for the specified *entity*. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask UpdateAsync(\n\tObject entity,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *entity* [Object][3]\nThe entity whose UPDATE command is to be executed.\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]\n\nSee Also\n--------\n\n#### Reference\n[SqlTable Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: UpdateAsync.md\n[3]: https://learn.microsoft.com/dotnet/api/system.object\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable/UpdateRange.md",
"content": "SqlTable.UpdateRange(IEnumerable<Object>) Method\n===================================================\nExecutes UPDATE commands for the specified *entities*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------- | ------------------------------------------------------ |\n| **UpdateRange(IEnumerable<Object>)** | Executes UPDATE commands for the specified *entities*. |\n| [UpdateRange(Object[])][2] | Executes UPDATE commands for the specified *entities*. |\n\n\nSyntax\n------\n\n```csharp\npublic void UpdateRange(\n\tIEnumerable entities\n)\n```\n\n#### Parameters\n\n##### *entities* [IEnumerable][3]<[Object][4]>\nThe entities whose UPDATE commands are to be executed.\n\n\nSee Also\n--------\n\n#### Reference\n[SqlTable Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: UpdateRange_1.md\n[3]: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1\n[4]: https://learn.microsoft.com/dotnet/api/system.object\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable/UpdateRangeAsync.md",
"content": "SqlTable.UpdateRangeAsync(IEnumerable<Object>, CancellationToken) Method\n===========================================================================\nExecutes UPDATE commands for the specified *entities*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------------------- | ------------------------------------------------------ |\n| [UpdateRangeAsync(Object[])][2] | Executes UPDATE commands for the specified *entities*. |\n| **UpdateRangeAsync(IEnumerable<Object>, CancellationToken)** | Executes UPDATE commands for the specified *entities*. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask UpdateRangeAsync(\n\tIEnumerable entities,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *entities* [IEnumerable][3]<[Object][4]>\nThe entities whose UPDATE commands are to be executed.\n\n##### *cancellationToken* [CancellationToken][5] (Optional)\nThe [CancellationToken][5] to monitor for cancellation requests. The default is [None][6].\n\n#### Return Value\n[ValueTask][7]\n\nSee Also\n--------\n\n#### Reference\n[SqlTable Class][8] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: UpdateRangeAsync_1.md\n[3]: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1\n[4]: https://learn.microsoft.com/dotnet/api/system.object\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[7]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask\n[8]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable/UpdateRangeAsync_1.md",
"content": "SqlTable.UpdateRangeAsync(Object[]) Method\n==========================================\nExecutes UPDATE commands for the specified *entities*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------------------- | ------------------------------------------------------ |\n| **UpdateRangeAsync(Object[])** | Executes UPDATE commands for the specified *entities*. |\n| [UpdateRangeAsync(IEnumerable<Object>, CancellationToken)][2] | Executes UPDATE commands for the specified *entities*. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask UpdateRangeAsync(\n\tparams Object[] entities\n)\n```\n\n#### Parameters\n\n##### *entities* [Object][3][]\nThe entities whose UPDATE commands are to be executed.\n\n#### Return Value\n[ValueTask][4]\n\nSee Also\n--------\n\n#### Reference\n[SqlTable Class][5] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: UpdateRangeAsync.md\n[3]: https://learn.microsoft.com/dotnet/api/system.object\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask\n[5]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable/UpdateRange_1.md",
"content": "SqlTable.UpdateRange(Object[]) Method\n=====================================\nExecutes UPDATE commands for the specified *entities*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------- | ------------------------------------------------------ |\n| [UpdateRange(IEnumerable<Object>)][2] | Executes UPDATE commands for the specified *entities*. |\n| **UpdateRange(Object[])** | Executes UPDATE commands for the specified *entities*. |\n\n\nSyntax\n------\n\n```csharp\npublic void UpdateRange(\n\tparams Object[] entities\n)\n```\n\n#### Parameters\n\n##### *entities* [Object][3][]\nThe entities whose UPDATE commands are to be executed.\n\n\nSee Also\n--------\n\n#### Reference\n[SqlTable Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: UpdateRange.md\n[3]: https://learn.microsoft.com/dotnet/api/system.object\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable/Update_1.md",
"content": "SqlTable.Update(Object, Object) Method\n======================================\nExecutes an UPDATE command for the specified *entity*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------- | ------------------------------------------------------ |\n| [Update(Object)][2] | Executes an UPDATE command for the specified *entity*. |\n| **Update(Object, Object)** | Executes an UPDATE command for the specified *entity*. |\n\n\nSyntax\n------\n\n```csharp\npublic void Update(\n\tObject entity,\n\tObject? originalId\n)\n```\n\n#### Parameters\n\n##### *entity* [Object][3]\nThe entity whose UPDATE command is to be executed.\n\n##### *originalId* [Object][3]\nThe original primary key value.\n\n\nRemarks\n-------\nThis overload is helpful when the entity uses an assigned primary key.\n\nSee Also\n--------\n\n#### Reference\n[SqlTable Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Update.md\n[3]: https://learn.microsoft.com/dotnet/api/system.object\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable_1/Add.md",
"content": "SqlTable<TEntity>.Add Method\n===============================\nRecursively executes INSERT commands for the specified *entity* and all its one-to-one and one-to-many associations.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic void Add(\n\tTEntity entity\n)\n```\n\n#### Parameters\n\n##### *entity* [TEntity][2]\nThe object whose INSERT command is to be executed. This parameter is named entity for consistency with the other CRUD methods, but in this case it doesn't need to be an actual entity, which means it doesn't need to have a primary key.\n\n\nSee Also\n--------\n\n#### Reference\n[SqlTable<TEntity> Class][2] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable_1/AddAsync.md",
"content": "SqlTable<TEntity>.AddAsync Method\n====================================\nRecursively executes INSERT commands for the specified *entity* and all its one-to-one and one-to-many associations.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic ValueTask AddAsync(\n\tTEntity entity,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *entity* [TEntity][2]\nThe object whose INSERT command is to be executed. This parameter is named entity for consistency with the other CRUD methods, but in this case it doesn't need to be an actual entity, which means it doesn't need to have a primary key.\n\n##### *cancellationToken* [CancellationToken][3] (Optional)\nThe [CancellationToken][3] to monitor for cancellation requests. The default is [None][4].\n\n#### Return Value\n[ValueTask][5]\n\nSee Also\n--------\n\n#### Reference\n[SqlTable<TEntity> Class][2] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: README.md\n[3]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask"
},
{
"path": "docs/api/DbExtensions/SqlTable_1/AddRange.md",
"content": "SqlTable<TEntity>.AddRange(IEnumerable<TEntity>) Method\n=============================================================\nRecursively executes INSERT commands for the specified *entities* and all their one-to-one and one-to-many associations.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |\n| **AddRange(IEnumerable<TEntity>)** | Recursively executes INSERT commands for the specified *entities* and all their one-to-one and one-to-many associations. |\n| [AddRange(TEntity[])][2] | Recursively executes INSERT commands for the specified *entities* and all their one-to-one and one-to-many associations. |\n\n\nSyntax\n------\n\n```csharp\npublic void AddRange(\n\tIEnumerable entities\n)\n```\n\n#### Parameters\n\n##### *entities* [IEnumerable][3]<[TEntity][4]>\nThe entities whose INSERT commands are to be executed.\n\n\nSee Also\n--------\n\n#### Reference\n[SqlTable<TEntity> Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: AddRange_1.md\n[3]: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable_1/AddRangeAsync.md",
"content": "SqlTable<TEntity>.AddRangeAsync(IEnumerable<TEntity>, CancellationToken) Method\n=====================================================================================\nRecursively executes INSERT commands for the specified *entities* and all their one-to-one and one-to-many associations.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |\n| [AddRangeAsync(TEntity[])][2] | Recursively executes INSERT commands for the specified *entities* and all their one-to-one and one-to-many associations. |\n| **AddRangeAsync(IEnumerable<TEntity>, CancellationToken)** | Recursively executes INSERT commands for the specified *entities* and all their one-to-one and one-to-many associations. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask AddRangeAsync(\n\tIEnumerable entities,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *entities* [IEnumerable][3]<[TEntity][4]>\nThe entities whose INSERT commands are to be executed.\n\n##### *cancellationToken* [CancellationToken][5] (Optional)\nThe [CancellationToken][5] to monitor for cancellation requests. The default is [None][6].\n\n#### Return Value\n[ValueTask][7]\n\nSee Also\n--------\n\n#### Reference\n[SqlTable<TEntity> Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: AddRangeAsync_1.md\n[3]: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1\n[4]: README.md\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[7]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask"
},
{
"path": "docs/api/DbExtensions/SqlTable_1/AddRangeAsync_1.md",
"content": "SqlTable<TEntity>.AddRangeAsync(TEntity[]) Method\n====================================================\nRecursively executes INSERT commands for the specified *entities* and all their one-to-one and one-to-many associations.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |\n| **AddRangeAsync(TEntity[])** | Recursively executes INSERT commands for the specified *entities* and all their one-to-one and one-to-many associations. |\n| [AddRangeAsync(IEnumerable<TEntity>, CancellationToken)][2] | Recursively executes INSERT commands for the specified *entities* and all their one-to-one and one-to-many associations. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask AddRangeAsync(\n\tparams TEntity[] entities\n)\n```\n\n#### Parameters\n\n##### *entities* [TEntity][3][]\nThe entities whose INSERT commands are to be executed.\n\n#### Return Value\n[ValueTask][4]\n\nSee Also\n--------\n\n#### Reference\n[SqlTable<TEntity> Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: AddRangeAsync.md\n[3]: README.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask"
},
{
"path": "docs/api/DbExtensions/SqlTable_1/AddRange_1.md",
"content": "SqlTable<TEntity>.AddRange(TEntity[]) Method\n===============================================\nRecursively executes INSERT commands for the specified *entities* and all their one-to-one and one-to-many associations.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |\n| [AddRange(IEnumerable<TEntity>)][2] | Recursively executes INSERT commands for the specified *entities* and all their one-to-one and one-to-many associations. |\n| **AddRange(TEntity[])** | Recursively executes INSERT commands for the specified *entities* and all their one-to-one and one-to-many associations. |\n\n\nSyntax\n------\n\n```csharp\npublic void AddRange(\n\tparams TEntity[] entities\n)\n```\n\n#### Parameters\n\n##### *entities* [TEntity][3][]\nThe entities whose INSERT commands are to be executed.\n\n\nSee Also\n--------\n\n#### Reference\n[SqlTable<TEntity> Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: AddRange.md\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable_1/Name.md",
"content": "SqlTable<TEntity>.Name Property\n==================================\nGets the name of the table.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic string Name { get; }\n```\n\n#### Property Value\n[String][2]\n\nSee Also\n--------\n\n#### Reference\n[SqlTable<TEntity> Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.string\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable_1/README.md",
"content": "SqlTable<TEntity> Class\n==========================\nA [SqlSet<TResult>][1] that provides CRUD (Create, Read, Update, Delete) operations for annotated classes. This class cannot be instantiated, to get an instance use the [Database.Table<TEntity>()][2] method.\n\n\nInheritance Hierarchy\n---------------------\n[System.Object][3] \n [DbExtensions.SqlSet][4] \n [DbExtensions.SqlSet][1]<**TEntity**> \n **DbExtensions.SqlTable<TEntity>** \n \n**Namespace:** [DbExtensions][5] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic sealed class SqlTable : SqlSet\nwhere TEntity : class\n\n```\n\n#### Type Parameters\n\n##### *TEntity*\nThe type of the entity.\n\nThe **SqlTable<TEntity>** type exposes the following members.\n\n\nProperties\n----------\n\n| Name | Description |\n| --------------- | -------------------------------------------------------------------------------------------------- |\n| [Database][6] | The [Database][7] this set is connected to. RemoveAsync(\n\tTEntity entity,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *entity* [TEntity][2]\nThe entity whose DELETE command is to be executed.\n\n##### *cancellationToken* [CancellationToken][3] (Optional)\nThe [CancellationToken][3] to monitor for cancellation requests. The default is [None][4].\n\n#### Return Value\n[ValueTask][5]<[Boolean][6]> \n`true` if *entity* is deleted; otherwise, `false`.\n\nSee Also\n--------\n\n#### Reference\n[SqlTable<TEntity> Class][2] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: README.md\n[3]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[6]: https://learn.microsoft.com/dotnet/api/system.boolean"
},
{
"path": "docs/api/DbExtensions/SqlTable_1/RemoveKey.md",
"content": "SqlTable<TEntity>.RemoveKey Method\n=====================================\nExecutes a DELETE command for the entity whose primary key matches the *id* parameter.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic bool RemoveKey(\n\tObject id\n)\n```\n\n#### Parameters\n\n##### *id* [Object][2]\nThe primary key value.\n\n#### Return Value\n[Boolean][3] \n`true` if a record that matches *id* was found and deleted; otherwise, `false`.\n\nSee Also\n--------\n\n#### Reference\n[SqlTable<TEntity> Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: https://learn.microsoft.com/dotnet/api/system.boolean\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable_1/RemoveKeyAsync.md",
"content": "SqlTable<TEntity>.RemoveKeyAsync Method\n==========================================\nExecutes a DELETE command for the entity whose primary key matches the *id* parameter.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic ValueTask RemoveKeyAsync(\n\tObject id,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *id* [Object][2]\nThe primary key value.\n\n##### *cancellationToken* [CancellationToken][3] (Optional)\nThe [CancellationToken][3] to monitor for cancellation requests. The default is [None][4].\n\n#### Return Value\n[ValueTask][5]<[Boolean][6]> \n`true` if a record that matches *id* was found and deleted; otherwise, `false`.\n\nSee Also\n--------\n\n#### Reference\n[SqlTable<TEntity> Class][7] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.object\n[3]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1\n[6]: https://learn.microsoft.com/dotnet/api/system.boolean\n[7]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable_1/RemoveRange.md",
"content": "SqlTable<TEntity>.RemoveRange(IEnumerable<TEntity>) Method\n================================================================\nExecutes DELETE commands for the specified *entities*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------- | ------------------------------------------------------ |\n| **RemoveRange(IEnumerable<TEntity>)** | Executes DELETE commands for the specified *entities*. |\n| [RemoveRange(TEntity[])][2] | Executes DELETE commands for the specified *entities*. |\n\n\nSyntax\n------\n\n```csharp\npublic void RemoveRange(\n\tIEnumerable entities\n)\n```\n\n#### Parameters\n\n##### *entities* [IEnumerable][3]<[TEntity][4]>\nThe entities whose DELETE commands are to be executed.\n\n\nSee Also\n--------\n\n#### Reference\n[SqlTable<TEntity> Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: RemoveRange_1.md\n[3]: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable_1/RemoveRangeAsync.md",
"content": "SqlTable<TEntity>.RemoveRangeAsync(IEnumerable<TEntity>, CancellationToken) Method\n========================================================================================\nExecutes DELETE commands for the specified *entities*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------------------- | ------------------------------------------------------ |\n| [RemoveRangeAsync(TEntity[])][2] | Executes DELETE commands for the specified *entities*. |\n| **RemoveRangeAsync(IEnumerable<TEntity>, CancellationToken)** | Executes DELETE commands for the specified *entities*. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask RemoveRangeAsync(\n\tIEnumerable entities,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *entities* [IEnumerable][3]<[TEntity][4]>\nThe entities whose DELETE commands are to be executed.\n\n##### *cancellationToken* [CancellationToken][5] (Optional)\nThe [CancellationToken][5] to monitor for cancellation requests. The default is [None][6].\n\n#### Return Value\n[ValueTask][7]\n\nSee Also\n--------\n\n#### Reference\n[SqlTable<TEntity> Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: RemoveRangeAsync_1.md\n[3]: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1\n[4]: README.md\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[7]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask"
},
{
"path": "docs/api/DbExtensions/SqlTable_1/RemoveRangeAsync_1.md",
"content": "SqlTable<TEntity>.RemoveRangeAsync(TEntity[]) Method\n=======================================================\nExecutes DELETE commands for the specified *entities*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------------------------------- | ------------------------------------------------------ |\n| **RemoveRangeAsync(TEntity[])** | Executes DELETE commands for the specified *entities*. |\n| [RemoveRangeAsync(IEnumerable<TEntity>, CancellationToken)][2] | Executes DELETE commands for the specified *entities*. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask RemoveRangeAsync(\n\tparams TEntity[] entities\n)\n```\n\n#### Parameters\n\n##### *entities* [TEntity][3][]\nThe entities whose DELETE commands are to be executed.\n\n#### Return Value\n[ValueTask][4]\n\nSee Also\n--------\n\n#### Reference\n[SqlTable<TEntity> Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: RemoveRangeAsync.md\n[3]: README.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask"
},
{
"path": "docs/api/DbExtensions/SqlTable_1/RemoveRange_1.md",
"content": "SqlTable<TEntity>.RemoveRange(TEntity[]) Method\n==================================================\nExecutes DELETE commands for the specified *entities*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------- | ------------------------------------------------------ |\n| [RemoveRange(IEnumerable<TEntity>)][2] | Executes DELETE commands for the specified *entities*. |\n| **RemoveRange(TEntity[])** | Executes DELETE commands for the specified *entities*. |\n\n\nSyntax\n------\n\n```csharp\npublic void RemoveRange(\n\tparams TEntity[] entities\n)\n```\n\n#### Parameters\n\n##### *entities* [TEntity][3][]\nThe entities whose DELETE commands are to be executed.\n\n\nSee Also\n--------\n\n#### Reference\n[SqlTable<TEntity> Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: RemoveRange.md\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable_1/Update.md",
"content": "SqlTable<TEntity>.Update(TEntity) Method\n===========================================\nExecutes an UPDATE command for the specified *entity*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------- | ------------------------------------------------------ |\n| **Update(TEntity)** | Executes an UPDATE command for the specified *entity*. |\n| [Update(TEntity, Object)][2] | Executes an UPDATE command for the specified *entity*. |\n\n\nSyntax\n------\n\n```csharp\npublic void Update(\n\tTEntity entity\n)\n```\n\n#### Parameters\n\n##### *entity* [TEntity][3]\nThe entity whose UPDATE command is to be executed.\n\n\nSee Also\n--------\n\n#### Reference\n[SqlTable<TEntity> Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Update_1.md\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable_1/UpdateAsync.md",
"content": "SqlTable<TEntity>.UpdateAsync(TEntity, Object, CancellationToken) Method\n===========================================================================\nExecutes an UPDATE command for the specified *entity*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------------------------------- | ------------------------------------------------------ |\n| [UpdateAsync(TEntity, CancellationToken)][2] | Executes an UPDATE command for the specified *entity*. |\n| **UpdateAsync(TEntity, Object, CancellationToken)** | Executes an UPDATE command for the specified *entity*. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask UpdateAsync(\n\tTEntity entity,\n\tObject? originalId,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *entity* [TEntity][3]\nThe entity whose UPDATE command is to be executed.\n\n##### *originalId* [Object][4]\nThe original primary key value.\n\n##### *cancellationToken* [CancellationToken][5] (Optional)\nThe [CancellationToken][5] to monitor for cancellation requests. The default is [None][6].\n\n#### Return Value\n[ValueTask][7]\n\nRemarks\n-------\nThis overload is helpful when the entity uses an assigned primary key.\n\nSee Also\n--------\n\n#### Reference\n[SqlTable<TEntity> Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: UpdateAsync_1.md\n[3]: README.md\n[4]: https://learn.microsoft.com/dotnet/api/system.object\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[7]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask"
},
{
"path": "docs/api/DbExtensions/SqlTable_1/UpdateAsync_1.md",
"content": "SqlTable<TEntity>.UpdateAsync(TEntity, CancellationToken) Method\n===================================================================\nExecutes an UPDATE command for the specified *entity*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------- | ------------------------------------------------------ |\n| **UpdateAsync(TEntity, CancellationToken)** | Executes an UPDATE command for the specified *entity*. |\n| [UpdateAsync(TEntity, Object, CancellationToken)][2] | Executes an UPDATE command for the specified *entity*. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask UpdateAsync(\n\tTEntity entity,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *entity* [TEntity][3]\nThe entity whose UPDATE command is to be executed.\n\n##### *cancellationToken* [CancellationToken][4] (Optional)\nThe [CancellationToken][4] to monitor for cancellation requests. The default is [None][5].\n\n#### Return Value\n[ValueTask][6]\n\nSee Also\n--------\n\n#### Reference\n[SqlTable<TEntity> Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: UpdateAsync.md\n[3]: README.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask"
},
{
"path": "docs/api/DbExtensions/SqlTable_1/UpdateRange.md",
"content": "SqlTable<TEntity>.UpdateRange(IEnumerable<TEntity>) Method\n================================================================\nExecutes UPDATE commands for the specified *entities*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------- | ------------------------------------------------------ |\n| **UpdateRange(IEnumerable<TEntity>)** | Executes UPDATE commands for the specified *entities*. |\n| [UpdateRange(TEntity[])][2] | Executes UPDATE commands for the specified *entities*. |\n\n\nSyntax\n------\n\n```csharp\npublic void UpdateRange(\n\tIEnumerable entities\n)\n```\n\n#### Parameters\n\n##### *entities* [IEnumerable][3]<[TEntity][4]>\nThe entities whose UPDATE commands are to be executed.\n\n\nSee Also\n--------\n\n#### Reference\n[SqlTable<TEntity> Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: UpdateRange_1.md\n[3]: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1\n[4]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable_1/UpdateRangeAsync.md",
"content": "SqlTable<TEntity>.UpdateRangeAsync(IEnumerable<TEntity>, CancellationToken) Method\n========================================================================================\nExecutes UPDATE commands for the specified *entities*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ---------------------------------------------------------------- | ------------------------------------------------------ |\n| [UpdateRangeAsync(TEntity[])][2] | Executes UPDATE commands for the specified *entities*. |\n| **UpdateRangeAsync(IEnumerable<TEntity>, CancellationToken)** | Executes UPDATE commands for the specified *entities*. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask UpdateRangeAsync(\n\tIEnumerable entities,\n\tCancellationToken cancellationToken = default\n)\n```\n\n#### Parameters\n\n##### *entities* [IEnumerable][3]<[TEntity][4]>\nThe entities whose UPDATE commands are to be executed.\n\n##### *cancellationToken* [CancellationToken][5] (Optional)\nThe [CancellationToken][5] to monitor for cancellation requests. The default is [None][6].\n\n#### Return Value\n[ValueTask][7]\n\nSee Also\n--------\n\n#### Reference\n[SqlTable<TEntity> Class][4] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: UpdateRangeAsync_1.md\n[3]: https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1\n[4]: README.md\n[5]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken\n[6]: https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken.none\n[7]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask"
},
{
"path": "docs/api/DbExtensions/SqlTable_1/UpdateRangeAsync_1.md",
"content": "SqlTable<TEntity>.UpdateRangeAsync(TEntity[]) Method\n=======================================================\nExecutes UPDATE commands for the specified *entities*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------------------------------- | ------------------------------------------------------ |\n| **UpdateRangeAsync(TEntity[])** | Executes UPDATE commands for the specified *entities*. |\n| [UpdateRangeAsync(IEnumerable<TEntity>, CancellationToken)][2] | Executes UPDATE commands for the specified *entities*. |\n\n\nSyntax\n------\n\n```csharp\npublic ValueTask UpdateRangeAsync(\n\tparams TEntity[] entities\n)\n```\n\n#### Parameters\n\n##### *entities* [TEntity][3][]\nThe entities whose UPDATE commands are to be executed.\n\n#### Return Value\n[ValueTask][4]\n\nSee Also\n--------\n\n#### Reference\n[SqlTable<TEntity> Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: UpdateRangeAsync.md\n[3]: README.md\n[4]: https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask"
},
{
"path": "docs/api/DbExtensions/SqlTable_1/UpdateRange_1.md",
"content": "SqlTable<TEntity>.UpdateRange(TEntity[]) Method\n==================================================\nExecutes UPDATE commands for the specified *entities*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| ----------------------------------------- | ------------------------------------------------------ |\n| [UpdateRange(IEnumerable<TEntity>)][2] | Executes UPDATE commands for the specified *entities*. |\n| **UpdateRange(TEntity[])** | Executes UPDATE commands for the specified *entities*. |\n\n\nSyntax\n------\n\n```csharp\npublic void UpdateRange(\n\tparams TEntity[] entities\n)\n```\n\n#### Parameters\n\n##### *entities* [TEntity][3][]\nThe entities whose UPDATE commands are to be executed.\n\n\nSee Also\n--------\n\n#### Reference\n[SqlTable<TEntity> Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: UpdateRange.md\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/SqlTable_1/Update_1.md",
"content": "SqlTable<TEntity>.Update(TEntity, Object) Method\n===================================================\nExecutes an UPDATE command for the specified *entity*.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nOverloads\n---------\n\n| Name | Description |\n| --------------------------- | ------------------------------------------------------ |\n| [Update(TEntity)][2] | Executes an UPDATE command for the specified *entity*. |\n| **Update(TEntity, Object)** | Executes an UPDATE command for the specified *entity*. |\n\n\nSyntax\n------\n\n```csharp\npublic void Update(\n\tTEntity entity,\n\tObject? originalId\n)\n```\n\n#### Parameters\n\n##### *entity* [TEntity][3]\nThe entity whose UPDATE command is to be executed.\n\n##### *originalId* [Object][4]\nThe original primary key value.\n\n\nRemarks\n-------\nThis overload is helpful when the entity uses an assigned primary key.\n\nSee Also\n--------\n\n#### Reference\n[SqlTable<TEntity> Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: Update.md\n[3]: README.md\n[4]: https://learn.microsoft.com/dotnet/api/system.object"
},
{
"path": "docs/api/DbExtensions/TableAttribute/Name.md",
"content": "TableAttribute.Name Property\n============================\nGets or sets the name of the table or view.\n \n**Namespace:** [DbExtensions][1] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic string? Name { get; set; }\n```\n\n#### Property Value\n[String][2]\n\nSee Also\n--------\n\n#### Reference\n[TableAttribute Class][3] \n[DbExtensions Namespace][1] \n\n[1]: ../README.md\n[2]: https://learn.microsoft.com/dotnet/api/system.string\n[3]: README.md"
},
{
"path": "docs/api/DbExtensions/TableAttribute/README.md",
"content": "TableAttribute Class\n====================\nDesignates a class as an entity class that is associated with a database table.\n\n\nInheritance Hierarchy\n---------------------\n[System.Object][1] \n [System.Attribute][2] \n **DbExtensions.TableAttribute** \n \n**Namespace:** [DbExtensions][3] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic sealed class TableAttribute : Attribute\n```\n\nThe **TableAttribute** type exposes the following members.\n\n\nConstructors\n------------\n\n| Name | Description |\n| ------------------- | ---------------------------------------------------------- |\n| [TableAttribute][4] | Initializes a new instance of the **TableAttribute** class |\n\n\nProperties\n----------\n\n| Name | Description |\n| --------- | ------------------------------------------- |\n| [Name][5] | Gets or sets the name of the table or view. |\n\n\nSee Also\n--------\n\n#### Reference\n[DbExtensions Namespace][3] \n\n[1]: https://learn.microsoft.com/dotnet/api/system.object\n[2]: https://learn.microsoft.com/dotnet/api/system.attribute\n[3]: ../README.md\n[4]: _ctor.md\n[5]: Name.md"
},
{
"path": "docs/api/DbExtensions/TableAttribute/_ctor.md",
"content": "TableAttribute Constructor\n==========================\nInitializes a new instance of the [TableAttribute][1] class\n \n**Namespace:** [DbExtensions][2] \n**Assembly:** DbExtensions.dll\n\nSyntax\n------\n\n```csharp\npublic TableAttribute()\n```\n\n\nSee Also\n--------\n\n#### Reference\n[TableAttribute Class][1] \n[DbExtensions Namespace][2] \n\n[1]: README.md\n[2]: ../README.md"
},
{
"path": "docs/api/README.md",
"content": "DbExtensions Namespaces\n=======================\n\n\nNamespaces\n----------\n\n| Namespace | Description |\n| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [DbExtensions][1] | DbExtensions is a data-access framework with a strong focus on query composition, granularity and code aesthetics. [Database][2] is the entry point of the [DbExtensions][1] API. |\n\n[1]: DbExtensions/README.md\n[2]: DbExtensions/Database/README.md"
},
{
"path": "samples/App/App.config",
"content": "\n\n \n \n \n"
},
{
"path": "samples/App/Program.cs",
"content": "using System;\nusing System.Collections;\nusing System.Collections.Generic;\nusing System.Configuration;\nusing System.Data.Common;\nusing System.IO;\nusing System.Linq;\nusing System.Linq.Expressions;\nusing System.Reflection;\nusing System.Text.RegularExpressions;\nusing DbExtensions;\n\nnamespace Samples {\n\n using static Console;\n\n class Program {\n\n readonly string\n _samplesPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, \"..\", \"..\", \"..\", \"..\");\n\n static void\n Main() {\n\n DbProviderFactories.RegisterFactory(\"Microsoft.Data.SqlClient\", Microsoft.Data.SqlClient.SqlClientFactory.Instance);\n DbProviderFactories.RegisterFactory(\"MySql.Data.MySqlClient\", MySql.Data.MySqlClient.MySqlClientFactory.Instance);\n DbProviderFactories.RegisterFactory(\"System.Data.SQLite\", System.Data.SQLite.SQLiteFactory.Instance);\n\n new Program().Run();\n }\n\n void\n Run() {\n\n WriteLine(\"DbExtensions Sample Runner\");\n WriteLine(\"==========================\");\n\n var connectionStrings = ConfigurationManager.ConnectionStrings\n .Cast()\n // Only connection strings defined in this application config file\n .Where(c => c.ElementInformation.Source != null && c.ElementInformation.Source.EndsWith(\"dll.config\", StringComparison.OrdinalIgnoreCase))\n .ToArray();\n\n var connIndex = GetArrayOption(connectionStrings.Select(c => c.Name).ToArray(), \"Select a connection string (or Enter to select the first one):\");\n var connSettings = connectionStrings[connIndex];\n var provider = DbProviderFactories.GetFactory(connSettings.ProviderName);\n\n WriteLine();\n WriteLine(\"Provider: {0}\", provider.GetType().AssemblyQualifiedName);\n WriteLine();\n WriteLine(\"Connecting...\");\n\n try {\n\n var db = new Database(connSettings.ConnectionString, connSettings.ProviderName);\n\n using (db.EnsureConnectionOpen()) {\n WriteLine(\"Server Version: {0}\", ((DbConnection)db.Connection).ServerVersion);\n }\n\n } catch (Exception ex) {\n\n WriteError(ex, fatal: true);\n return;\n }\n\n var samplesLangs = GetSamplesLanguages();\n\n var samplesLangIndex = GetArrayOption(samplesLangs, \"Select the samples language (or Enter):\");\n var samplesLanguage = samplesLangs[samplesLangIndex];\n\n object[] samples;\n\n try {\n samples = GetSamples(samplesLanguage, connSettings).ToArray();\n } catch (Exception ex) {\n\n WriteError(ex, fatal: true);\n return;\n }\n\n var samplesOptions =\n (from s in samples\n let name = s.GetType().Name\n let friendlyName = name.Substring(0, name.Length - \"Samples\".Length)\n select friendlyName)\n .Append(\"All\")\n .ToArray();\n\n var samplesIndex = GetArrayOption(samplesOptions, \"Select the samples category (or Enter to run all):\", samplesOptions.Length - 1);\n\n var selectedSamples = (samplesIndex == samplesOptions.Length - 1) ? samples\n : [samples[samplesIndex]];\n\n var continueOnErrorOptions = new[] { \"Yes\", \"No\" };\n var continueOnError = GetArrayOption(continueOnErrorOptions, \"Continue on Error:\") == 0;\n\n WriteLine();\n WriteLine(\"Press key to begin...\");\n ReadKey();\n\n for (int i = 0; i < selectedSamples.Length; i++) {\n\n var sampl = selectedSamples[i];\n\n RunSamples(sampl, continueOnError);\n\n if (sampl is IDisposable disp) {\n disp.Dispose();\n }\n\n WriteLine();\n WriteLine((i == selectedSamples.Length - 1) ? \"Press key to exit...\" : \"Press key to continue...\");\n ReadKey();\n }\n }\n\n string[]\n GetSamplesLanguages() {\n\n var appDir = AppDomain.CurrentDomain.BaseDirectory\n .Split(Path.DirectorySeparatorChar, StringSplitOptions.RemoveEmptyEntries)\n .Reverse()\n .Skip(3)\n .First();\n\n var projectsDir = Directory\n .GetDirectories(_samplesPath, \"*\", SearchOption.TopDirectoryOnly)\n .Select(s => s.Split(Path.DirectorySeparatorChar).Last())\n .Where(s => !s.Equals(appDir))\n .ToArray();\n\n return projectsDir;\n }\n\n IEnumerable\n GetSamples(string language, ConnectionStringSettings connSettings) {\n\n var projectDir = Path.Combine(_samplesPath, language);\n var projectFile = Directory.GetFiles(projectDir, String.Format(\"*.{0}proj\", Regex.Replace(language, \"[a-z]\", \"\")))\n .FirstOrDefault()\n ?? throw new InvalidOperationException(\"Project file not found.\");\n\n var projectFileName = projectFile.Split(Path.DirectorySeparatorChar).Last();\n var assemblyName = String.Join(\".\", projectFileName.Split('.').Reverse().Skip(1).Reverse());\n var assemblyDir = Directory.GetDirectories(Path.Combine(projectDir, \"bin\", \"Debug\"), \"net*\").First();\n var assemblyPath = new Uri(Path.Combine(assemblyDir, assemblyName + \".dll\")).LocalPath;\n\n var samplesAssembly = Assembly.LoadFrom(assemblyPath);\n\n var dbType = samplesAssembly.GetTypes()\n .Where(t => typeof(Database).IsAssignableFrom(t))\n .Single();\n\n var db = (Database)Activator.CreateInstance(dbType, connSettings.ConnectionString, connSettings.ProviderName);\n db.Configuration.Log = Out;\n\n return\n from t in samplesAssembly.GetTypes()\n where t.IsPublic\n && t.Name.EndsWith(\"Samples\")\n let parameters = t.GetConstructors().First().GetParameters()\n let args =\n from p in parameters\n select (typeof(Database).IsAssignableFrom(p.ParameterType) ? db\n : p.ParameterType.IsValueType ? Activator.CreateInstance(p.ParameterType)\n : null)\n select Activator.CreateInstance(t, args.ToArray());\n }\n\n static void\n RunSamples(object samples, bool continueOnError) {\n\n var samplesType = samples.GetType();\n var isDisposable = samples is IDisposable;\n\n var methods = samplesType\n .GetMethods(BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly)\n .ToList();\n\n for (int i = 0; i < methods.Count; i++) {\n\n var method = methods[i];\n\n if (isDisposable\n && method.Name == \"Dispose\") {\n\n continue;\n }\n\n WriteLine();\n WriteLine(method.Name);\n Write(new string('=', method.Name.Length));\n WriteLine();\n\n object returnValue = null;\n\n if (method.ReturnType == typeof(void)) {\n\n var runSample = (Action)Delegate.CreateDelegate(typeof(Action), samples, method);\n\n if (continueOnError) {\n\n try {\n runSample();\n } catch (Exception ex) {\n WriteError(ex);\n continue;\n }\n\n } else {\n runSample();\n }\n\n } else {\n\n void runSample() {\n returnValue = Expression.Lambda>(\n Expression.Convert(\n Expression.Call(Expression.Constant(samples), method)\n , typeof(object)\n )\n ).Compile()();\n\n if (returnValue is IEnumerable ienum) {\n returnValue = ienum.Cast().ToArray();\n }\n }\n\n if (continueOnError) {\n\n try {\n runSample();\n } catch (Exception ex) {\n WriteError(ex);\n continue;\n }\n\n } else {\n runSample();\n }\n }\n\n if (returnValue != null) {\n\n WriteLine();\n\n if (returnValue is SqlBuilder sql) {\n\n WriteLine(returnValue);\n\n for (int j = 0; j < sql.ParameterValues.Count; j++) {\n\n var value = sql.ParameterValues[j];\n var type = value?.GetType();\n\n WriteLine(\"-- {0}: {1} [{2}]\", j, type, value);\n }\n\n } else {\n\n var color = ForegroundColor;\n ForegroundColor = ConsoleColor.DarkGray;\n\n ObjectDumper.Write(returnValue, 1, Out);\n\n ForegroundColor = color;\n }\n }\n }\n }\n\n static int\n GetArrayOption(T[] options, string title, int defaultOption = 0) {\n\n var firstTry = true;\n var index = -1;\n var left = CursorLeft;\n\n while (index < 0 || index >= options.Length) {\n\n if (!firstTry) {\n WriteLine();\n }\n\n firstTry = false;\n\n WriteLine();\n WriteLine(title);\n\n for (int i = 0; i < options.Length; i++) {\n\n if (i > 0) {\n Write(\", \");\n }\n\n Write(\"[{0}] {1}\", i + 1, options[i]);\n }\n\n Write(\": \");\n\n left = CursorLeft;\n var key = ReadKey();\n\n if (key.Key == ConsoleKey.Enter) {\n\n index = defaultOption;\n\n } else {\n\n try {\n index = Int32.Parse(key.KeyChar.ToString()) - 1;\n } catch (Exception) { }\n }\n }\n\n var prevColor = ForegroundColor;\n\n ForegroundColor = ConsoleColor.Green;\n\n CursorLeft = left;\n Write(options[index]);\n WriteLine();\n\n ForegroundColor = prevColor;\n\n return index;\n }\n\n static void\n WriteError(Exception ex, bool fatal = false) {\n\n var prevColor = ForegroundColor;\n ForegroundColor = ConsoleColor.Red;\n WriteLine(ex.Message);\n ForegroundColor = prevColor;\n\n WriteLine();\n WriteLine((fatal) ? \"Press key to exit...\" : \"Press key to continue...\");\n ReadKey();\n }\n }\n}\n"
},
{
"path": "samples/App/Samples.App.csproj",
"content": "\n\n \n Exe \n net8.0 \n 12 \n \n\n \n \n\n \n \n\n \n \n Always \n \n \n PreserveNewest \n \n \n Northwind.mdf \n Always \n \n \n\n \n"
},
{
"path": "samples/App/Utilities/ObjectDumper-LICENSE.txt",
"content": "MICROSOFT LIMITED PUBLIC LICENSE version 1.1\n\nThis license governs use of code marked as “sample” or “example” available on this web site without a license agreement, as provided under the section above titled “NOTICE SPECIFIC TO SOFTWARE AVAILABLE ON THIS WEB SITE.” If you use such code (the “software”), you accept this license. If you do not accept the license, do not use the software.\n\n\n1. Definitions\n\nThe terms “reproduce,” “reproduction,” “derivative works,” and “distribution” have the same meaning here as under U.S. copyright law.\n\nA “contribution” is the original software, or any additions or changes to the software.\n\nA “contributor” is any person that distributes its contribution under this license.\n\n“Licensed patents” are a contributor’s patent claims that read directly on its contribution.\n\n\n2. Grant of Rights\n\n(A) Copyright Grant - Subject to the terms of this license, including the license conditions and limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free copyright license to reproduce its contribution, prepare derivative works of its contribution, and distribute its contribution or any derivative works that you create.\n\n(B) Patent Grant - Subject to the terms of this license, including the license conditions and limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free license under its licensed patents to make, have made, use, sell, offer for sale, import, and/or otherwise dispose of its contribution in the software or derivative works of the contribution in the software.\n\n\n3. Conditions and Limitations\n\n(A) No Trademark License- This license does not grant you rights to use any contributors’ name, logo, or trademarks.\n\n(B) If you bring a patent claim against any contributor over patents that you claim are infringed by the software, your patent license from such contributor to the software ends automatically.\n\n(C) If you distribute any portion of the software, you must retain all copyright, patent, trademark, and attribution notices that are present in the software.\n\n(D) If you distribute any portion of the software in source code form, you may do so only under this license by including a complete copy of this license with your distribution. If you distribute any portion of the software in compiled or object code form, you may only do so under a license that complies with this license.\n\n(E) The software is licensed “as-is.” You bear the risk of using it. The contributors give no express warranties, guarantees or conditions. You may have additional consumer rights under your local laws which this license cannot change. To the extent permitted under your local laws, the contributors exclude the implied warranties of merchantability, fitness for a particular purpose and non-infringement.\n\n(F) Platform Limitation - The licenses granted in sections 2(A) and 2(B) extend only to the software or derivative works that you create that run directly on a Microsoft Windows operating system product, Microsoft run-time technology (such as the .NET Framework or Silverlight), or Microsoft application platform (such as Microsoft Office or Microsoft Dynamics)."
},
{
"path": "samples/App/Utilities/ObjectDumper.cs",
"content": "// Copyright (C) Microsoft Corporation. All rights reserved.\n// See ObjectDumper-LICENSE.txt for license information.\n\nusing System;\nusing System.IO;\nusing System.Collections;\nusing System.Collections.Generic;\nusing System.Reflection;\n\npublic class ObjectDumper {\n\n public static void Write(object element)\n {\n Write(element, 0);\n }\n\n public static void Write(object element, int depth)\n {\n Write(element, depth, Console.Out);\n }\n\n public static void Write(object element, int depth, TextWriter log)\n {\n ObjectDumper dumper = new ObjectDumper(depth);\n dumper.writer = log;\n dumper.WriteObject(null, element);\n }\n\n TextWriter writer;\n int pos;\n int level;\n int depth;\n\n private ObjectDumper(int depth)\n {\n this.depth = depth;\n }\n\n private void Write(string s)\n {\n if (s != null) {\n writer.Write(s);\n pos += s.Length;\n }\n }\n\n private void WriteIndent()\n {\n for (int i = 0; i < level; i++) writer.Write(\" \");\n }\n\n private void WriteLine()\n {\n writer.WriteLine();\n pos = 0;\n }\n\n private void WriteTab()\n {\n Write(\" \");\n while (pos % 8 != 0) Write(\" \");\n }\n\n private void WriteObject(string prefix, object element)\n {\n if (element == null || element is ValueType || element is string) {\n WriteIndent();\n Write(prefix);\n WriteValue(element);\n WriteLine();\n }\n else {\n IEnumerable enumerableElement = element as IEnumerable;\n if (enumerableElement != null) {\n foreach (object item in enumerableElement) {\n if (item is IEnumerable && !(item is string)) {\n WriteIndent();\n Write(prefix);\n Write(\"...\");\n WriteLine();\n if (level < depth) {\n level++;\n WriteObject(prefix, item);\n level--;\n }\n }\n else {\n WriteObject(prefix, item);\n }\n }\n }\n else {\n MemberInfo[] members = element.GetType().GetMembers(BindingFlags.Public | BindingFlags.Instance);\n WriteIndent();\n Write(prefix);\n bool propWritten = false;\n foreach (MemberInfo m in members) {\n FieldInfo f = m as FieldInfo;\n PropertyInfo p = m as PropertyInfo;\n if (f != null || p != null) {\n if (propWritten) {\n WriteTab();\n }\n else {\n propWritten = true;\n }\n Write(m.Name);\n Write(\"=\");\n Type t = f != null ? f.FieldType : p.PropertyType;\n if (t.IsValueType || t == typeof(string)) {\n WriteValue(f != null ? f.GetValue(element) : p.GetValue(element, null));\n }\n else {\n if (typeof(IEnumerable).IsAssignableFrom(t)) {\n Write(\"...\");\n }\n else {\n Write(\"{ }\");\n }\n }\n }\n }\n if (propWritten) WriteLine();\n if (level < depth) {\n foreach (MemberInfo m in members) {\n FieldInfo f = m as FieldInfo;\n PropertyInfo p = m as PropertyInfo;\n if (f != null || p != null) {\n Type t = f != null ? f.FieldType : p.PropertyType;\n if (!(t.IsValueType || t == typeof(string))) {\n object value = f != null ? f.GetValue(element) : p.GetValue(element, null);\n if (value != null) {\n level++;\n WriteObject(m.Name + \": \", value);\n level--;\n }\n }\n }\n }\n }\n }\n }\n }\n\n private void WriteValue(object o)\n {\n if (o == null) {\n Write(\"null\");\n }\n else if (o is DateTime) {\n Write(((DateTime)o).ToShortDateString());\n }\n else if (o is ValueType || o is string) {\n Write(o.ToString());\n }\n else if (o is IEnumerable) {\n Write(\"...\");\n }\n else {\n Write(\"{ }\");\n }\n }\n}\n"
},
{
"path": "samples/CSharp/Database.Annotated.cs",
"content": "using System;\nusing System.Collections.Generic;\nusing Samples.CSharp.Northwind;\n\nnamespace Samples.CSharp {\n\n public class DatabaseAnnotatedSamples {\n\n readonly NorthwindDatabase db;\n\n public DatabaseAnnotatedSamples(NorthwindDatabase db) {\n this.db = db;\n }\n\n public IEnumerable IncludeManyToOne() {\n\n return db.Products\n .Include(p => p.Category)\n .Include(p => p.Supplier)\n .Take(3)\n .AsEnumerable();\n }\n\n public IEnumerable IncludeManyToOneNested() {\n\n return db.EmployeeTerritories\n .Include(p => p.Territory.Region)\n .Take(3)\n .AsEnumerable();\n }\n\n public Region IncludeOneToMany() {\n\n return db.Regions\n .IncludeMany(p => p.Territories)\n .First();\n }\n\n public bool ContainsKey() {\n return db.Products.ContainsKey(1);\n }\n\n public Product Find() {\n return db.Products.Find(1);\n }\n\n public void Transactions_AdoNet() {\n\n using var tx = db.EnsureInTransaction();\n // Connection is automatically opened if not open\n\n var order = new Order {\n CustomerID = \"ALFKI\",\n OrderDetails = {\n new OrderDetail { ProductID = 77, Quantity = 1 },\n new OrderDetail { ProductID = 41, Quantity = 2 }\n }\n };\n\n db.Orders.Add(order);\n\n order.Freight = 10m;\n\n db.Orders.Update(order);\n\n // The following line is not needed when cascade delete is configured on the database\n db.OrderDetails.RemoveRange(order.OrderDetails);\n\n db.Orders.Remove(order);\n\n tx.Commit();\n // Connection is closed if wasn't open\n }\n }\n}"
},
{
"path": "samples/CSharp/Database.Poco.cs",
"content": "using System;\nusing System.Collections;\nusing System.Collections.Generic;\nusing System.Linq;\nusing DbExtensions;\nusing Samples.CSharp.Northwind;\n\nnamespace Samples.CSharp {\n\n public class DatabasePocoSamples {\n\n readonly Database db;\n\n public DatabasePocoSamples(Database db) {\n this.db = db;\n }\n\n public IEnumerable SelectWithManyToOne() {\n\n var query = SQL\n .SELECT(\"p.ProductID, p.ProductName, p.CategoryID, s.SupplierID, '' AS MissingProperty\")\n ._(\"c.CategoryID AS Category$CategoryID, c.CategoryName AS Category$CategoryName\")\n ._(\"s.SupplierID AS Supplier$SupplierID, s.CompanyName AS Supplier$CompanyName\")\n .FROM(\"Products p\")\n .LEFT_JOIN(\"Categories c ON p.CategoryID = c.CategoryID\")\n .LEFT_JOIN(\"Suppliers s ON p.SupplierID = s.SupplierID\")\n .WHERE($\"p.ProductID < {3}\");\n\n return db.Map(query);\n }\n\n public IEnumerable SelectWithManyToOneNested() {\n\n var query = SQL\n .SELECT(\"et.EmployeeID, et.TerritoryID\")\n ._(\"t.TerritoryID AS Territory$TerritoryID, t.TerritoryDescription AS Territory$TerritoryDescription, t.RegionID AS Territory$RegionID\")\n ._(\"r.RegionID AS Territory$Region$RegionID, r.RegionDescription AS Territory$Region$RegionDescription\")\n .FROM(\"EmployeeTerritories et\")\n .LEFT_JOIN(\"Territories t ON et.TerritoryID = t.TerritoryID\")\n .LEFT_JOIN(\"Region r ON t.RegionID = r.RegionID\")\n .WHERE($\"et.EmployeeID < {3}\");\n\n return db.Map(query);\n }\n\n public IEnumerable AnnonymousType() {\n\n var query = SQL\n .SELECT(\"p.ProductID, p.ProductName\")\n .FROM(\"Products p\")\n .WHERE($\"p.ProductID < {3}\");\n\n return db.Map(query, r => new {\n ProductID = r.GetInt32(0),\n ProductName = r.GetStringOrNull(1)\n });\n }\n\n public IEnumerable MappingCalculatedColumn() {\n\n var query = SQL\n .SELECT(\"p.ProductID, (p.UnitPrice * p.UnitsInStock) AS ValueInStock\")\n .FROM(\"Products p\")\n .WHERE($\"p.ProductID < {3}\")\n .ORDER_BY(\"ValueInStock\");\n\n return db.Map(query);\n }\n\n public MappingToConstructorArgumentsSample MappingToConstructorArguments() {\n\n var query = SQL\n .SELECT(\"1 AS '1'\")\n ._(\"'http://example.com' AS Url$1\")\n ._(\"15.5 AS Price$1, 'USD' AS Price$2\");\n\n return db.Map(query)\n .Single();\n }\n\n public MappingToConstructorArgumentsSample MappingToConstructorArgumentsNested() {\n\n var query = SQL\n .SELECT(\"1 AS '1'\")\n ._(\"'http://example.com' AS '2$1'\")\n ._(\"15.5 AS '3$1', 'USD' AS '3$2'\");\n\n return db.Map(query)\n .Single();\n }\n\n public IEnumerable Dynamic() {\n\n var query = SQL\n .SELECT(\"p.ProductID, p.ProductName, p.CategoryID, s.SupplierID\")\n ._(\"c.CategoryID AS Category$CategoryID, c.CategoryName AS Category$CategoryName\")\n ._(\"s.SupplierID AS Supplier$SupplierID, s.CompanyName AS Supplier$CompanyName\")\n .FROM(\"Products p\")\n .LEFT_JOIN(\"Categories c ON p.CategoryID = c.CategoryID\")\n .LEFT_JOIN(\"Suppliers s ON p.SupplierID = s.SupplierID\")\n .WHERE($\"p.ProductID < {3}\");\n\n return db.Map(query);\n }\n }\n\n public class ProductWithStockValue : Product {\n\n public decimal ValueInStock { get; set; }\n }\n\n public class MappingToConstructorArgumentsSample {\n\n public int Id { get; private set; }\n public Uri Url { get; private set; }\n public Money? Price { get; private set; }\n\n public MappingToConstructorArgumentsSample(int id) {\n this.Id = id;\n }\n\n public MappingToConstructorArgumentsSample(int id, Uri url, Money? price)\n : this(id) {\n\n this.Url = url;\n this.Price = price;\n }\n }\n\n public struct Money {\n\n public readonly decimal Amount;\n public readonly string Currency;\n\n public Money(decimal amount, string currency) {\n this.Amount = amount;\n this.Currency = currency;\n }\n\n public override string ToString() {\n return this.Currency + this.Amount.ToString();\n }\n }\n}\n"
},
{
"path": "samples/CSharp/Northwind/Category.cs",
"content": "using System;\nusing System.Collections.ObjectModel;\nusing DbExtensions;\n\nnamespace Samples.CSharp.Northwind {\n\n [Table(Name = \"Categories\")]\n public class Category {\n\n [Column(IsPrimaryKey = true, IsDbGenerated = true)]\n public int CategoryID { get; set; }\n\n [Column]\n public string CategoryName { get; set; }\n\n [Column]\n public string Description { get; set; }\n\n [Column]\n public byte[] Picture { get; set; }\n\n [Association(OtherKey = nameof(Product.CategoryID))]\n public Collection Products { get; } = new();\n }\n}\n"
},
{
"path": "samples/CSharp/Northwind/Customer.cs",
"content": "using System;\nusing System.Collections.ObjectModel;\nusing DbExtensions;\n\nnamespace Samples.CSharp.Northwind {\n\n [Table(Name = \"Customers\")]\n public class Customer {\n\n [Column(IsPrimaryKey = true)]\n public string CustomerID { get; set; }\n\n [Column]\n public string CompanyName { get; set; }\n\n [Column]\n public string ContactName { get; set; }\n\n [Column]\n public string ContactTitle { get; set; }\n\n [Column]\n public string Address { get; set; }\n\n [Column]\n public string City { get; set; }\n\n [Column]\n public string Region { get; set; }\n\n [Column]\n public string PostalCode { get; set; }\n\n [Column]\n public string Country { get; set; }\n\n [Column]\n public string Phone { get; set; }\n\n [Column]\n public string Fax { get; set; }\n\n [Association(OtherKey = nameof(CustomerCustomerDemo.CustomerID))]\n public Collection CustomerCustomerDemos { get; } = new();\n\n [Association(OtherKey = nameof(Order.CustomerID))]\n public Collection Orders { get; } = new();\n }\n}\n"
},
{
"path": "samples/CSharp/Northwind/CustomerCustomerDemo.cs",
"content": "using System;\nusing DbExtensions;\n\nnamespace Samples.CSharp.Northwind {\n\n [Table]\n public class CustomerCustomerDemo {\n\n [Column(IsPrimaryKey = true)]\n public string CustomerID { get; set; }\n\n [Column(IsPrimaryKey = true)]\n public string CustomerTypeID { get; set; }\n\n [Association(ThisKey = nameof(CustomerTypeID))]\n public CustomerDemographic CustomerDemographic { get; set; }\n\n [Association(ThisKey = nameof(CustomerID))]\n public Customer Customer { get; set; }\n }\n}\n"
},
{
"path": "samples/CSharp/Northwind/CustomerDemographic.cs",
"content": "using System;\nusing System.Collections.ObjectModel;\nusing DbExtensions;\n\nnamespace Samples.CSharp.Northwind {\n\n [Table(Name = \"CustomerDemographics\")]\n public class CustomerDemographic {\n\n [Column(IsPrimaryKey = true)]\n public string CustomerTypeID { get; set; }\n\n [Column]\n public string CustomerDesc { get; set; }\n\n [Association(OtherKey = nameof(CustomerCustomerDemo.CustomerTypeID))]\n public Collection CustomerCustomerDemos { get; } = new();\n }\n}\n"
},
{
"path": "samples/CSharp/Northwind/Employee.cs",
"content": "using System;\nusing System.Collections.ObjectModel;\nusing DbExtensions;\n\nnamespace Samples.CSharp.Northwind {\n\n [Table(Name = \"Employees\")]\n public class Employee {\n\n [Column(IsPrimaryKey = true, IsDbGenerated = true)]\n public int EmployeeID { get; set; }\n\n [Column]\n public string LastName { get; set; }\n\n [Column]\n public string FirstName { get; set; }\n\n [Column]\n public string Title { get; set; }\n\n [Column]\n public string TitleOfCourtesy { get; set; }\n\n [Column]\n public DateTime? BirthDate { get; set; }\n\n [Column]\n public DateTime? HireDate { get; set; }\n\n [Column]\n public string Address { get; set; }\n\n [Column]\n public string City { get; set; }\n\n [Column]\n public string Region { get; set; }\n\n [Column]\n public string PostalCode { get; set; }\n\n [Column]\n public string Country { get; set; }\n\n [Column]\n public string HomePhone { get; set; }\n\n [Column]\n public string Extension { get; set; }\n\n [Column]\n public byte[] Photo { get; set; }\n\n [Column]\n public string Notes { get; set; }\n\n [Column]\n public int? ReportsTo { get; set; }\n\n [Column]\n public string PhotoPath { get; set; }\n\n [Association(ThisKey = nameof(ReportsTo))]\n public Employee ReportsToEmployee { get; set; }\n\n [Association(OtherKey = nameof(Employee.ReportsTo))]\n public Collection Employees { get; } = new();\n\n [Association(OtherKey = nameof(EmployeeTerritory.EmployeeID))]\n public Collection EmployeeTerritories { get; } = new();\n\n [Association(OtherKey = nameof(Order.EmployeeID))]\n public Collection Orders { get; } = new();\n }\n}\n"
},
{
"path": "samples/CSharp/Northwind/EmployeeTerritory.cs",
"content": "using System;\nusing DbExtensions;\n\nnamespace Samples.CSharp.Northwind {\n\n [Table(Name = \"EmployeeTerritories\")]\n public class EmployeeTerritory {\n\n [Column(IsPrimaryKey = true)]\n public int EmployeeID { get; set; }\n\n [Column(IsPrimaryKey = true)]\n public string TerritoryID { get; set; }\n\n [Association(ThisKey = nameof(EmployeeID))]\n public Employee Employee { get; set; }\n\n [Association(ThisKey = nameof(TerritoryID))]\n public Territory Territory { get; set; }\n }\n}\n"
},
{
"path": "samples/CSharp/Northwind/NorthwindDatabase.cs",
"content": "using System;\nusing DbExtensions;\n\nnamespace Samples.CSharp.Northwind {\n\n public class NorthwindDatabase : Database {\n\n public SqlTable Products => Table();\n\n public SqlTable Orders => Table();\n\n public SqlTable OrderDetails => Table();\n\n public SqlTable Employees => Table();\n\n public SqlTable EmployeeTerritories => Table();\n\n public SqlTable Regions => Table();\n\n public NorthwindDatabase(string connectionString, string providerInvariantName)\n : base(connectionString, providerInvariantName) { }\n }\n}\n"
},
{
"path": "samples/CSharp/Northwind/Order.cs",
"content": "using System;\nusing System.Collections.ObjectModel;\nusing DbExtensions;\n\nnamespace Samples.CSharp.Northwind {\n\n [Table(Name = \"Orders\")]\n public class Order {\n\n [Column(IsPrimaryKey = true, IsDbGenerated = true)]\n public int OrderID { get; set; }\n\n [Column]\n public string CustomerID { get; set; }\n\n [Column]\n public int? EmployeeID { get; set; }\n\n [Column]\n public DateTime? OrderDate { get; set; }\n\n [Column]\n public DateTime? RequiredDate { get; set; }\n\n [Column]\n public DateTime? ShippedDate { get; set; }\n\n [Column]\n public int? ShipVia { get; set; }\n\n [Column]\n public decimal? Freight { get; set; }\n\n [Column]\n public string ShipName { get; set; }\n\n [Column]\n public string ShipAddress { get; set; }\n\n [Column]\n public string ShipCity { get; set; }\n\n [Column]\n public string ShipRegion { get; set; }\n\n [Column]\n public string ShipPostalCode { get; set; }\n\n [Column]\n public string ShipCountry { get; set; }\n\n [Association(OtherKey = nameof(OrderDetail.OrderID))]\n public Collection OrderDetails { get; } = new();\n\n [Association(ThisKey = nameof(CustomerID))]\n public Customer Customer { get; set; }\n\n [Association(ThisKey = nameof(EmployeeID))]\n public Employee Employee { get; set; }\n\n [Association(ThisKey = nameof(ShipVia))]\n public Shipper Shipper { get; set; }\n }\n}\n"
},
{
"path": "samples/CSharp/Northwind/OrderDetail.cs",
"content": "using System;\nusing DbExtensions;\n\nnamespace Samples.CSharp.Northwind {\n\n [Table(Name = \"Order Details\")]\n public class OrderDetail {\n\n [Column(IsPrimaryKey = true)]\n public int OrderID { get; set; }\n\n [Column(IsPrimaryKey = true)]\n public int ProductID { get; set; }\n\n [Column]\n public decimal UnitPrice { get; set; }\n\n [Column]\n public short Quantity { get; set; }\n\n [Column]\n public float Discount { get; set; }\n\n [Association(ThisKey = nameof(OrderID))]\n public Order Order { get; set; }\n\n [Association(ThisKey = nameof(ProductID))]\n public Product Product { get; set; }\n }\n}\n"
},
{
"path": "samples/CSharp/Northwind/Product.cs",
"content": "using System;\nusing System.Collections.ObjectModel;\nusing DbExtensions;\n\nnamespace Samples.CSharp.Northwind {\n\n [Table(Name = \"Products\")]\n public class Product {\n\n [Column(IsPrimaryKey = true, IsDbGenerated = true)]\n public int ProductID { get; set; }\n\n [Column]\n public string ProductName { get; set; }\n\n [Column]\n public int? SupplierID { get; set; }\n\n [Column]\n public int? CategoryID { get; set; }\n\n [Column]\n public string QuantityPerUnit { get; set; }\n\n [Column]\n public decimal? UnitPrice { get; set; }\n\n [Column]\n public short? UnitsInStock { get; set; }\n\n [Column]\n public short? UnitsOnOrder { get; set; }\n\n [Column]\n public short? ReorderLevel { get; set; }\n\n [Column]\n public bool Discontinued { get; set; }\n\n [Association(OtherKey = nameof(OrderDetail.ProductID))]\n public Collection OrderDetails { get; } = new();\n\n [Association(ThisKey = nameof(CategoryID))]\n public Category Category { get; set; }\n\n [Association(ThisKey = nameof(SupplierID))]\n public Supplier Supplier { get; set; }\n }\n}\n"
},
{
"path": "samples/CSharp/Northwind/Region.cs",
"content": "using System;\nusing System.Collections.ObjectModel;\nusing DbExtensions;\n\nnamespace Samples.CSharp.Northwind {\n\n [Table(Name = \"Region\")]\n public class Region {\n\n [Column(IsPrimaryKey = true)]\n public int RegionID { get; set; }\n\n [Column]\n public string RegionDescription { get; set; }\n\n [Association(OtherKey = nameof(Territory.RegionID))]\n public Collection Territories { get; } = new();\n }\n}\n"
},
{
"path": "samples/CSharp/Northwind/Shipper.cs",
"content": "using System;\nusing System.Collections.ObjectModel;\nusing DbExtensions;\n\nnamespace Samples.CSharp.Northwind {\n\n [Table(Name = \"Shippers\")]\n public class Shipper {\n\n [Column(IsPrimaryKey = true, IsDbGenerated = true)]\n public int ShipperID { get; set; }\n\n [Column]\n public string CompanyName { get; set; }\n\n [Column]\n public string Phone { get; set; }\n\n [Association(OtherKey = nameof(Order.ShipVia))]\n public Collection Orders { get; } = new();\n }\n}\n"
},
{
"path": "samples/CSharp/Northwind/Supplier.cs",
"content": "using System;\nusing System.Collections.ObjectModel;\nusing DbExtensions;\n\nnamespace Samples.CSharp.Northwind {\n\n [Table(Name = \"Suppliers\")]\n public class Supplier {\n\n [Column(IsPrimaryKey = true, IsDbGenerated = true)]\n public int SupplierID { get; set; }\n\n [Column]\n public string CompanyName { get; set; }\n\n [Column]\n public string ContactName { get; set; }\n\n [Column]\n public string ContactTitle { get; set; }\n\n [Column]\n public string Address { get; set; }\n\n [Column]\n public string City { get; set; }\n\n [Column]\n public string Region { get; set; }\n\n [Column]\n public string PostalCode { get; set; }\n\n [Column]\n public string Country { get; set; }\n\n [Column]\n public string Phone { get; set; }\n\n [Column]\n public string Fax { get; set; }\n\n [Association(OtherKey = nameof(Product.SupplierID))]\n public Collection Products { get; } = new();\n }\n}\n"
},
{
"path": "samples/CSharp/Northwind/Territory.cs",
"content": "using System;\nusing System.Collections.ObjectModel;\nusing DbExtensions;\n\nnamespace Samples.CSharp.Northwind {\n\n [Table(Name = \"Territories\")]\n public class Territory {\n\n [Column(IsPrimaryKey = true)]\n public string TerritoryID { get; set; }\n\n [Column]\n public string TerritoryDescription { get; set; }\n\n [Column]\n public int RegionID { get; set; }\n\n [Association(OtherKey = nameof(EmployeeTerritory.TerritoryID))]\n public Collection EmployeeTerritories { get; } = new();\n\n [Association(ThisKey = nameof(RegionID))]\n public Region Region { get; set; }\n }\n}\n"
},
{
"path": "samples/CSharp/Samples.CSharp.csproj",
"content": "\n\n \n net8.0 \n 12 \n \n\n \n \n\n \n"
},
{
"path": "samples/CSharp/SqlBuilder.cs",
"content": "using System;\nusing DbExtensions;\n\nnamespace Samples.CSharp {\n\n public class SqlBuilderSamples {\n\n#pragma warning disable CA1822\n public SqlBuilder DynamicSql_1() {\n return DynamicSql(2, 3);\n }\n\n public SqlBuilder DynamicSql_2() {\n return DynamicSql(null, 3);\n }\n\n public SqlBuilder DynamicSql_3() {\n return DynamicSql(2, null);\n }\n\n public SqlBuilder DynamicSql_4() {\n return DynamicSql(null, null);\n }\n\n SqlBuilder DynamicSql(int? categoryId, int? supplierId) {\n\n return SQL\n .SELECT(\"p.ProductID, p.ProductName\")\n .FROM(\"Products p\")\n .WHERE()\n ._If(categoryId.HasValue, $\"p.CategoryID = {categoryId.Value}\")\n ._If(supplierId.HasValue, $\"p.SupplierID = {supplierId.Value}\")\n .ORDER_BY(\"p.ProductName, p.ProductID DESC\");\n }\n\n public SqlBuilder Subquery() {\n\n return SQL\n .SELECT($\"o.OrderID, o.CustomerID, ({SQL\n .SELECT(\"COUNT(od.Quantity)\")\n .FROM(\"OrderDetails od\")\n .WHERE(\"od.OrderID = o.OrderID\")}) AS TotalItems\")\n .FROM(\"Orders o\");\n }\n\n public SqlBuilder ExtendRawSql() {\n\n return ((SqlBuilder)$\"\"\"\n SELECT ProductID, ProductName\n FROM Products\n \"\"\")\n .WHERE($\"CategoryID = {1}\");\n }\n\n public SqlBuilder ListArgument() {\n\n int[] range = { 1, 2, 3 };\n\n return SQL\n .SELECT(\"p.ProductID, p.CategoryID\")\n .FROM(\"Products p\")\n .WHERE($\"p.CategoryID = {1} AND p.ProductID IN ({range:list})\")\n ._($\"EXISTS ({SQL\n .SELECT(\"ProductID\")\n .FROM(\"OrderDetails\")\n .WHERE($\"OrderID = {77}\")})\")\n .GROUP_BY(\"p.ProductID\");\n }\n\n public SqlBuilder Insert() {\n\n return SQL\n .INSERT_INTO(\"Products(ProductName, UnitPrice, CategoryID)\")\n .VALUES(\"Chai\", 15.56, 5);\n }\n\n public SqlBuilder Update() {\n\n return SQL\n .UPDATE(\"Products\")\n .SET($\"Discontinued = {true}\")\n .WHERE($\"ProductID = {1}\");\n }\n\n public SqlBuilder UpdateWithSubquery() {\n\n return SQL\n .UPDATE(\"Products p\")\n .SET($\"p.Discontinued = {true}\")\n .WHERE($\"p.ProductID = ({SQL\n .SELECT(\"p2.ProductID\")\n .FROM(\"Products p2\")\n .WHERE(\"p2.ProductID <> p.ProductID\")})\");\n }\n\n public SqlBuilder Delete() {\n\n return SQL\n .DELETE_FROM(\"Products\")\n .WHERE($\"ProductID = {1}\");\n }\n\n /// \n /// SELECT Products.*, Categories.CategoryName\n /// FROM Categories INNER JOIN Products ON Categories.CategoryID = Products.CategoryID\n /// WHERE (((Products.Discontinued)=0))\n /// \n /// Northwind.Alphabetical list of products \n\n public SqlBuilder AlphabeticalListOfProducts() {\n\n return SQL\n .SELECT(\"Products.*, Categories.CategoryName\")\n .FROM(\"Categories\")\n .LEFT_JOIN(\"Products ON Categories.CategoryID = Products.CategoryID\")\n .WHERE($\"Products.Discontinued = {0}\");\n }\n\n /// \n /// SELECT City, CompanyName, ContactName, 'Customers' AS Relationship \n /// FROM Customers\n /// UNION SELECT City, CompanyName, ContactName, 'Suppliers'\n /// FROM Suppliers\n /// \n /// Northwind.Customer and Suppliers by City \n\n public SqlBuilder CustomersAndSuppliersByCity() {\n\n return SQL\n .SELECT(\"City, CompanyName, ContactName, 'Customers' AS Relationship\")\n .FROM(\"Customers\")\n .UNION()\n .SELECT(\"City, CompanyName, ContactName, 'Suppliers'\")\n .FROM(\"Suppliers\");\n }\n\n /// \n /// SELECT Products.ProductName, Products.UnitPrice\n /// FROM Products\n /// WHERE Products.UnitPrice > (SELECT AVG(UnitPrice) From Products)\n /// \n /// Northwind.Products Above Average Price \n\n public SqlBuilder ProductsAboveAveragePrice() {\n\n return SQL\n .SELECT(\"Products.ProductName, Products.UnitPrice\")\n .FROM(\"Products\")\n .WHERE($\"Products.UnitPrice > ({SQL\n .SELECT(\"AVG(UnitPrice)\")\n .FROM(\"Products\")})\");\n }\n\n /// \n /// SELECT Categories.CategoryName, Products.ProductName, \n /// Sum(CONVERT(money,(\"Order Details\".UnitPrice*Quantity*(1-Discount)/100))*100) AS ProductSales\n /// FROM (Categories INNER JOIN Products ON Categories.CategoryID = Products.CategoryID) \n /// INNER JOIN (Orders \n /// INNER JOIN \"Order Details\" ON Orders.OrderID = \"Order Details\".OrderID) \n /// ON Products.ProductID = \"Order Details\".ProductID\n /// WHERE (((Orders.ShippedDate) Between '19970101' And '19971231'))\n /// GROUP BY Categories.CategoryName, Products.ProductName\n /// \n /// Northwind.Product Sales for 1997 \n\n public SqlBuilder ProductSalesFor1997() {\n\n return SQL\n .SELECT(\"Categories.CategoryName, Products.ProductName, Sum(CONVERT(money,(\\\"Order Details\\\".UnitPrice*Quantity*(1-Discount)/100))*100) AS ProductSales\")\n .FROM(\"(Categories\").INNER_JOIN(\"Products ON Categories.CategoryID = Products.CategoryID)\")\n .INNER_JOIN(\"(Orders\").INNER_JOIN(\"\\\"Order Details\\\" ON Orders.OrderID = \\\"Order Details\\\".OrderID) ON Products.ProductID = \\\"Order Details\\\".ProductID\")\n .WHERE($\"(((Orders.ShippedDate) Between {new DateTime(1997, 1, 1)} And {new DateTime(1997, 12, 31)}))\")\n .GROUP_BY(\"Categories.CategoryName, Products.ProductName\");\n }\n }\n}\n"
},
{
"path": "samples/CSharp/SqlSet.cs",
"content": "using System;\nusing System.Collections;\nusing System.Collections.Generic;\nusing DbExtensions;\nusing Samples.CSharp.Northwind;\n\nnamespace Samples.CSharp {\n \n public class SqlSetSamples {\n\n readonly SqlSet products;\n\n public SqlSetSamples(Database db) {\n this.products = db.From(\"Products\");\n }\n\n public bool AreThereAnyProducts() {\n return products.Any();\n }\n\n public bool DoAllProductsHaveUnitPrice() {\n return products.All(\"NOT UnitPrice IS NULL\");\n }\n\n public bool DoSomeProductsAreOutOfStock() {\n return products.Any(\"UnitsInStock = 0\");\n }\n\n public int HowManyProductsAreOutOfStock() {\n return products.Count(\"UnitsInStock = 0\");\n }\n\n public Product FirstProduct() {\n return products.First();\n }\n\n public Product SecondProduct() {\n return products.Skip(1).First();\n }\n\n public Product FirstOutOfStockProduct() {\n return products.First(\"UnitsInStock = 0\");\n }\n\n public IEnumerable Top5ProductsWithLowestStock() {\n \n return products\n .Where(\"UnitsInStock > 0\")\n .OrderBy(\"UnitsInStock\")\n .Take(5)\n .Select(\"ProductName, UnitsInStock\",\n r => new { Name = r.GetString(0), UnitsInStock = r.GetInt16(1) })\n .AsEnumerable();\n }\n\n public IEnumerable NamesOfOutOfStockProducts() {\n \n return products\n .Where(\"UnitsInStock = 0\")\n .Select(\"ProductName\", r => r.GetString(0))\n .AsEnumerable();\n }\n\n public Product GetSpecificProduct() {\n return products.SingleOrDefault(\"ProductID = 5\");\n }\n }\n}\n"
},
{
"path": "src/DbExtensions/.editorconfig",
"content": "[*.cs]\n\n# CA2007: Consider calling ConfigureAwait on the awaited task\ndotnet_diagnostic.CA2007.severity = warning\n"
},
{
"path": "src/DbExtensions/Attributes.cs",
"content": "// Copyright 2016-2025 Max Toro Q.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#region Based on code from .NET Framework\n#endregion\n\nusing System;\n\nnamespace DbExtensions;\n\n#nullable enable\n\n[AttributeUsage(AttributeTargets.Class)]\nsealed class DatabaseAttribute : Attribute {\n\n public string?\n Name { get; set; }\n}\n\n/// \n/// Designates a class as an entity class that is associated with a database table.\n/// \n\n[AttributeUsage(AttributeTargets.Class, Inherited = false)]\npublic sealed class TableAttribute : Attribute {\n\n /// \n /// Gets or sets the name of the table or view.\n /// \n\n public string?\n Name { get; set; }\n}\n\n/// \n/// Associates a property with a column in a database table.\n/// \n\n[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]\npublic sealed class ColumnAttribute : Attribute, IDataAttribute {\n\n bool\n _canBeNull = true;\n\n bool\n _canBeNullSet = false;\n\n /// \n /// Gets or sets the name of a column.\n /// \n\n public string?\n Name { get; set; }\n\n /// \n /// Gets or sets a private storage field to hold the value from a column.\n /// \n\n string?\n IDataAttribute.Storage { get; set; }\n\n /// \n /// Gets or sets the type of the database column.\n /// \n\n internal string?\n DbType { get; set; }\n\n /// \n /// Gets or sets the type to convert this member to before sending to the database.\n /// \n\n public Type?\n ConvertTo { get; set; }\n\n internal string?\n Expression { get; set; }\n\n /// \n /// Gets or sets whether this class member represents a column that is part or all of the primary key of the table.\n /// \n\n public bool\n IsPrimaryKey { get; set; }\n\n /// \n /// Gets or sets whether a column contains values that the database auto-generates.\n /// \n\n public bool\n IsDbGenerated { get; set; }\n\n /// \n /// Gets or sets whether the column type of the member is a database timestamp or version number.\n /// \n\n public bool\n IsVersion { get; set; }\n\n internal UpdateCheck\n UpdateCheck { get; set; } = UpdateCheck.Always;\n\n /// \n /// Gets or sets the enumeration.\n /// \n\n public AutoSync\n AutoSync { get; set; } = AutoSync.Default;\n\n internal bool\n IsDiscriminator { get; set; }\n\n internal bool\n CanBeNull {\n get => _canBeNull;\n set {\n _canBeNullSet = true;\n _canBeNull = value;\n }\n }\n\n internal bool\n CanBeNullSet => _canBeNullSet;\n}\n\ninternal enum UpdateCheck {\n Always,\n Never,\n WhenChanged\n}\n\n/// \n/// Used to specify for during INSERT and UPDATE operations when\n/// a data member should be read back after the operation completes.\n/// \n\npublic enum AutoSync {\n\n /// \n /// Automatically selects the value.\n /// \n\n Default = 0, // Automatically choose\n\n /// \n /// Always returns the value.\n /// \n\n Always = 1,\n\n /// \n /// Never returns the value.\n /// \n\n Never = 2,\n\n /// \n /// Returns the value only after an INSERT operation.\n /// \n\n OnInsert = 3,\n\n /// \n /// Returns the value only after an UPDATE operation.\n /// \n\n OnUpdate = 4\n}\n\n/// \n/// Designates a property to represent a database association, such as a foreign key relationship.\n/// \n\n[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]\npublic sealed class AssociationAttribute : Attribute, IDataAttribute {\n\n /// \n /// Gets or sets the name of a constraint.\n /// \n\n public string?\n Name { get; set; }\n\n /// \n /// Gets or sets a private storage field to hold the value for the association property.\n /// \n\n string?\n IDataAttribute.Storage { get; set; }\n\n /// \n /// Gets or sets members of this entity class to represent the key values on this side of the association.\n /// \n\n public string?\n ThisKey { get; set; }\n\n /// \n /// Gets or sets one or more members of the target entity class as key values on the other side of the association.\n /// \n\n public string?\n OtherKey { get; set; }\n\n /// \n /// Gets or sets the indication of a uniqueness constraint on the foreign key.\n /// \n /// When true, this property indicates a true 1:1 relationship. \n\n internal bool\n IsUnique { get; set; }\n\n /// \n /// Gets or sets the member as the foreign key in an association representing a database relationship.\n /// \n\n internal bool\n IsForeignKey { get; set; }\n\n internal string?\n DeleteRule { get; set; }\n\n internal bool\n DeleteOnNull { get; set; }\n}\n\n/// \n/// Class attribute used to describe an inheritance hierarchy to be mapped.\n/// For example, \n/// \n/// [Table(Name = \"People\")]\n/// [InheritanceMapping(\"P\", typeof(Person), IsDefault=true)]\n/// [InheritanceMapping(\"C\", typeof(Customer))]\n/// [InheritanceMapping(\"E\", typeof(Employee))]\n/// class Person { ... }\n/// \n/// \n\n[AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = false)]\nsealed class InheritanceMappingAttribute : Attribute {\n\n /// \n /// Discriminator value in store column for this type.\n /// \n\n public object\n Code { get; }\n\n /// \n /// Type to instantiate when Key is matched.\n /// \n\n public Type\n Type { get; }\n\n /// \n /// If discriminator value in store column is unrecognized then instantiate this type.\n /// \n\n public bool\n IsDefault { get; set; }\n\n public\n InheritanceMappingAttribute(object code, Type type) {\n\n ArgumentNullException.ThrowIfNull(code);\n ArgumentNullException.ThrowIfNull(type);\n\n this.Code = code;\n this.Type = type;\n }\n}\n\ninterface IDataAttribute {\n\n string?\n Name { get; set; }\n\n string?\n Storage { get; set; }\n}\n\n/// \n/// Designates a property as a complex property that groups columns of a table that share the same base name.\n/// \n\n[AttributeUsage(AttributeTargets.Property)]\npublic sealed class ComplexPropertyAttribute : Attribute {\n\n /// \n /// The base name for the columns on the complex property.\n /// The default is the property name.\n /// \n\n public string?\n Name { get; set; }\n\n /// \n /// The separator to use between the base name and the complex property's columns.\n /// The default is null, which means the separator is taken from .\n /// To use no separator and override the default configuration, use an empty .\n /// \n\n public string?\n Separator { get; set; }\n\n /// \n /// Initializes a new instance of the class\n /// \n\n public\n ComplexPropertyAttribute() { }\n\n internal\n ComplexPropertyAttribute(ComplexPropertyAttribute other) {\n this.Name = other.Name;\n this.Separator = other.Separator;\n }\n}\n"
},
{
"path": "src/DbExtensions/Database.cs",
"content": "// Copyright 2009-2025 Max Toro Q.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nusing System;\nusing System.Collections;\nusing System.Collections.Generic;\nusing System.ComponentModel;\nusing System.Data;\nusing System.Data.Common;\nusing System.Diagnostics.CodeAnalysis;\nusing System.Globalization;\nusing System.IO;\nusing System.Reflection;\nusing System.Text;\nusing System.Threading;\nusing System.Threading.Tasks;\n\nnamespace DbExtensions;\n\n#nullable enable\n\n#if DBEX_QE\n/// \n/// Provides simple data access using and .\n/// \n#else\n/// \n/// Provides simple data access using , and \"/>.\n/// \n#endif\n\npublic partial class Database : IDisposable {\n\n readonly bool\n _disposeConn;\n\n /// \n /// Gets the connection to associate with new commands.\n /// \n\n public DbConnection\n Connection { get; }\n\n /// \n /// Gets or sets a transaction to associate with new commands.\n /// \t\t\n\n public DbTransaction?\n Transaction { get; set; }\n\n /// \n /// Provides access to configuration options for this instance. \n /// \n\n public DatabaseConfiguration\n Configuration { get; private set; }\n\n /// \n /// Initializes a new instance of the class\n /// using the provided connection string and provider's invariant name.\n /// \n /// \n /// Initializes a new instance of the class\n /// using the provided connection.\n /// \n /// \n /// Opens (if it's not open) and returns an object\n /// you can use to close it (if it wasn't open).\n /// \n /// An object to close the connection. \n /// \n /// Use this method with the using statement in C# or Visual Basic to ensure that a block of code\n /// is always executed with an open connection.\n /// \n /// \n /// \n /// using (db.EnsureConnectionOpen()) {\n /// // Execute commands.\n /// }\n /// \n /// \n\n public IDisposable\n EnsureConnectionOpen() {\n\n var conn = this.Connection;\n var wasClosed = (conn.State == ConnectionState.Closed);\n\n if (wasClosed) {\n conn.Open();\n }\n\n return new WrappedConnection((wasClosed) ? conn : null);\n }\n\n /// \n /// Opens (if it's not open) and returns an object\n /// you can use to close it (if it wasn't open).\n /// \n /// to monitor for cancellation requests. The default is .\n /// An object to close the connection. \n /// \n /// Use this method with the using statement in C# or Visual Basic to ensure that a block of code\n /// is always executed with an open connection.\n /// \n /// \n /// \n /// await using (await db.EnsureConnectionOpenAsync()) {\n /// // Execute commands.\n /// }\n /// \n /// \n\n public async ValueTask\n EnsureConnectionOpenAsync(CancellationToken cancellationToken = default) {\n\n var conn = this.Connection;\n var wasClosed = (conn.State == ConnectionState.Closed);\n\n if (wasClosed) {\n\n await conn.OpenAsync(cancellationToken)\n .ConfigureAwait(false);\n }\n\n return new WrappedConnection((wasClosed) ? conn : null);\n }\n\n /// \n /// Returns a virtual transaction that you can use to ensure a code block is always executed in \n /// a transaction, new or existing.\n /// \n /// \n /// A virtual transaction you can use to ensure a code block is always executed in \n /// a transaction, new or existing.\n /// \n /// \n /// This method returns a virtual transaction that wraps an existing or new transaction.\n /// By calling on the returned object, this object\n /// will then call on the wrapped transaction if the\n /// transaction was just created, or do nothing if it was previously created.\n /// \n /// \n /// \n /// Calls to this method can be nested, like in the following example:\n /// \n /// \n /// void DoSomething() {\n /// \n /// using (var tx = this.db.EnsureInTransaction()) {\n /// \n /// // Execute commands\n /// \n /// DoSomethingElse();\n /// \n /// tx.Commit();\n /// }\n /// }\n /// \n /// void DoSomethingElse() { \n /// \n /// using (var tx = this.db.EnsureInTransaction()) {\n /// \n /// // Execute commands\n /// \n /// tx.Commit();\n /// }\n /// }\n /// \n /// \n\n public DbTransaction\n EnsureInTransaction() =>\n EnsureInTransaction(IsolationLevel.Unspecified);\n\n /// \n /// \n /// \n /// \n /// \n /// Calls to this method can be nested, like in the following example:\n /// \n /// \n /// async Task DoSomething() {\n /// \n /// await using (var tx = await this.db.EnsureInTransactionAsync()) {\n /// \n /// // Execute commands\n /// \n /// await DoSomethingElse();\n /// \n /// await tx.CommitAsync();\n /// }\n /// }\n /// \n /// async Task DoSomethingElse() {\n /// \n /// await using (var tx = await this.db.EnsureInTransactionAsync()) {\n /// \n /// // Execute commands\n /// \n /// await tx.CommitAsync();\n /// }\n /// }\n /// \n /// \n\n public ValueTask\n EnsureInTransactionAsync(CancellationToken cancellationToken = default) =>\n EnsureInTransactionAsync(IsolationLevel.Unspecified, cancellationToken);\n\n /// \n /// \n\n public virtual async ValueTask\n EnsureInTransactionAsync(IsolationLevel isolationLevel, CancellationToken cancellationToken = default) {\n\n var connHolder = (WrappedConnection)EnsureConnectionOpen();\n var newTx = default(DbTransaction);\n\n try {\n\n if (this.Transaction is null) {\n\n this.Transaction = (newTx = await this.Connection.BeginTransactionAsync(isolationLevel, cancellationToken)\n .ConfigureAwait(false));\n\n this.Configuration.Log?.WriteLine(\"-- TRANSACTION STARTED\");\n }\n\n } catch {\n\n await connHolder.DisposeAsync()\n .ConfigureAwait(false);\n\n throw;\n }\n\n if (newTx != null) {\n return new WrappedTransaction(this, newTx, connHolder);\n }\n\n return new NoOpTransaction(this.Connection, isolationLevel, connHolder);\n }\n\n /// \n /// Executes the command. Optionally uses a transaction and validates\n /// affected records value before committing.\n /// \n /// true if the number of affected records should exactly match ; false if a lower number is acceptable.\n /// The number of affected records. \n /// The number of affected records is not equal to . \n\n public int\n Execute(SqlBuilder nonQuery, int affect = -1, bool exact = false) {\n\n ArgumentNullException.ThrowIfNull(nonQuery);\n\n var command = CreateCommand(nonQuery);\n var validateAffected = affect > -1;\n\n using var conn = EnsureConnectionOpen();\n using var tx = (validateAffected) ? EnsureInTransaction() : null;\n\n command.Transaction = this.Transaction;\n\n int affectedRecords;\n\n try {\n affectedRecords = command.ExecuteNonQuery();\n } catch {\n\n Trace(command, error: true);\n throw;\n }\n\n OnExecuted(command, affect, exact, validateAffected, affectedRecords);\n\n tx?.Commit();\n\n return affectedRecords;\n }\n\n /// \n /// \n\n public async ValueTask\n ExecuteAsync(SqlBuilder nonQuery, int affect = -1, bool exact = false, CancellationToken cancellationToken = default) {\n\n ArgumentNullException.ThrowIfNull(nonQuery);\n\n var command = CreateCommand(nonQuery);\n var validateAffected = affect > -1;\n\n await using var conn = (await EnsureConnectionOpenAsync(cancellationToken)\n .ConfigureAwait(false))\n .ConfigureAwait(false);\n\n var tx = (validateAffected) ?\n await EnsureInTransactionAsync(cancellationToken).ConfigureAwait(false)\n : new NoOpTransaction(this.Connection, IsolationLevel.Unspecified, new WrappedConnection(null));\n\n await using var txDisp = tx.ConfigureAwait(false);\n\n command.Transaction = this.Transaction;\n\n int affectedRecords;\n\n try {\n\n affectedRecords = await command.ExecuteNonQueryAsync(cancellationToken)\n .ConfigureAwait(false);\n\n } catch {\n\n Trace(command, error: true);\n throw;\n }\n\n OnExecuted(command, affect, exact, validateAffected, affectedRecords);\n\n await tx.CommitAsync(cancellationToken)\n .ConfigureAwait(false);\n\n return affectedRecords;\n }\n\n void\n OnExecuted(DbCommand command, int affect, bool exact, bool validateAffected, int affectedRecords) {\n\n Trace(command, affectedRecords);\n\n if (validateAffected\n && affectedRecords != affect) {\n\n if (exact) {\n\n throw new ChangeConflictException(String.Create(\n CultureInfo.InvariantCulture,\n $\"The number of affected records should be {affect}, the actual number is {affectedRecords}.\"));\n\n } else if (affectedRecords > affect) {\n\n throw new ChangeConflictException(String.Create(\n CultureInfo.InvariantCulture,\n $\"The number of affected records should be {affect} or lower, the actual number is {affectedRecords}.\"));\n }\n }\n }\n\n /// \n /// Maps the results of the to objects,\n /// using the provided delegate.\n /// \n /// The type of objects to map the results to. \n /// objects from an object.\n /// The results of the query as objects. \n\n public IEnumerable\n Map(SqlBuilder query, Func mapper) {\n\n ArgumentNullException.ThrowIfNull(query);\n ArgumentNullException.ThrowIfNull(mapper);\n\n return new MappingEnumerable(CreateCommand(query), mapper, this.Configuration.Log);\n }\n\n /// (SqlBuilder, Func<DbDataReader, TResult>)\"/>\n\n public IAsyncEnumerable\n AsyncMap(SqlBuilder query, Func mapper) {\n\n ArgumentNullException.ThrowIfNull(query);\n ArgumentNullException.ThrowIfNull(mapper);\n\n return new AsyncMappingEnumerable(CreateCommand(query), mapper, this.Configuration.Log);\n }\n\n /// \n /// Gets the identity value of the last inserted record.\n /// \n /// The identity value of the last inserted record. \n /// \n /// It is very important to keep the connection open between the last \n /// command and this one, or else you might get the wrong value.\n /// \n\n public virtual object?\n LastInsertId() {\n\n var sql = this.Configuration.LastInsertIdCommand;\n\n if (String.IsNullOrEmpty(sql)) {\n throw new InvalidOperationException(\"Configuration.LastInsertIdCommand cannot be null or empty.\");\n }\n\n var command = CreateCommand(new SqlBuilder(sql.Length, 0).Append(sql));\n var value = command.ExecuteScalar();\n\n Trace(command);\n\n return value;\n }\n\n /// \n /// \n\n public virtual async ValueTask\n LastInsertIdAsync(CancellationToken cancellationToken = default) {\n\n var sql = this.Configuration.LastInsertIdCommand;\n\n if (String.IsNullOrEmpty(sql)) {\n throw new InvalidOperationException(\"Configuration.LastInsertIdCommand cannot be null or empty.\");\n }\n\n var command = CreateCommand(new SqlBuilder(sql.Length, 0).Append(sql));\n var value = await command.ExecuteScalarAsync(cancellationToken)\n .ConfigureAwait(false);\n\n Trace(command);\n\n return value;\n }\n\n /// \n /// Creates and returns a object from the specified .\n /// \n /// that provides the command's text and parameters.\n /// \n /// A new object with its property\n /// initialized with the 's string representation, and its \n /// property is initialized with the values from the property of the parameter.\n /// \n\n public virtual DbCommand\n CreateCommand(SqlBuilder sqlBuilder) {\n\n ArgumentNullException.ThrowIfNull(sqlBuilder);\n\n var command = this.Connection.CreateCommand();\n\n var format = sqlBuilder.ToString();\n var parameters = sqlBuilder.ParameterValues;\n\n if (this.Transaction is { } tx) {\n command.Transaction = tx;\n }\n\n if (this.Configuration.CommandTimeout is { } timeout and > -1) {\n command.CommandTimeout = timeout;\n }\n\n if (parameters is null or { Count: 0 }) {\n command.CommandText = format;\n return command;\n }\n\n var paramPlaceholders = new object[parameters.Count];\n\n for (int i = 0; i < paramPlaceholders.Length; i++) {\n\n var paramValue = parameters[i];\n\n var dbParam = paramValue as DbParameter;\n\n if (dbParam is null) {\n dbParam = command.CreateParameter();\n dbParam.Value = paramValue ?? DBNull.Value;\n }\n\n dbParam.ParameterName = this.Configuration.ParameterNameBuilder\n .Invoke($\"p{i}\");\n\n command.Parameters.Add(dbParam);\n\n paramPlaceholders[i] = this.Configuration.ParameterPlaceholderBuilder\n .Invoke(dbParam.ParameterName);\n }\n\n command.CommandText = String.Format(CultureInfo.InvariantCulture, format, paramPlaceholders);\n\n return command;\n }\n\n /// \n /// Given an unquoted identifier in the correct catalog case, returns the correct quoted form of that identifier.\n /// \n /// The quoted version of the identifier. If the indentifier is already quoted it's returned unchanged. \n\n public string\n QuoteIdentifier(string identifier) {\n\n QuoteIdentifierImpl(identifier, out var quotePrefix, out var quoteSuffix);\n\n return String.Concat(quotePrefix, identifier, quoteSuffix);\n }\n\n internal void\n QuoteIdentifier(StringBuilder sb, string identifier) {\n\n QuoteIdentifierImpl(identifier, out var quotePrefix, out var quoteSuffix);\n\n sb.Append(quotePrefix);\n sb.Append(identifier);\n sb.Append(quoteSuffix);\n }\n\n void\n QuoteIdentifierImpl(string identifier, out string quotePrefix, out string quoteSuffix) {\n\n ArgumentNullException.ThrowIfNull(identifier);\n\n quotePrefix = this.Configuration.QuotePrefix;\n quoteSuffix = this.Configuration.QuoteSuffix;\n\n if (quotePrefix.Length == 0\n && quoteSuffix.Length == 0) {\n\n return;\n }\n\n if (identifier.StartsWith(quotePrefix, StringComparison.Ordinal)\n && identifier.EndsWith(quoteSuffix, StringComparison.Ordinal)) {\n\n quotePrefix = String.Empty;\n quoteSuffix = String.Empty;\n }\n }\n\n internal void\n Trace(DbCommand command, int? affectedRecords = null, bool error = false) =>\n Trace(command, this.Configuration.Log, affectedRecords, error);\n\n internal static void\n Trace(DbCommand command, TextWriter? log, int? affectedRecords = null, bool error = false) {\n\n if (log is not null) {\n\n log.WriteLine();\n\n if (error) {\n log.WriteLine(\"-- ERROR: The following command produced an error\");\n }\n\n log.WriteLine(command.CommandText);\n\n for (int i = 0; i < command.Parameters.Count; i++) {\n\n var param = command.Parameters[i];\n\n if (param is not null) {\n log.WriteLine(String.Create(log.FormatProvider, $\"-- {param.ParameterName}: {param.Direction} {param.DbType} (Size = {param.Size}) [{param.Value}]\"));\n }\n }\n\n if (affectedRecords is not null) {\n log.WriteLine(String.Create(log.FormatProvider, $\"-- [{affectedRecords.Value}] records affected.\"));\n }\n }\n }\n\n /// \n /// Releases all resources used by the current instance of the class.\n /// \n\n public void\n Dispose() {\n\n Dispose(true);\n GC.SuppressFinalize(this);\n }\n\n /// \n /// Releases the resources used by this instance.\n /// \n /// true if this method is being called due to a call to ; otherwise, false .\n /// \n\n protected virtual void\n Dispose(bool disposing) {\n\n if (disposing) {\n\n if (_disposeConn) {\n this.Connection?.Dispose();\n }\n }\n }\n\n // Object Members\n\n /// \n/// Holds configuration options that customize the behavior of .\n/// This class cannot be instantiated, to get an instance use the property.\n/// \n\npublic sealed partial class DatabaseConfiguration {\n\n static readonly Func\n _getParameterNameI = (Func)\n Delegate.CreateDelegate(typeof(Func), typeof(DbCommandBuilder)\n .GetMethod(\"GetParameterName\", BindingFlags.Instance | BindingFlags.NonPublic, Type.DefaultBinder, [typeof(int)], null)!);\n\n static readonly Func\n _getParameterNameS = (Func)\n Delegate.CreateDelegate(typeof(Func), typeof(DbCommandBuilder)\n .GetMethod(\"GetParameterName\", BindingFlags.Instance | BindingFlags.NonPublic, Type.DefaultBinder, [typeof(string)], null)!);\n\n static readonly Func\n _getParameterPlaceholder = (Func