diff --git a/extensions/sql-bindings/README.md b/extensions/sql-bindings/README.md index 97b1189254..1ca8c5344f 100644 --- a/extensions/sql-bindings/README.md +++ b/extensions/sql-bindings/README.md @@ -8,6 +8,23 @@ Microsoft SQL Bindings for VS Code enables users to develop Azure Functions with This extension is bundled into the `SQL Server (MSSQL)` extension for VS Code and will be installed automatically when that extension is updated or installed. +## Getting Started with SQL Bindings + **_NOTE:_** Currently, the SQL bindings extension only supports C# Azure Functions. JavaScript and Python Azure Functions support SQL bindings but are not supported by the SQL bindings extension at this time. + +### From object explorer +* To create an Azure Function from a specific table in object explorer, right-click on a table in a connected server in object explorer and select `Create Azure Function with SQL Binding.` If you have not yet created the Azure Function project, the process will create one for you before populating the Azure Function. +![Add SQL Binding in command palette](media/CreateAzFuncTableOE.png) + +### In an existing Azure Function +* Open the C# Azure Function in an editor and then run the `MS SQL: Add SQL Binding` command from the command palette to add a SQL binding to an existing function. +![Add SQL Binding in command palette](media/AddSQLBinding.png) + +### From the command palette +* Run the `MS SQL: Create Azure Function with SQL Binding` command from the command palette to create a new function with a SQL binding. If you have not yet created the Azure Function project, the process will create one for you before populating the Azure Function. +![Add SQL Binding in command palette](media/CreateAzFunc.png) + +Learn more about Azure Functions with SQL bindings [here](https://aka.ms/sqlbindings). + ## Code of Conduct This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. diff --git a/extensions/sql-bindings/media/AddSQLBinding.png b/extensions/sql-bindings/media/AddSQLBinding.png new file mode 100644 index 0000000000..8161c38402 Binary files /dev/null and b/extensions/sql-bindings/media/AddSQLBinding.png differ diff --git a/extensions/sql-bindings/media/CreateAzFunc.png b/extensions/sql-bindings/media/CreateAzFunc.png new file mode 100644 index 0000000000..5a49a45f45 Binary files /dev/null and b/extensions/sql-bindings/media/CreateAzFunc.png differ diff --git a/extensions/sql-bindings/media/CreateAzFuncTableOE.png b/extensions/sql-bindings/media/CreateAzFuncTableOE.png new file mode 100644 index 0000000000..061a03a176 Binary files /dev/null and b/extensions/sql-bindings/media/CreateAzFuncTableOE.png differ