From 9a2939d35396aa22e7599209ed2a0578a3b61fb0 Mon Sep 17 00:00:00 2001 From: Steve Smith Date: Wed, 12 Jan 2022 12:20:54 -0500 Subject: [PATCH] Ardalis/doc ignorequeryfilters (#212) * clean up files; add doc for ignorequeryfilters * update nav_orders --- azure-pipelines.yml.obsolete | 112 ---------------------------- docs/features/ignorequeryfilters.md | 28 +++++++ docs/features/include.md | 2 +- docs/features/search.md | 2 +- docs/features/then-include.md | 2 +- nuget.txt | 6 -- 6 files changed, 31 insertions(+), 121 deletions(-) delete mode 100644 azure-pipelines.yml.obsolete create mode 100644 docs/features/ignorequeryfilters.md delete mode 100644 nuget.txt diff --git a/azure-pipelines.yml.obsolete b/azure-pipelines.yml.obsolete deleted file mode 100644 index 09ce0958..00000000 --- a/azure-pipelines.yml.obsolete +++ /dev/null @@ -1,112 +0,0 @@ -trigger: - branches: - include: - - master - - refs/tags/* -pr: -- master - -pool: - # vmImage: 'windows-2019' - vmImage: 'ubuntu-16.04' - -variables: - buildConfiguration: 'Release' - buildPlatform: 'Any CPU' - solution: '**/*.sln' - disable.coverage.autogenerate: 'true' - -steps: - -- task: DotNetCoreCLI@2 - displayName: 'dotnet info' - inputs: - command: custom - custom: '--info' - -- task: DotNetCoreCLI@2 - displayName: 'dotnet version' - inputs: - command: custom - custom: '--version' - -- task: NuGetToolInstaller@0 - displayName: 'Use NuGet 4.9.3' - inputs: - versionSpec: 4.9.3 - -- task: NuGetCommand@2 - inputs: - restoreSolution: '$(solution)' - -# Build -- task: DotNetCoreCLI@2 - displayName: 'Build solution' - inputs: - command: 'build' - #solution: '$(solution)' - #platform: '$(buildPlatform)' - configuration: '$(buildConfiguration)' - arguments: '--output $(Build.ArtifactStagingDirectory)' - -- script: dir - workingDirectory: $(Build.ArtifactStagingDirectory) - displayName: List output folder contents - -# Test with Coverage - -- script: docker-compose up --abort-on-container-exit - displayName: Run Docker Compose Up - -# Bug Workaround: https://github.com/microsoft/azure-pipelines-tasks/issues/8762 -#- script: sudo mkdir -p $(Build.SourcesDirectory)/TestResults/coverage/summary$(Build.BuildId) -# displayName: Create summary folder - -# Publish the code coverage result (summary and web site) -# The summary allows to view the coverage percentage in the summary tab -# The web site allows to view which lines are covered directly in Azure Pipeline - -#- script: dir -# workingDirectory: $(Build.SourcesDirectory) -# displayName: List root folder contents - -#- script: dir -# workingDirectory: $(Build.SourcesDirectory)/TestResults -# displayName: List root/TestResults folder contents - -#- script: dir -# workingDirectory: $(Build.SourcesDirectory)/TestResults/coverage -# displayName: List root/TestResults/coverage folder contents - -#- script: chmod 777 . -R -# workingDirectory: $(Build.SourcesDirectory) - -- task: PublishTestResults@1 - displayName: 'Publish test results' - inputs: - testResultsFormat: VSTest - testResultsFiles: '**/TEST-*.trx' - -#- task: PublishCodeCoverageResults@1 -# displayName: 'Publish code coverage' -# inputs: -# codeCoverageTool: Cobertura -# summaryFileLocation: '$(Build.SourcesDirectory)/TestResults/coverage/Cobertura.xml' -# reportDirectory: '$(Build.SourcesDirectory)/TestResults/coverage' - -- task: CopyFiles@2 - displayName: 'Copy *.nupkg Files (from artifact directory to Package folder)' - inputs: - SourceFolder: '$(Build.ArtifactStagingDirectory)' - Contents: '**/*.nupkg' - TargetFolder: '$(Build.ArtifactStagingDirectory)/Package' - flattenFolders: true - condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) - -# Publish -- task: PublishBuildArtifacts@1 - displayName: 'Publish Artifact' - inputs: - PathtoPublish: '$(Build.ArtifactStagingDirectory)/Package' - artifactName: Package - condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) diff --git a/docs/features/ignorequeryfilters.md b/docs/features/ignorequeryfilters.md new file mode 100644 index 00000000..192c4c57 --- /dev/null +++ b/docs/features/ignorequeryfilters.md @@ -0,0 +1,28 @@ +--- +layout: default +title: IgnoreQueryFilters +nav_order: 3 +has_children: false +parent: ORM-Specific Features +grand_parent: Features +--- + +# IgnoreQueryFilters + +The `IgnoreQueryFilters` feature is used to indicate to EF Core (it is not supported by EF 6) that it should ignore global query filters for this query. It simply passes along this call to the underlying [EF Core feature for disabling global filters](https://docs.microsoft.com/ef/core/querying/filters#disabling-filters). + +## Sample + +The following specification implements the `IgnoreQueryFilters()` expression: + +```csharp +public class CompanyByIdIgnoreQueryFilters : Specification, ISingleResultSpecification +{ + public CompanyByIdIgnoreQueryFilters(int id) + { + Query + .Where(company => company.Id == id) + .IgnoreQueryFilters(); + } +} +``` diff --git a/docs/features/include.md b/docs/features/include.md index bbb22dab..e3ef1fbf 100644 --- a/docs/features/include.md +++ b/docs/features/include.md @@ -1,7 +1,7 @@ --- layout: default title: Include -nav_order: 3 +nav_order: 4 has_children: false parent: ORM-Specific Features grand_parent: Features diff --git a/docs/features/search.md b/docs/features/search.md index cca0a736..423aab9c 100644 --- a/docs/features/search.md +++ b/docs/features/search.md @@ -1,7 +1,7 @@ --- layout: default title: Search -nav_order: 5 +nav_order: 6 has_children: false parent: ORM-Specific Features grand_parent: Features diff --git a/docs/features/then-include.md b/docs/features/then-include.md index 9fc1b18e..0731e198 100644 --- a/docs/features/then-include.md +++ b/docs/features/then-include.md @@ -1,7 +1,7 @@ --- layout: default title: ThenInclude -nav_order: 4 +nav_order: 5 has_children: false parent: ORM-Specific Features grand_parent: Features diff --git a/nuget.txt b/nuget.txt deleted file mode 100644 index a20f7bff..00000000 --- a/nuget.txt +++ /dev/null @@ -1,6 +0,0 @@ -dotnet build -c release - -dotnet pack -c release /p:Version=1.0.0 - --- from /bin/release folder -dotnet nuget push -s https://www.nuget.org/api/v2/package -k Ardalis.Specification.1.0.1.nupkg