https://github.com/madeiradata/dynamicfilters
Example front-end website and back-end for fully-dynamic filtering capabilities (column, operator, value). Fully protected from SQL Injection.
https://github.com/madeiradata/dynamicfilters
angular angular4 angularjs asp-net-core asp-net-mvc aspnetcoremvc dynamic-filters dynamic-search mssql mssqlserver sql-server sqlserver
Last synced: 4 months ago
JSON representation
Example front-end website and back-end for fully-dynamic filtering capabilities (column, operator, value). Fully protected from SQL Injection.
- Host: GitHub
- URL: https://github.com/madeiradata/dynamicfilters
- Owner: MadeiraData
- License: mit
- Created: 2018-12-03T14:21:50.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-05-27T05:23:16.000Z (about 4 years ago)
- Last Synced: 2025-02-02T07:41:22.161Z (4 months ago)
- Topics: angular, angular4, angularjs, asp-net-core, asp-net-mvc, aspnetcoremvc, dynamic-filters, dynamic-search, mssql, mssqlserver, sql-server, sqlserver
- Language: TSQL
- Homepage: https://eitanblumin.com/portfolio/advanced-dynamic-search-queries/
- Size: 7.86 MB
- Stars: 14
- Watchers: 3
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dynamic Filters (a.k.a. FilterParseSearchParameters)
This repository includes an example front-end website, and a back-end database, for demonstrating fully-dynamic filtering capabilities (column, operator, value). Fully protected from SQL Injection, and based on "low-code development" principles.
It is the accompanying open-source project for the webinar [Advanced Dynamic Search Queries by Eitan Blumin](https://eitanblumin.com/portfolio/advanced-dynamic-search-queries/).
This is an enhanced version of **FilterParseXMLParameters** which is available here:
[https://eitanblumin.com/2018/10/28/dynamic-search-queries-versus-sql-injection](https://eitanblumin.com/2018/10/28/dynamic-search-queries-versus-sql-injection/)
The new version introduces two new methods for dynamically parsing filter sets:
1. Json parameter sets.
2. Table-Valued Parameters.
As mentioned above, this repository also includes a fully-functional demo web app, implemented in ASP.NET Core MVC + AngularJS, to demonstrate the intended functionality on the front-end side.
## Prerequisites
- [.NET Core 2.2 Installed](https://www.microsoft.com/net/core#windowscmd)
- [Microsoft SQL Server 2016 version or newer](https://www.microsoft.com/en-us/sql-server/sql-server-downloads)
- [Microsoft Visual Studio 2017 Community or newer](https://www.visualstudio.com/downloads/)
- [SQL Server Data Tools (SSDT) for Visual Studio](https://docs.microsoft.com/en-us/sql/ssdt/download-sql-server-data-tools-ssdt)
## Installation & Setup
1. Start by [forking or cloning this repository](https://github.com/EitanBlumin/DynamicFilters) to your computer, and opening the DynamicFilters solution in Visual Studio.
2. Creating the Database: Do one of the following:
- Open the [DemoDB_Create.sql](https://github.com/EitanBlumin/DynamicFilters/blob/master/DemoDB_Publish/DemoDB_Create.sql) script file and run it in your local SQL Server instance (must be **in SQLCMD mode**). Or:
- Manually publish the [DemoDB.dacpac](https://github.com/EitanBlumin/DynamicFilters/blob/master/DemoDB_Publish/DemoDB.dacpac) file into your database. Or:
- Open the DemoDB database project, and **publish** it to your local SQL Server instance.
3. Optionally: Change the connection string in `\DemoWebClient\appsettings.json` in case you're not using default settings (localhost server, DemoDB database, Windows Authentication).
4. Whenever you want to run the app: Right click on the `\DemoWebClient\runme.bat` executable and **Run it as Administrator**.
5. The web app should now be available at [http://localhost:5000](http://localhost:5000) (you may also build the app from the web project, and the address would be [http://localhost:61907](http://localhost:61907) )
## Presentation
This GitHub repository also includes an accompanying Powerpoint presentation, available here:
- [DynamicFilters_Presentation_Eng.pptx](https://github.com/EitanBlumin/DynamicFilters/blob/master/DynamicFilters_Presentation_Eng.pptx)
## Main Stored Procedures
The "FilterParse" stored procedures are the "main engine" for this solution. They can be found here:
- [FilterParseTVPParameters](https://github.com/EitanBlumin/DynamicFilters/blob/master/DemoDB/Stored%20Procedures/dbo.FilterParseTVPParameters.sql)
- [FilterParseJsonParameters](https://github.com/EitanBlumin/DynamicFilters/blob/master/DemoDB/Stored%20Procedures/dbo.FilterParseJsonParameters_Standalone.sql)
- [FilterParseXmlParameters](https://github.com/EitanBlumin/DynamicFilters/blob/master/DemoDB/Stored%20Procedures/dbo.FilterParseXmlParameters_Standalone.sql)
The last two procedures (for Json and Xml) also have versions which can be used as "wrappers" that relay the information into the first procedure (using Table Valued Parameters). This should improve performance for scenarios involving large filter sets:
- [FilterParseJsonParameters (wrapper)](https://github.com/EitanBlumin/DynamicFilters/blob/master/DemoDB/Stored%20Procedures/dbo.FilterParseJsonParameters.sql)
- [FilterParseXmlParameters (wrapper)](https://github.com/EitanBlumin/DynamicFilters/blob/master/DemoDB/Stored%20Procedures/dbo.FilterParseXmlParameters.sql)
Additionally, these two procedures also have alternate versions that implement "Encapsulation" using an additional inner `sp_executesql` command, which should improve performance issues caused by bad parameter sniffing:
- [FilterParseJsonParameters (with encapsulation)](https://github.com/EitanBlumin/DynamicFilters/blob/master/DemoDB/Stored%20Procedures/dbo.FilterParseJsonParameters_with_Encapsulation.sql)
- [FilterParseXmlParameters (with encapsulation)](https://github.com/EitanBlumin/DynamicFilters/blob/master/DemoDB/Stored%20Procedures/dbo.FilterParseXmlParameters_with_Encapsulation.sql)
## Main Meta-Data Tables
In addition to the stored procedures, the following "meta-data" tables are also needed in order to hold important configuration of tables, columns and operators:
- [FilterTables](https://github.com/EitanBlumin/DynamicFilters/blob/master/DemoDB/Tables/dbo.FilterTables.sql)
- [FilterColumns](https://github.com/EitanBlumin/DynamicFilters/blob/master/DemoDB/Tables/dbo.FilterColumns.sql)
- [FilterOperators](https://github.com/EitanBlumin/DynamicFilters/blob/master/DemoDB/Tables/dbo.FilterOperators.sql)