Skip to content

Commit f1bbaea

Browse files
committed
samples template
1 parent 799f5b7 commit f1bbaea

File tree

1 file changed

+56
-47
lines changed

1 file changed

+56
-47
lines changed

README_samples_template.md

Lines changed: 56 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,81 @@
1-
# Ticket Reservations Sample
1+
# <Sample name>
22

3-
Ticket Reservations is a Windows Forms sample application built on .NET Framework 4.6 that demonstrates the performance benefits of using SQL Server memory optimized tables and native compiled stored procedures. You can compare the performance before and after enabling In-Memory OLTP by observing the transactions/sec as well as the current CPU Usage and latches/sec.
3+
Briefly describe what the sample does. Describe the benefit of running this sample.
44

5-
![Alt text](samples/features/in-memory/ticket-reservations/Screenshots/1.png "Ticket Reservations")
5+
<!-- Add a diagram if you have it -->
66

7+
![Alt text](/media/image-name.png "<Friendly name>")
78

8-
## Applies
99

10-
**Platforms:**
11-
- SQL Server (starting with 2016)
12-
- Azure SQL Database
10+
### Contents
1311

14-
**Features:**
15-
- In-memory OLTP
12+
[About this sample](#about-this-sample)
13+
[Before you begin](#before-you-begin)
14+
[Run this sample](#run-this-sample)
15+
[Sample details](#sample-details)
16+
[Disclaimers](#disclaimers)
17+
[Related links](#related-links)
1618

17-
**Languages:**
1819

19-
- TSQL
20-
- C#
20+
<a name=about-this-sample></a>
2121

22+
## About this sample
2223

23-
## Running this sample
24-
1. Before you can run this sample, you must have the following perquisites:
25-
- SQL Server 2016 CTP3 (or higher)
26-
- Visual Studio 2015 (or higher) with the latest SSDT installed.
24+
**Applies to:** SQL Server 2016 (or higher), or Azure SQL Database
2725

28-
2. Clone this repository using Git for Windows (http://www.git-scm.com/), or download the zip file.
26+
**Key features:**
2927

30-
3. From Visual Studio, open the **InMemoryOLTPDemo.sln** file from the root directory.
28+
**Workload:**
3129

32-
4. In Visual Studio Build menu, select **Build Solution** (or Press F6).
30+
**Languages: **
3331

34-
5. In the **App.config** file, located in the project root, find the **TicketReservations** app setting and edit the connectionString if needed. Currently it is configured to connect to the local default SQL Server Instance using Integrated Security.
32+
**Authors:**
3533

36-
6. Publish the TicketReservations Database
37-
- Right click on the TicketReservations SQL Server Database Project and Select **Publish**
38-
- Click Edit... to choose your connection string
39-
- Click Publish
40-
- Note: For publishing to Azure SQL you need to change the DB project target platform to **Microsoft Azure SQL Database V12**
34+
**Last update:**
4135

42-
7. You can now run and debug the application locally by pressing **F5** in Visual Studio.
36+
<a name=before-you-begin></a>
4337

44-
8. Start the workload with the **Start** button, and run for a while to show perf profile. Then press stop to stop the workload.
38+
## Before you begin
4539

46-
9. In the database project,
47-
- Change TicketReservations.sql to a memory-optimized table (instructions commented in the file itself)
48-
- Change InsertTicketReservations.sql to natively compiled (instructions in the same file)
40+
To run this sample, you need the following prerequisites.
4941

50-
10. Publish the database project to the same database – the tool will take care of making the necessary changes.
51-
Note that, as part of publication, the data is copied from the old disk-based table to the new memory-optimized table, so the longer you run the initial workload, the longer this publication takes.
42+
**Software** prerequisites:
5243

53-
11. Go back to the app and run the workload again. No need to recompile or restart the application.
44+
<!-- Examples -->
45+
1. SQL Server 2016 (or higher) or an Azure SQL Database
46+
2. Visual Studio 2015 (or higher) with the latest SSDT installed
5447

55-
The perf gains from In-Memory OLTP as shown by the load generation app depend on two factors:
56-
- Hardware
57-
- more cores => higher perf gain
58-
- slower log IO => lower perf gain
59-
- Configuration settings in the load generator
60-
- more rows per transaction => higher perf gain
61-
- more reads per write => lower perf gain
62-
- default setting is 10 rows per transaction and 1 read per write
48+
**Azure** prerequisites:
6349

64-
With default settings on one machine with 24 logical cores and relatively slow SSD for the log the app shows around performance 40X gain, and in this case the bottleneck was log IO.
50+
<!-- Examples -->
51+
1. Permission to create an Azure SQL Database
6552

53+
<a name=run-this-sample></a>
6654

67-
## About the code
68-
The code included in this sample is not intended to be a set of best practices on how to build scalable enterprise grade web applications. This is beyond the scope of this quick start sample.
55+
## Run this sample
6956

70-
## More information
71-
- [In-Memory OLTP (In-Memory Optimization)] (https://msdn.microsoft.com/en-us/library/dn133186.aspx)
72-
- [OLTP and database management] (https://www.microsoft.com/en-us/server-cloud/solutions/oltp-database-management.aspx)
57+
<!-- Step by step instructions. Here's a few examples -->
58+
59+
1. From Visual Studio, open the **sample.sln** file from the root directory.
60+
61+
2. In Visual Studio Build menu, select **Build Solution** (or Press F6).
62+
63+
3. Step 3 ...
64+
65+
<a name=sample-details></a>
66+
67+
## Sample details
68+
69+
Describe sample details
70+
71+
<a name=disclaimers></a>
72+
73+
## Disclaimers
74+
The code included in this sample is not intended to be ...
75+
76+
<a name=related-links></a>
77+
78+
## Related Links
79+
<!-- Links to more articles. Remember to delete "en-us" from the link path. -->
80+
81+
For more information, see these articles:

0 commit comments

Comments
 (0)