Skip to content

Commit 8c8d891

Browse files
authored
Escape special characters in Readme file (#346)
1 parent 1581032 commit 8c8d891

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Azure SQL bindings for Azure Functions are supported for:
4040
- [Stored Procedure](#stored-procedure)
4141
- [IAsyncEnumerable](#iasyncenumerable)
4242
- [Output Binding](#output-binding)
43-
- [ICollector<T>/IAsyncCollector<T>](#icollectoriasynccollector)
43+
- [ICollector&lt;T&gt;/IAsyncCollector&lt;T&gt;](#icollectortiasynccollectort)
4444
- [Array](#array)
4545
- [Single Row](#single-row)
4646
- [Primary Keys and Identity Columns](#primary-keys-and-identity-columns)
@@ -94,7 +94,7 @@ ALTER TABLE ['{table_name}'] ADD CONSTRAINT PKey PRIMARY KEY CLUSTERED (['{prima
9494

9595
### Create a Function App
9696

97-
Now you will need a a Function App to add the binding to. If you have one created already you can skip this step.
97+
Now you will need a Function App to add the binding to. If you have one created already you can skip this step.
9898

9999
These steps can be done in the Terminal/CLI or with PowerShell.
100100

@@ -132,7 +132,6 @@ These steps can be done in the Terminal/CLI or with PowerShell.
132132
func init --worker-runtime python
133133
```
134134

135-
136135
3. Enable SQL bindings on the function app. More information can be found [in Microsoft Docs](https://docs.microsoft.com/azure/azure-functions/functions-bindings-azure-sql).
137136

138137
**.NET:** Install the extension.
@@ -149,7 +148,7 @@ These steps can be done in the Terminal/CLI or with PowerShell.
149148
```
150149

151150
**Python:**
152-
151+
153152
Update the `host.json` file to the preview extension bundle.
154153
```json
155154
"extensionBundle": {
@@ -229,7 +228,7 @@ Note: This tutorial requires that a SQL database is setup as shown in [Create a
229228
- Open your app that you created in [Create a Function App](#create-a-function-app) in VSCode
230229
- Press 'F1' and search for 'Azure Functions: Create Function'
231230
- Choose HttpTrigger -> (Provide a function name) -> Company.namespace -> anonymous
232-
- In the file that opens, replace the 'public static async Task< IActionResult > Run' block with the below code.
231+
- In the file that opens, replace the `public static async Task<IActionResult> Run` block with the below code.
233232

234233
```csharp
235234
public static async Task<IActionResult> Run(
@@ -277,7 +276,7 @@ Note: This tutorial requires that a SQL database is setup as shown in [Create a
277276
- Open your app in VSCode
278277
- Press 'F1' and search for 'Azure Functions: Create Function'
279278
- Choose HttpTrigger -> (Provide a function name) -> Company.namespace is fine -> anonymous
280-
- In the file that opens, replace the 'public static async Task<IActionResult> Run' block with the below code
279+
- In the file that opens, replace the `public static async Task<IActionResult> Run` block with the below code
281280
282281
```csharp
283282
public static IActionResult Run(
@@ -326,7 +325,7 @@ Note: This tutorial requires that a SQL database is setup as shown in [Create a
326325
- Open your app that you created in [Create a Function App](#create-a-function-app) in VSCode
327326
- Press 'F1' and search for 'Azure Functions: Create Function'
328327
- Choose HttpTrigger -> (Provide a function name) -> anonymous
329-
- In the file that opens (index.js), replace the 'module.exports = async function (context, req)' block with the below code.
328+
- In the file that opens (`index.js`), replace the `module.exports = async function (context, req)` block with the below code.
330329
331330
```javascript
332331
module.exports = async function (context, req, employee) {
@@ -366,7 +365,7 @@ Note: This tutorial requires that a SQL database is setup as shown in [Create a
366365
- Open your app in VSCode
367366
- Press 'F1' and search for 'Azure Functions: Create Function'
368367
- Choose HttpTrigger -> (Provide a function name) -> anonymous
369-
- In the file that opens (index.js), replace the 'module.exports = async function (context, req)' block with the below code.
368+
- In the file that opens (`index.js`), replace the `module.exports = async function (context, req)` block with the below code.
370369
371370
```javascript
372371
module.exports = async function (context, req) {
@@ -421,7 +420,7 @@ Note: This tutorial requires that a SQL database is setup as shown in [Create a
421420
- Open your app that you created in [Create a Function App](#create-a-function-app) in VSCode
422421
- Press 'F1' and search for 'Azure Functions: Create Function'
423422
- Choose HttpTrigger -> (Provide a function name) -> anonymous
424-
- In the file that opens (__init__.py), replace the 'def main(req: func.HttpRequest) -> func.HttpResponse:' block with the below code.
423+
- In the file that opens (`__init__.py`), replace the `def main(req: func.HttpRequest) -> func.HttpResponse:` block with the below code.
425424
426425
```python
427426
def main(req: func.HttpRequest, employee: func.SqlRowList) -> func.HttpResponse:
@@ -464,7 +463,7 @@ Note: This tutorial requires that a SQL database is setup as shown in [Create a
464463
- Open your app in VSCode
465464
- Press 'F1' and search for 'Azure Functions: Create Function'
466465
- Choose HttpTrigger -> (Provide a function name) -> anonymous
467-
- In the file that opens (__init__.py), replace the 'def main(req: func.HttpRequest) -> func.HttpResponse:' block with the below code.
466+
- In the file that opens (`__init__.py`), replace the `def main(req: func.HttpRequest) -> func.HttpResponse:` block with the below code.
468467
469468
```python
470469
def main(req: func.HttpRequest, employee: func.Out[func.SqlRow]) -> func.HttpResponse:
@@ -516,8 +515,8 @@ The input binding takes four [arguments](https://github.com/Azure/azure-function
516515
517516
The following are valid binding types for the result of the query/stored procedure execution:
518517
519-
- **IEnumerable<T>**: Each element is a row of the result represented by `T`, where `T` is a user-defined POCO, or Plain Old C# Object. `T` should follow the structure of a row in the queried table. See the [Query String](#query-string) section for an example of what `T` should look like.
520-
- **IAsyncEnumerable<T>**: Each element is again a row of the result represented by `T`, but the rows are retrieved "lazily". A row of the result is only retrieved when `MoveNextAsync` is called on the enumerator. This is useful in the case that the query can return a very large amount of rows.
518+
- **IEnumerable&lt;T&gt;**: Each element is a row of the result represented by `T`, where `T` is a user-defined POCO, or Plain Old C# Object. `T` should follow the structure of a row in the queried table. See the [Query String](#query-string) section for an example of what `T` should look like.
519+
- **IAsyncEnumerable&lt;T&gt;**: Each element is again a row of the result represented by `T`, but the rows are retrieved "lazily". A row of the result is only retrieved when `MoveNextAsync` is called on the enumerator. This is useful in the case that the query can return a very large amount of rows.
521520
- **String**: A JSON string representation of the rows of the result (an example is provided [here](https://github.com/Azure/azure-functions-sql-extension/blob/main/samples/samples-csharp/InputBindingSamples/GetProductsString.cs)).
522521
- **SqlCommand**: The SqlCommand is populated with the appropriate query and parameters, but the associated connection is not opened. It is the responsiblity of the user to execute the command and read in the results. This is useful in the case that the user wants more control over how the results are read in. An example is provided [here](https://github.com/Azure/azure-functions-sql-extension/blob/main/samples/samples-csharp/InputBindingSamples/GetProductsSqlCommand.cs).
523522
@@ -657,13 +656,13 @@ The output binding takes two [arguments](https://github.com/Azure/azure-function
657656
658657
The following are valid binding types for the rows to be upserted into the table:
659658
660-
- **ICollector<T>/IAsyncCollector<T>**: Each element is a row represented by `T`, where `T` is a user-defined POCO, or Plain Old C# Object. `T` should follow the structure of a row in the queried table. See the [Query String](#query-string) for an example of what `T` should look like.
659+
- **ICollector&lt;T&gt;/IAsyncCollector&lt;T&gt;**: Each element is a row represented by `T`, where `T` is a user-defined POCO, or Plain Old C# Object. `T` should follow the structure of a row in the queried table. See the [Query String](#query-string) for an example of what `T` should look like.
661660
- **T**: Used when just one row is to be upserted into the table.
662661
- **T[]**: Each element is again a row of the result represented by `T`. This output binding type requires manual instantiation of the array in the function.
663662
664663
The repo contains examples of each of these binding types [here](https://github.com/Azure/azure-functions-sql-extension/tree/main/samples/samples-csharp/OutputBindingSamples). A few examples are also included below.
665664
666-
#### ICollector<T>/IAsyncCollector<T>
665+
#### ICollector&lt;T&gt;/IAsyncCollector&lt;T&gt;
667666
668667
When using an `ICollector`, it is not necessary to instantiate it. The function can add rows to the `ICollector` directly, and its contents are automatically upserted once the function exits.
669668

0 commit comments

Comments
 (0)