[docs] [ORM] Doc for Dapper ORM (yugabyte#14957)

* added dapper orm content * Update docs/content/preview/develop/build-apps/csharp/ysql-dapper.md Co-authored-by: Dwight Hodge <79169168+ddhodge@users.noreply.github.com> * Update docs/content/preview/develop/build-apps/csharp/ysql-dapper.md Co-authored-by: Dwight Hodge <79169168+ddhodge@users.noreply.github.com> * changes from review * renamed ORMs Co-authored-by: Dwight Hodge <79169168+ddhodge@users.noreply.github.com>
jayant07-yb · Dec 7, 2022 · 341b6a5 · 341b6a5
1 parent fe43944
commit 341b6a5
Show file tree

Hide file tree

Showing 2 changed files with 281 additions and 6 deletions.
diff --git a/docs/content/preview/develop/build-apps/csharp/ysql-dapper.md b/docs/content/preview/develop/build-apps/csharp/ysql-dapper.md
@@ -0,0 +1,269 @@
+---
+title: Build a C# application that uses Dapper ORM and YSQL
+headerTitle: Build a C# application
+linkTitle: More examples
+description: Build a C# application that uses Dapper ORM and the YSQL API.
+menu:
+  preview:
+    identifier: build-apps-csharp-2-ysql
+    parent: cloud-csharp
+    weight: 556
+type: docs
+---
+
+<ul class="nav nav-tabs-alt nav-tabs-yb">
+  <li>
+    <a href="../ysql-entity-framework/" class="nav-link">
+      <i class="icon-postgres" aria-hidden="true"></i>
+      Entity Framework ORM
+    </a>
+  </li>
+  <li>
+    <a href="../ysql-dapper/" class="nav-link active">
+      <i class="icon-postgres" aria-hidden="true"></i>
+      Dapper ORM
+    </a>
+  </li>
+</ul>
+
+The following tutorial implements a REST API server using the [Dapper](https://github.com/DapperLib/Dapper) ORM. The scenario is that of an e-commerce application where database access is managed using the ORM. It includes the following tables:
+
+- `users` — the users of the e-commerce site
+- `products` — the products being sold
+- `orders` — the orders placed by the users
+- `orderline` — each line item of an order
+
+The source for the above application can be found in the [Using ORMs with YugabyteDB](https://github.com/yugabyte/orm-examples/tree/master/csharp/dapper) repository.
+
+## Prerequisites
+
+This tutorial assumes that you have:
+
+- YugabyteDB up and running. Download and install YugabyteDB by following the steps in [Quick start](../../../../quick-start/).
+- [.NET SDK 6.0](https://dotnet.microsoft.com/en-us/download) or later.
+
+## Clone the "orm-examples" repository
+
+```sh
+$ git clone https://github.com/YugabyteDB-Samples/orm-examples.git && cd orm-examples/csharp/dapper/DapperORM
+```
+
+## Database configuration
+
+To modify the database connection settings, change the `DefaultConnection` field in `appsettings.json` file which is in the following format:
+
+`Host=$hostName; Port=$dbPort; Username=$dbUser; Password=$dbPassword; Database=$database`
+
+| Properties | Description | Default |
+| :--------- | :---------- | :------ |
+| Host | Database server IP address or DNS name. | 127.0.0.1 |
+| Port | Database port where it accepts client connections. | 5433 |
+| Username | The username to connect to the database. | yugabyte |
+| Password | The password to connect to the database. |  |
+| Database | Database instance in database server. | yugabyte |
+
+## Start the REST API server
+
+To change default port for the REST API Server, go to `Properties/launchSettings.json` and change the `applicationUrl` field under the `DapperORM` field.
+
+- Build the REST API server.
+
+  ```sh
+  $ dotnet build
+  ```
+
+- Run the REST API server
+
+  ```sh
+  $ dotnet run
+  ```
+
+The REST server runs at `http://localhost:8080` by default.
+
+## Send requests to the application
+
+Create 2 users.
+
+```sh
+$ curl --data '{ "firstName" : "John", "lastName" : "Smith", "email" : "jsmith@example.com" }' \
+   -v -X POST -H 'Content-Type:application/json' http://localhost:8080/users
+```
+
+```sh
+$ curl --data '{ "firstName" : "Tom", "lastName" : "Stewart", "email" : "tstewart@example.com" }' \
+   -v -X POST -H 'Content-Type:application/json' http://localhost:8080/users
+```
+
+Create 2 products.
+
+```sh
+$ curl \
+  --data '{ "productName": "Notebook", "description": "200 page notebook", "price": 7.50 }' \
+  -v -X POST -H 'Content-Type:application/json' http://localhost:8080/products
+```
+
+```sh
+$ curl \
+  --data '{ "productName": "Pencil", "description": "Mechanical pencil", "price": 2.50 }' \
+  -v -X POST -H 'Content-Type:application/json' http://localhost:8080/products
+```
+
+Verify the `userId` and `productId` from the database using the following YSQL commands from your [ysqlsh](../../../../admin/ysqlsh/#starting-ysqlsh) shell.
+
+```sql
+yugabyte=# SELECT * FROM users;
+```
+
+```output
+ user_id | first_name | last_name |      user_email
+---------+------------+-----------+----------------------
+       1 | John       | Smith     | jsmith@example.com
+     101 | Tom        | Stewart   | tstewart@example.com
+(2 rows)
+```
+
+```sql
+yugabyte=# SELECT * FROM products;
+```
+
+```output
+ product_id |    description    | price | product_name
+------------+-------------------+-------+--------------
+          1 | 200 page notebook |  7.50 | Notebook
+        101 | Mechanical pencil |  2.50 | Pencil
+(2 rows)
+```
+
+Create 2 orders with products using the `userId` for John.
+
+```sh
+$ curl \
+  --data '{ "userId": "1", "products": [ { "productId": 1, "units": 2 } ] }' \
+  -v -X POST -H 'Content-Type:application/json' http://localhost:8080/orders
+```
+
+```sh
+$ curl \
+  --data '{ "userId": "1", "products": [ { "productId": 1, "units": 2 }, { "productId": 101, "units": 4 } ] }' \
+  -v -X POST -H 'Content-Type:application/json' http://localhost:8080/orders
+```
+
+## Query results
+
+### Use the YSQL shell
+
+```sql
+yugabyte=# SELECT count(*) FROM users;
+```
+
+```output
+ count
+-------
+     2
+(1 row)
+```
+
+```sql
+yugabyte=# SELECT count(*) FROM products;
+```
+
+```output
+ count
+-------
+     2
+(1 row)
+```
+
+```sql
+yugabyte=# SELECT count(*) FROM orders;
+```
+
+```output
+ count
+-------
+     2
+(1 row)
+```
+
+### Use the REST API
+
+To use the REST API server to verify that the users, products, and orders were created in the `yugabyte` database, enter the following commands. The results are output in JSON format.
+
+```sh
+$ curl http://localhost:8080/users
+```
+
+```output.json
+{
+  "content": [
+    {
+      "userId": 101,
+      "firstName": "Tom",
+      "lastName": "Stewart",
+      "email": "tstewart@example.com"
+    },
+    {
+      "userId": 1,
+      "firstName": "John",
+      "lastName": "Smith",
+      "email": "jsmith@example.com"
+    }
+  ],
+  ...
+}
+```
+
+```sh
+$ curl http://localhost:8080/products
+```
+
+```output.json
+{
+  "content": [
+    {
+      "productId": 101,
+      "productName": "Pencil",
+      "description": "Mechanical pencil",
+      "price": 2.5
+    },
+    {
+      "productId": 1,
+      "productName": "Notebook",
+      "description": "200 page notebook",
+      "price": 7.5
+    }
+  ],
+  ...
+}
+```
+
+```sh
+$ curl http://localhost:8080/orders
+```
+
+```output.json
+{
+  "content": [
+    {
+      "orderId":"2692e1e9-0bbd-40e8-bf51-4fbcc4e9fea2",
+      "orderTime":"2022-02-24T02:32:52.60555",
+      "orderTotal":15.00,
+      "userId":1,
+      "users":null,
+      "products":null
+    },
+    {
+      "orderId":"f7343f22-7dfc-4a18-b4d3-9fcd17161518",
+      "orderTime":"2022-02-24T02:33:06.832663",
+      "orderTotal":25.00,
+      "userId":1,
+      "users":null,
+      "products":null
+    }
+  ]
+}
+```
+
+## Explore the source
+
+The application source is available in the [orm-examples](https://github.com/yugabyte/orm-examples/tree/master/csharp/dapper) repository.
diff --git a/docs/content/preview/develop/build-apps/csharp/ysql-entity-framework.md b/docs/content/preview/develop/build-apps/csharp/ysql-entity-framework.md
@@ -5,7 +5,7 @@ linkTitle: More examples
 description: Build a C# application that uses Entity Framework and the YSQL API.
 menu:
   preview:
-    identifier: build-apps-csharp-3-ysql
+    identifier: build-apps-csharp-1-ysql
     parent: cloud-csharp
     weight: 556
 type: docs
@@ -18,6 +18,12 @@ type: docs
       Entity Framework ORM
     </a>
   </li>
+  <li>
+    <a href="../ysql-dapper/" class="nav-link">
+      <i class="icon-postgres" aria-hidden="true"></i>
+      Dapper ORM
+    </a>
+  </li>
 </ul>
 
 The following tutorial implements a REST API server using the [Entity Framework](https://docs.microsoft.com/en-us/ef/) ORM. The scenario is that of an e-commerce application where database access is managed using the [Entity Framework Core](https://docs.microsoft.com/en-us/ef/core/). It includes the following tables:
@@ -45,7 +51,7 @@ $ git clone https://github.com/YugabyteDB-Samples/orm-examples.git && cd orm-exa
 
 ## Database configuration
 
-- To modify the database connection settings, change the default `ConnectionStrings` in `appsettings.json` file which is in the following format:
+To modify the database connection settings, change the default `ConnectionStrings` in `appsettings.json` file which is in the following format:
 
 `Host=$hostName; Port=$dbPort; Username=$dbUser; Password=$dbPassword; Database=$database`
 
@@ -113,8 +119,8 @@ yugabyte=# \c ysql_entityframework
 You are now connected to database "ysql_entityframework" as user "yugabyte".
 ```
 
-```sh
-ysql_entityframework=# SELECT count(*) FROM users;
+```sql
+ysql_entityframework=# SELECT * FROM users;
 ```
 
 ```output
@@ -125,8 +131,8 @@ ysql_entityframework=# SELECT count(*) FROM users;
 (2 rows)
 ```
 
-```sh
-ysql_entityframework=# SELECT count(*) FROM products;
+```sql
+ysql_entityframework=# SELECT * FROM products;
 ```
 
 ```output