From db0202ba48453cdd32b154367c5fbf028f31ba37 Mon Sep 17 00:00:00 2001 From: Jacob Affinito Date: Wed, 28 Jan 2015 08:46:04 -0800 Subject: [PATCH 1/5] Update README.md --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/README.md b/README.md index 675d354..a983678 100644 --- a/README.md +++ b/README.md @@ -170,6 +170,51 @@ Example: } ``` +#### Configure connectionString + +You will need to modify the example connection string found in the plugin.json file in order for the plugin to find and connect to your SQL server. The connectionString is standard Microsoft SQL connection string. You can find more details about connection strings [here](https://www.connectionstrings.com/sql-server/). + +**note** - Please make sure to escape the backslashes, "\", in your connection string by using two backslashes, "\\". + +##### SQL Server + +Below is the example connection string included in the plugin.json: (without quotes) + +``` +Server=.\\SQLExpress;Database=master;Trusted_Connection=True; +``` + +Below is the break down of what each value represents: + +Server Name: . (shorthand for local server) +SQL Instance: SQLExpress +Database to connect to: Database=master +Connection type: Trusted_Connection=True + +This tells the plugin: "As the current user of the process, connect to the local server and then attach to the SQLExpress instance and open the database named master". + +Connecting to another server would require the server name to be used in place of ".". For example: + +``` +Server=remote-server\\SQLExpress;Database=master;Trusted_Connection=True; +``` + +If you are not attempting to connect to the default SQL instance the SQL instance name must be provided like in the example below: + +``` +Server=.\\MyCustomInstance;Database=master;Trusted_Connection=True; +``` + +If using the default the connection string can be simplified like the following: + +``` +Server=remote-server;Database=master;Trusted_Connection=True; +``` + +##### Azure SQL + +TODO + ### Additional Configuration #### Configure permissions From cbb44af9e446ae6b9566011bf157254cf5613bdf Mon Sep 17 00:00:00 2001 From: Jacob Affinito Date: Wed, 28 Jan 2015 10:35:05 -0800 Subject: [PATCH 2/5] Update README.md --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index a983678..2e951f6 100644 --- a/README.md +++ b/README.md @@ -213,6 +213,25 @@ Server=remote-server;Database=master;Trusted_Connection=True; ##### Azure SQL +The connection string for an Azure SQL database is slightly different. The example from the plugin.json is below: + +``` +Server=tcp:{Azure SQL Server Name}.database.windows.net,1433;Database={Azure SQL Database Name};User ID={Azure SQL User Name}@{Azure SQL Server Name};Password={Password for User Name};Trusted_Connection=False;Encrypt=True;Connection Timeout=30; +``` + +It recommend to simply insert the requested details and not alter this connection string to much since it is specifically designed to work with Azure. You will only need to fill in the following details: + +Azure SQL Server Name (in two places) +Azure SQL Database Name +Azure SQL User Name +Password for User Name + +Below is a string that has been filled out with some test data: + +``` +Server=tcp:azure-sql-svr.database.windows.net,1433;Database=my-database;User ID=myUser@azure-sql-svr;Password=password;Trusted_Connection=False;Encrypt=True;Connection Timeout=30; +``` + TODO ### Additional Configuration From 570dc14331608f8ea07180a2e16f2d604f2118ca Mon Sep 17 00:00:00 2001 From: Jacob Affinito Date: Wed, 28 Jan 2015 10:36:13 -0800 Subject: [PATCH 3/5] Update README.md --- README.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 2e951f6..574a732 100644 --- a/README.md +++ b/README.md @@ -186,10 +186,10 @@ Server=.\\SQLExpress;Database=master;Trusted_Connection=True; Below is the break down of what each value represents: -Server Name: . (shorthand for local server) -SQL Instance: SQLExpress -Database to connect to: Database=master -Connection type: Trusted_Connection=True +* Server Name: . (shorthand for local server) +* SQL Instance: SQLExpress +* Database to connect to: Database=master +* Connection type: Trusted_Connection=True This tells the plugin: "As the current user of the process, connect to the local server and then attach to the SQLExpress instance and open the database named master". @@ -221,10 +221,10 @@ Server=tcp:{Azure SQL Server Name}.database.windows.net,1433;Database={Azure SQL It recommend to simply insert the requested details and not alter this connection string to much since it is specifically designed to work with Azure. You will only need to fill in the following details: -Azure SQL Server Name (in two places) -Azure SQL Database Name -Azure SQL User Name -Password for User Name +* Azure SQL Server Name (in two places) +* Azure SQL Database Name +* Azure SQL User Name +* Password for User Name Below is a string that has been filled out with some test data: @@ -232,8 +232,6 @@ Below is a string that has been filled out with some test data: Server=tcp:azure-sql-svr.database.windows.net,1433;Database=my-database;User ID=myUser@azure-sql-svr;Password=password;Trusted_Connection=False;Encrypt=True;Connection Timeout=30; ``` -TODO - ### Additional Configuration #### Configure permissions From 6f20a289ecce2db6e257438d78b9d3e03627844f Mon Sep 17 00:00:00 2001 From: Jacob Affinito Date: Wed, 28 Jan 2015 10:37:48 -0800 Subject: [PATCH 4/5] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 574a732..e84ecb3 100644 --- a/README.md +++ b/README.md @@ -176,7 +176,7 @@ You will need to modify the example connection string found in the plugin.json f **note** - Please make sure to escape the backslashes, "\", in your connection string by using two backslashes, "\\". -##### SQL Server +##### SQL Server Databases (not hosted in Azure) Below is the example connection string included in the plugin.json: (without quotes) @@ -211,7 +211,7 @@ If using the default the connection string can be simplified like the following: Server=remote-server;Database=master;Trusted_Connection=True; ``` -##### Azure SQL +##### Azure-hosted SQL Databases The connection string for an Azure SQL database is slightly different. The example from the plugin.json is below: From be16aabc63ac5d2dcd67a91ced695525924a4043 Mon Sep 17 00:00:00 2001 From: Jacob Affinito Date: Wed, 28 Jan 2015 10:38:30 -0800 Subject: [PATCH 5/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e84ecb3..90ef9cd 100644 --- a/README.md +++ b/README.md @@ -170,7 +170,7 @@ Example: } ``` -#### Configure connectionString +#### Configuring the connectionString You will need to modify the example connection string found in the plugin.json file in order for the plugin to find and connect to your SQL server. The connectionString is standard Microsoft SQL connection string. You can find more details about connection strings [here](https://www.connectionstrings.com/sql-server/).