Skip to content

Commit ed43353

Browse files
author
Steve Stein
authored
Merge pull request #3747 from stevestein/SqlCarbon
2 parents 6da697a + 47b2fbb commit ed43353

20 files changed

Lines changed: 250 additions & 494 deletions

docs/carbon/TOC.md

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,19 @@
1-
# [Carbon Documentation](index.md)
2-
# [Download and Install Carbon](download.md)
1+
# [SQL Operations Studio Documentation](index.md)
2+
# [Download and Install SQL Operations Studio](download.md)
33
# [FAQ](faq.md)
44
# [Overview](overview.md)
55
# Quickstarts
6-
## Run Carbon on Windows
7-
### [Connect & query SQL Server](get-started-sql-server.md)
8-
### [Connect & query SQL Database](get-started-sql-database.md)
9-
### [Connect & query SQL Data Warehouse](get-started-sql-dw.md)
10-
## Run Carbon on macOS
11-
### [Connect & query SQL Server (macOS)](get-started-sql-server-mac.md)
12-
## Run Carbon on Linux
13-
### [Connect & query SQL Server (Linux)](get-started-sql-server-linux.md)
6+
## [Connect & query SQL Server](get-started-sql-server.md)
7+
## [Connect & query SQL Database](get-started-sql-database.md)
8+
## [Connect & query SQL Data Warehouse](get-started-sql-dw.md)
149
# Tutorials
1510
## [Query Editor](tutorial-modern-code-flow-sql-server.md)
1611
## [Monitor](tutorial-monitoring-sql-server.md)
17-
### [1. Database Insight - Monitoring Query Performance](tutorial-qds-sql-server.md)
18-
### [2. Database Insight - Table Space Usage](tutorial-table-space-sql-server.md)
19-
### [3. Server Insight - Backup Status](tutorial-backup-status-sql-server.md)
20-
### [4. Server Insight - Database Size](tutorial-db-size-sql-server.md)
21-
### [5. Build Custom Insight - Missing Index and Memory Usage](tutorial-build-custom-insight-sql-server.md)
12+
### [Database Insight - Monitoring Query Performance](tutorial-qds-sql-server.md)
13+
### [Database Insight - Table Space Usage](tutorial-table-space-sql-server.md)
14+
### [Server Insight - Backup Status](tutorial-backup-status-sql-server.md)
15+
### [Server Insight - Database Size](tutorial-db-size-sql-server.md)
16+
### [Custom Insight - Missing Index and Memory Usage](tutorial-build-custom-insight-sql-server.md)
2217
## [Backup and restore](tutorial-backup-restore-sql-server.md)
2318
# How-to guides
2419
## [Management dashboards & Insight widgets](insight-widgets.md)
@@ -31,5 +26,5 @@
3126
## [Windows authentication (Kerberos)](enable-kerberos.md)
3227
# Reference
3328
# Resources
34-
## [Carbon GitHub repo](https://www.github.com/Microsoft/Carbon)
29+
## [SQL Operations Studio GitHub repo](https://www.github.com/Microsoft/Carbon)
3530
# [Usage Data Collection](usage-data-collection.md)

docs/carbon/download.md

Lines changed: 41 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,29 @@
11
---
2-
title: Download and install Carbon | Microsoft Docs
3-
description: 'Download and Install Carbon for Linux, macOS, or Windows'
4-
keywords: Carbon, install Carbon, download Carbon
5-
services:
6-
documentationcenter: ''
7-
author: stevestein
2+
title: Download and install Microsoft SQL Operations Studio | Microsoft Docs
3+
description: 'Download and Install Microsoft SQL Operations Studio for Windows, macOS, or Linux'
4+
keywords: Microsoft SQL Operations Studio, install Microsoft SQL Operations Studio, download Microsoft SQL Operations Studio
5+
ms.custom: "tools|sos"
6+
ms.date: "10/31/2017"
7+
ms.prod: "sql-non-specified"
8+
ms.reviewer: "alayu; erickang; sanagama; sstein"
9+
ms.suite: "sql"
10+
ms.tgt_pltfrm: ""
11+
ms.topic: "article"
12+
author: "stevestein"
13+
ms.author: "sstein"
814
manager: craigg
9-
editor:
10-
11-
ms.assetid:
12-
ms.service:
13-
ms.custom:
14-
ms.devlang: na
15-
ms.topic: article
16-
ms.tgt_pltfrm: na
17-
ms.prod: NEEDED
18-
ms.workload: data-management
19-
ms.date: 10/19/2017
20-
ms.author: sstein
15+
ms.workload: "Inactive"
2116
---
22-
# Download and install Carbon
17+
# Download and install Microsoft SQL Operations Studio
2318

24-
[Carbon](index.md) is a lightweight, open source, multi-OS and multi-database tool, designed from the ground-up for DBAs and developers. Carbon simplifies configuration, management, monitoring, and troubleshooting of databases.
19+
[!INCLUDE[name-sos-short](../includes/name-sos-short.md)] is a free, lightweight, modern database development and management tool that runs on Windows, macOS, and Linux. Use [!INCLUDE[name-sos-short](../includes/name-sos-short.md)] to manage SQL Server running anywhere, Azure SQL Database, and Azure SQL Data Warehouse. 
2520

2621
> [!NOTE]
27-
> This preview version of Carbon installs by copying a zip (tar) file to your local computer, extracting (expanding) the file, and running the executable.
22+
> This preview version of [!INCLUDE[name-sos-short](../includes/name-sos-short.md)] installs by copying a zip (tar) file to your local computer, extracting (expanding) the file, and running the executable.
2823
2924
## Supported Operating Systems
3025

31-
Carbon runs on Linux, Mac, and Windows.
26+
Carbon runs on Windows, macOS, and Linux.
3227

3328
Carbon is supported on the following platforms:
3429

@@ -38,7 +33,7 @@ Carbon is supported on the following platforms:
3833
| Mac | macOS Sierra (10.12), macOS High Sierra (10.13) |
3934
| Linux | Ubuntu 16.04 LTS, Red Hat Enterprise Linux 7.3 (RHEL)|
4035

41-
??NEED TO FINALIZE THE ABOVE LIST- I grabbed this info from the mail thread about supported OS's
36+
??NEED TO FINALIZE THE ABOVE LIST- I grabbed this info from the mail thread about supported OSs
4237

4338
Other Potential Platforms
4439
- Windows 8.1 (64-bit)
@@ -57,26 +52,14 @@ Other Potential Platforms
5752
## Get Carbon for Windows
5853

5954
1. Download [Carbon for Windows](https://github.com/Microsoft/carbon/releases/download/v0.20.0/2017-Sep-27-carbon-windows.zip) to your local computer.
60-
2. Browse to the downloaded file and extract it.
61-
3. Run *\Carbon\Carbon-windows\Carbon.exe* [VERIFY PATH]
6255

56+
> [!IMPORTANT]
57+
> Executable files may be blocked by Windows when zip files are downloaded from an external source and extracted. Follow the steps below to unblock the .zip file before extracting.
6358
64-
## Get Carbon for Linux
65-
66-
### Red Hat Enterprise
67-
68-
- yum install: `$ sudo yum install -y mssql-Carbon`
69-
- Offline installation: `$ sudo yum localinstall mssql-server_versionnumber.x86_64.rpm`
70-
71-
### SUSE
72-
73-
- zypper install: `$ sudo zypper install mssql-Carbon`
74-
- Offline installation: `$ sudo zypper install mssql-server_versionnumber.x86_64.rpm`
75-
76-
### Ubuntu
77-
78-
- apt-get install: `$ sudo apt-get update sudo apt-get install -y mssql-server`
79-
- Offline installation: `$ sudo dpkg -i mssql-server_versionnumber_amd64.deb`
59+
1. Right-click the **.zip** file, and select **Properties**.
60+
1. On the **General** tab, select **Unblock**, and click **Apply**.
61+
1. Browse to the downloaded file and extract it.
62+
2. Run *\Carbon\Carbon-windows\Carbon.exe* [VERIFY PATH]
8063

8164

8265
## Get Carbon for macOS
@@ -92,9 +75,24 @@ Other Potential Platforms
9275
```carbon .```
9376

9477

95-
## Uninstalling Carbon
78+
## Get Carbon for Linux
79+
80+
1. Open a new Terminal window.
81+
2. Type the following commands to extract the file and launch Carbon:
82+
83+
```bash
84+
cd ~
85+
cp ~/Downloads/pgi3-carbon-linux-x64.tar.gz ~
86+
tar -xvf ~/pgi3-carbon-linux-x64.tar.gz
87+
echo 'export PATH="$PATH:~/carbon-linux-x64"' >> ~/.bashrc
88+
source .bashrc
89+
carbon .
90+
```
91+
92+
93+
## Uninstall Carbon
9694

97-
To uninstall any flavor of the Carbon preview, just delete the files.
95+
To uninstall the [!INCLUDE[name-sos-short](../includes/name-sos-short.md)] preview, delete the files.
9896

9997
## Next Steps
10098

Lines changed: 51 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,39 @@
11
---
2-
title: Connect and query an Azure SQL database using Carbon | Microsoft Docs
3-
description: Use Carbon to connect to a SQL database and run a query
4-
author: yualan
5-
ms.author: alayu
2+
title: Connect and query an Azure SQL database using SQL Operations Studio | Microsoft Docs
3+
description: Use SQL Operations Studio to connect to a SQL database and run a query
4+
keywords:
5+
ms.custom: "tools|sos"
6+
ms.date: "11/01/2017"
7+
ms.prod: "sql-non-specified"
8+
ms.reviewer: "alayu; erickang; sanagama; sstein"
9+
ms.suite: "sql"
10+
ms.tgt_pltfrm: ""
11+
ms.topic: "quickstart"
12+
author: "yualan"
13+
ms.author: "alayu"
614
manager: craigg
7-
ms.reviewer: achatter, alayu, erickang, sanagama, sstein
8-
ms.service: data-tools
9-
ms.workload: data-tools
10-
ms.prod: NEEDED
11-
ms.custom: mvc
12-
ms.topic: quickstart
13-
ms.date: 10/01/2017
15+
ms.workload: "Inactive"
1416
---
15-
# Azure SQL Database: Use Carbon to connect and query data
17+
# Azure SQL Database: Use [!INCLUDE[name-sos](../includes/name-sos-short.md)] to connect and query data
1618

17-
This quickstart demonstrates how to use Carbon to connect to an Azure SQL database, and then use Transact-SQL statements to create, insert, and select data in the database.
19+
This quickstart demonstrates how to use [!INCLUDE[name-sos](../includes/name-sos-short.md)] to connect to an Azure SQL database, and then use Transact-SQL (T-SQL)statements to create, insert, and select data.
1820

1921
## Prerequisites
2022

21-
This quickstart uses as its starting point the resources created in one of these quick starts:
23+
To complete this quickstart, you need [!INCLUDE[name-sos](../includes/name-sos-short.md)], and an Azure SQL server where you have *CREATE DATABASE* permissions.
2224

23-
- [Create DB - Portal](https://docs.microsoft.com/en-us/azure/sql-database/sql-database-get-started-portal)
24-
- [Create DB - CLI](https://docs.microsoft.com/en-us/azure/sql-database/sql-database-get-started-cli)
25-
- [Create DB - PowerShell](https://docs.microsoft.com/en-us/azure/sql-database/sql-database-get-started-powershell)
25+
- [Install [!INCLUDE[name-sos](../includes/name-sos-short.md)]](download.md).
2626

27-
Before you start, install Carbon by following [these directions](download.md).
27+
If you don't already have an Azure SQL server, complete one of the following Azure SQL Database quickstarts:
2828

29-
## SQL server connection information
29+
- [Create DB - Portal](https://docs.microsoft.com/azure/sql-database/sql-database-get-started-portal)
30+
- [Create DB - CLI](https://docs.microsoft.com/azure/sql-database/sql-database-get-started-cli)
31+
- [Create DB - PowerShell](https://docs.microsoft.com/azure/sql-database/sql-database-get-started-powershell)
3032

31-
Get the connection information needed to connect to the Azure SQL database. You will need the fully qualified server name, database name, and login information in the next procedures.
33+
34+
## Get your Azure SQL server connection string
35+
36+
Get the connection information needed to connect to the Azure SQL database. You need the fully qualified server name, database name, and login information in the next procedures.
3237

3338
1. Log in to the [Azure portal](https://portal.azure.com/).
3439

@@ -43,39 +48,34 @@ Get the connection information needed to connect to the Azure SQL database. You
4348

4449
## Connect to your database
4550

46-
Use Carbon to establish a connection to your Azure SQL Database server.
51+
Use [!INCLUDE[name-sos](../includes/name-sos-short.md)] to establish a connection to your Azure SQL Database server.
4752

48-
> [!IMPORTANT]
49-
> Before continuing, make sure that you have your server, database, and login information ready. Once you begin entering the connection profile information, if you change your focus from Carbon, you have to restart creating the connection profile.
50-
>
51-
52-
1. When first loading Carbon, a connection page should be displayed. If not, click the **New Connection** icon on the top left.
53+
1. The first time you run [!INCLUDE[name-sos](../includes/name-sos-short.md)] the **Connection** page should open. If the **Connection** page doesn't open, click the **New Connection** icon in the **SERVERS** page:
5354

5455
![New Connection Icon](media/get-started-sql-database/new-connection-icon.png)
5556

56-
2. Follow the prompts to specify the connection properties for the new connection profile. After specifying each value, press **ENTER** to continue.
57+
2. This article uses *SQL Login*, but *Windows Authentication* is also supported. Fill in the fields as follows:
5758

58-
| Setting       | Suggested value | Description |
59-
| ------------ | ------------------ | ------------------------------------------------- |
60-
| **Authentication** | SQL Login| SQL Authentication is the only authentication type that we have configured in this tutorial. |
61-
| **User name** | The server admin account | This is the account that you specified when you created the server. |
62-
| **Password (SQL Login)** | The password for your server admin account | This is the password that you specified when you created the server. |
63-
| **Save Password?** | Yes or No | Select Yes if you do not want to enter the password each time. |
64-
| **Database name** | *leave blank* | The name of the database to which to connect. |
65-
| **Server Group** | Select \<Default\> | If you created a server group, you can set to a specific server group. |
59+
| Setting | Suggested value |
60+
| :--- |: --- |
61+
| **Authentication** | SQL Login |
62+
| **User name** | The server admin account |
63+
| **Password (SQL Login)** | The password for your Azure SQL server |
64+
| **Save Password?** | Yes or No - If you don't want to enter the password each time, select Yes. |
65+
| **Database name** | *leave blank* |
66+
| **Server Group** | Select \<Default\> |
6667

6768
![New Connection Icon](media/get-started-sql-database/new-connection-screen.png)
6869

69-
3. If you are successfully connected, ignore this step. If you see the following screen, you will need to register your IP address. You can do this through Carbon by clicking add an account, logging in with your Azure credentials, and then adding your IP.
70+
3. If you are successfully connected, skip ahead to the next section. If you see the *Create firewall rule* screen, you need to register your IP address. Add an account, and click **OK**.
7071

7172
![Firewall image](media/get-started-sql-database/setup-firewall-ip.png)
7273

73-
4. You should see your connection in the object explorer.
7474

7575
## Create a tutorial database
76-
1. Right click on your server in the object explorer and select **New Query.**
76+
1. Right click on your Azure SQL server in the SERVERS screen and select **New Query.**
7777

78-
2. Copy the snippet below and paste in the query window. Click **Run** to execute the query.
78+
1. Paste the following snippet into the query window.
7979

8080
```sql
8181
IF NOT EXISTS (
@@ -89,9 +89,10 @@ Use Carbon to establish a connection to your Azure SQL Database server.
8989
ALTER DATABASE [TutorialDB] SET QUERY_STORE=ON
9090
GO
9191
```
92+
1. To execute the query, click **Run**.
9293

9394
## Create a table
94-
1. Copy the snippet below and paste in the query window.
95+
1. Paste the following snippet into the query window.
9596
```sql
9697
-- Create a new table called 'Customers' in schema 'dbo'
9798
-- Drop the table if it already exists
@@ -114,7 +115,7 @@ Use Carbon to establish a connection to your Azure SQL Database server.
114115
![Change context](media/get-started-sql-database/change-context.png)
115116

116117
## Insert rows
117-
Copy the snippet below to insert four rows and paste in the query window. Click **Run** to execute the query.
118+
1. Paste the following snippet into the query window.
118119
```sql
119120
-- Insert rows into table 'Customers'
120121
INSERT INTO dbo.Customers
@@ -126,17 +127,20 @@ Copy the snippet below to insert four rows and paste in the query window. Click
126127
( 4, N'Jake', N'United States', N'jake@vsdata.io')
127128
GO
128129
```
130+
1. To execute the query, click **Run**.
129131

130132
## View the result
131-
Copy the snippet below to view all the rows and paste in the query window. Click **Run** to execute the query.
133+
1. Paste the following snippet into the query window.
132134
```sql
133135
-- Select rows from table 'Customers'
134136
SELECT * FROM dbo.Customers;
135137
```
138+
1. To execute the query, click **Run**.
139+
136140
![Select results](media/get-started-sql-database/select-results.png)
137141

138142
## Save result as Excel
139-
1. Right click on the results table and save as a **Excel** file.
143+
1. Right click on the results table and save as an Excel** file.
140144

141145
![Save as Excel](media/get-started-sql-database/save-as-excel.png)
142146

@@ -147,12 +151,12 @@ View an existing, built-in widget through the dashboard.
147151

148152
## Clean up resources
149153
> [!TIP]
150-
> Other Quickstarts in this collection build upon this quick start. If you plan to continue on to work with subsequent quickstarts, **do not clean up the resources created in this quickstart**. If you do not plan to continue, use the following steps to delete resources created by this quickstart in the Azure portal.
154+
> Other articles in this collection build upon this quickstart. If you plan to continue on to work with subsequent quickstarts, **do not clean up the resources created in this quickstart**. If you do not plan to continue, use the following steps to delete resources created by this quickstart in the Azure portal.
151155
Clean up the resources you created in the quickstart either by deleting the ...
152156

153157
To delete the entire resource group including the newly created server:
154-
1. Locate your resource group in the Azure portal. From the left-hand menu in the Azure portal, click **Resource groups** and then click the name of your resource group, such as our example **myresourcegroup**.
155-
2. On your resource group page, click **Delete**. Then type the name of your resource group, such as our example **myresourcegroup**, in the text box to confirm deletion, and then click **Delete**.
158+
1. Locate your resource group in the Azure portal. From the left-hand menu in the Azure portal, click **Resource groups** and then click the name of your resource group, for example: **myresourcegroup**.
159+
2. On your resource group page, click **Delete**. Then type the name of your resource group, for example: **myresourcegroup**, in the text box to confirm deletion, and then click **Delete**.
156160

157161
Or instead, to delete the newly created server:
158162
1. Locate your server in the Azure portal, if you do not have it open. From the left-hand menu in Azure portal, click **All resources**, and then search for the server you created.
@@ -161,10 +165,4 @@ Or instead, to delete the newly created server:
161165

162166
## Next steps
163167
> [!div class="nextstepaction"]
164-
> [Apply modern code flow using Carbon](tutorial-modern-code-flow-sql-server.md)
165-
166-
> [!div class="nextstepaction"]
167-
> [Monitor your SQL Server databases using Carbon](tutorial-monitoring-sql-server.md)
168-
169-
> [!div class="nextstepaction"]
170-
> [Backup and restore your SQL Server databases using Carbon](tutorial-backup-restore-sql-server.md)
168+
> [Apply modern code flow using [!INCLUDE[name-sos](../includes/name-sos-short.md)]](tutorial-modern-code-flow-sql-server.md)

0 commit comments

Comments
 (0)