Skip to content

Commit 24c3dd5

Browse files
authored
a few changes to readme (#158)
* a few changes to readme * adjustments to where and adding prerelease flag * correct capitalization
1 parent bb467ee commit 24c3dd5

File tree

1 file changed

+10
-14
lines changed

1 file changed

+10
-14
lines changed

README.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,13 @@
44

55
## Introduction
66

7-
This repository contains SQL binding extension code as well as a quick start, tutorial, and samples of how to use them. A high level explanation of the bindings is provided below. Additional information for each is in their respective sample sections.
7+
This repository contains the Azure SQL binding for Azure Functions extension code as well as a quick start tutorial and samples illustrating how to use the binding in different ways. A high level explanation of the bindings is provided below. Additional information for each is in their respective sample sections.
88

9-
- **input binding**: takes a SQL query to run on a provided table and returns the output of the query.
9+
- **input binding**: takes a SQL query to run and returns the output of the query in the function.
1010
- **output binding**: takes a list of rows and upserts them into the user table (i.e. If a row doesn't already exist, it is added. If it does, it is updated).
1111

12+
Further information on the Azure SQL binding for Azure Functions is also available in the [Azure Functions docs](https://docs.microsoft.com/azure/azure-functions/functions-bindings-azuresql).
13+
1214
## Table of Contents
1315

1416
- [Azure SQL binding for Azure Functions - Preview](#azure-sql-binding-for-azure-functions---preview)
@@ -59,13 +61,7 @@ A primary key must be set in your SQL table before using the bindings. To do thi
5961

6062
### Set Up Local .NET Function App
6163

62-
These steps can be done in the CLI, Powershell. Completing this section will allow you to begin using the bindings.
63-
64-
1. Add MyGet package feed. If you are running into errors, make sure you have the [.NET sdk](https://dotnet.microsoft.com/download) installed and in your system PATHS.
65-
66-
```bash
67-
dotnet nuget add source https://www.myget.org/F/azure-appservice/api/v3/index.json
68-
```
64+
These steps can be done in the Terminal/CLI or with PowerShell. Completing this section will allow you to begin using the Azure SQL binding.
6965

7066
1. Install [Azure Functions Core Tools](https://docs.microsoft.com/azure/azure-functions/functions-run-local)
7167

@@ -79,11 +75,11 @@ These steps can be done in the CLI, Powershell. Completing this section will all
7975

8076
1. Install the extension.
8177

82-
```bash
83-
dotnet add package Microsoft.Azure.WebJobs.Extensions.Sql --version 1.0.0-preview3
78+
```powershell
79+
dotnet add package Microsoft.Azure.WebJobs.Extensions.Sql --prerelease
8480
```
8581

86-
1. Ensure you have Azure Storage Emulator running. For information on the Azure Storage Emulator, refer [here](https://docs.microsoft.com/azure/storage/common/storage-use-emulator#get-the-storage-emulator)
82+
1. Ensure you have Azure Storage Emulator running. This is specific to the sample functions in this repository with a non-HTTP trigger. For information on the Azure Storage Emulator, refer to the docs on its use in [functions local development](https://docs.microsoft.com/azure/azure-functions/functions-app-settings#azurewebjobsstorage) and [installation](https://docs.microsoft.com/azure/storage/common/storage-use-emulator#get-the-storage-emulator).
8783

8884
1. Get your SqlConnectionString. Your connection string can be found in your SQL database resource by going to the left blade and clicking 'Connection strings'. Copy the Connection String.
8985

@@ -253,7 +249,7 @@ Note: This tutorial requires that the Azure SQL database is setup as shown in [C
253249
254250
### Input Binding
255251
256-
The input binding takes four arguments
252+
The input binding takes four [arguments](https://github.com/Azure/azure-functions-sql-extension/blob/main/src/SqlAttribute.cs):
257253
258254
- **CommandText**: Passed as a constructor argument to the binding. Represents either a query string or the name of a stored procedure.
259255
- **CommandType**: Specifies whether CommandText is a query (`System.Data.CommandType.Text`) or a stored procedure (`System.Data.CommandType.StoredProcedure`)
@@ -394,7 +390,7 @@ public static async Task<IActionResult> Run(
394390

395391
The output binding takes a list of rows to be upserted into a user table. If the primary key value of the row already exists in the table, the row is interpreted as an update, meaning that the values of the other columns in the table for that primary key are updated. If the primary key value does not exist in the table, the row is interpreted as an insert. The upserting of the rows is batched by the output binding code.
396392

397-
The output binding takes two arguments
393+
The output binding takes two [arguments](https://github.com/Azure/azure-functions-sql-extension/blob/main/src/SqlAttribute.cs):
398394

399395
- **CommandText**: Passed as a constructor argument to the binding. Represents the name of the table into which rows will be upserted.
400396
- **ConnectionStringSetting**: Specifies the name of the app setting that contains the SQL connection string used to connect to a database. The connection string must follow the format specified [here](https://docs.microsoft.com/dotnet/api/microsoft.data.sqlclient.sqlconnection.connectionstring?view=sqlclient-dotnet-core-2.0).

0 commit comments

Comments
 (0)