1
0
mirror of https://github.com/Microsoft/sql-server-samples.git synced 2025-12-08 14:58:54 +00:00
Files
sql-server-samples/samples/features/temporal/product-catalog

ASP.NET Core Product Catalog application that uses SQL/Temporal and JSON functionalities

This project contains an example of a simple ASP.NET Core product catalog web application that enables you to browse the current list of products, and also to see the state of products in any point in time in the history.

Contents

About this sample
Before you begin
Run this sample
Sample details
Disclaimers
Related links

About this sample

  • Applies to: SQL Server 2016 (or higher), Azure SQL Database
  • Key features: Temporal system-versioning functions in SQL Server 2016/Azure SQL Database
  • Programming Language: C#, Html/JavaScript, Transact-SQL
  • Authors: Jovan Popovic

Before you begin

To run this sample, you need the following prerequisites.

Software prerequisites:

  1. SQL Server 2016 (or higher) or an Azure SQL Database
  2. ASP.NET Core 1.0 SDK (or higher). Optional: Visual Studio 2015 Update 3 (or higher) or Visual Studio Code Editor.

Azure prerequisites:

  1. Permission to create an Azure SQL Database

Run this sample

  1. Create a database on SQL Server 2016 or Azure SQL Database and set compatibility level to 130.

  2. From SQL Server Management Studio or Visual Studio/Sql Server Data Tools connect to your SQL Server 2016 or Azure SQL database and execute setup.sql script that will create and populate Product table and create required stored procedures.

  3. Build the project - Open command prompt in project root folder (the folder that contains project json), and run following commands: dotnet restore to take all necessary NuGet packages, dotnet build to build the project. As an alternative, open the ProductCatalog.xproj file from the root directory using Visual Studio 2015 U3. Restore packages using right-click menu on the project in Visual Studio and by choosing Restore Packages item.

  4. Add connection string in appsettings.json or appsettings.development.json file. An example of the content of appsettings.development.json is shown in the followin configuration:

{
  "ConnectionStrings": {
    "ProductCatalog": "Server=.;Database=ProductCatalog;Integrated Security=true"
  }
}

If database is hosted on Azure you can add something like:

{
  "ConnectionStrings": {
    "ProductCatalog": "Server=<<SERVER>>.database.windows.net;Database=ProductCatalog;User Id=<<USER>>;Password=<<PASSWORD>>"
  }
}
  1. Build solution using Ctrl+Shift+B, right-click on project + Build, Build/Build Solution from menu, or dotnet build command from the command line (from the root folder of application).

  2. Run the sample app using F5 or Ctrl+F5 in Visual Studio 2015, or using dotnet run executed in the command prompt of the project root folder.

  3. Open /index.html Url to get all products from database,

  4. Use expand buttons to see history of products,

  5. Restore some of the previous version using restore link,

  6. Use Slider to go back in time.

Sample details

This sample application shows how to display list of products, go into any point in time in history, see full history of changes, or restore previous versions of products. Front-end code is implemented using JQuery/JQuery UI libraries, and JQuery DataTable component for displaying data. Server-side code is implemented using ASP.NET Core Web API. SQL Server Temporal feature is used to store and query product information. SQL Server JSON functions are used to format product data that will be sent to front-end page.

Disclaimers

The code included in this sample is not intended demonstrate some general guidance and architectural patterns for web development. It contains minimal code required to create REST API, and it does not use some patterns such as Repository. Sample uses built-in ASP.NET Core Dependency Injection mechanism; however, this is not prerequisite. You can easily modify this code to fit the architecture of your application.

You can find more information about the components that are used in this sample on these locations: .Net Core download JQuery DataTables with row expansion. JQuery UI Slider

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

License

These samples and templates are all licensed under the MIT license. See the license.txt file in the root.

Questions

Email questions to: [sqlserversamples@microsoft.com](mailto: sqlserversamples@microsoft.com).