Skip to content

Commit bfa99bc

Browse files
erinstellato-msrwestMSFT
erinstellato-ms
authored and
rwestMSFT
committed
ADS - add command line page and update index
1 parent a2f8a8e commit bfa99bc

5 files changed

Lines changed: 204 additions & 61 deletions

File tree

‎docs/azure-data-studio/command-line.md‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
---
2+
title: Command line interface in Azure Data Studio
3+
description: Learn more about the command line interface within Azure Data Studio and how to use it.
4+
author: erinstellato-ms
5+
ms.author: erinstellato
6+
ms.reviewer: maghan, randolphwest
7+
ms.date: 08/21/2023
8+
ms.service: azure-data-studio
9+
ms.topic: conceptual
10+
---
11+
# The Azure Data Studio command line interface
12+
13+
Azure Data Studio includes a built-in command line interface that lets you control how you launch the application. You can open files, install extensions, change the display language, and output diagnostics through command line options (switches).
14+
15+
:::image type="content" source="media/command-line/cli-introduction.png" alt-text="Screenshot of command line output for Azure Data Studio.":::
16+
17+
For examples of how to run command line tools inside Azure Data Studio, see [Integrated terminal](integrated-terminal.md).
18+
19+
## Command line help
20+
21+
To view an overview of the Azure Data Studio command line interface, open a terminal within Azure Data Studio (**View > Terminal**) or a command prompt and type `azuredatastudio --help`. The output contains the version, usage example, and list of command line options, as shown in the truncated example:
22+
23+
```bash
24+
C:\>azuredatastudio --help
25+
Azure Data Studio 1.45.1
26+
27+
Usage: azuredatastudio.exe [options][paths...]
28+
29+
To read output from another program, append '-' (e.g. 'echo Hello World | azuredatastudio.exe -')
30+
31+
Options
32+
33+
<vscode options>
34+
35+
-h --help Print usage.
36+
--aad Use Azure Active Directory authentication, this option is
37+
deprecated - use 'authenticationType' instead.
38+
-A --applicationName Supports providing applicationName
39+
that will be used for connection profile app name.
40+
-T --authenticationType Provide authentication mode to be
41+
used. Accepted values: AzureMFA, SqlLogin, Integrated, etc.
42+
-c --command <command-name> Name of command to run, accepted
43+
values: connect, openConnectionDialog
44+
-Z --connectionProperties Supports providing advanced connection properties that
45+
providers support. Value must be a json object containing
46+
key-value pairs in format: '{"key1":"value1"}'
47+
-D --database <database> Name of database
48+
-E --integrated Use Integrated authentication,
49+
this option is deprecated - use 'authenticationType' instead.
50+
-P --provider Connection provider to use, e.g. MSSQL, PGSQL, etc.
51+
-S --server <server> Name of target server or host name.
52+
--showDashboard Whether or not to show dashboard on connection, false by default.
53+
-U --user <user-name> User name/email address
54+
```
55+
56+
## Launch from the command line
57+
58+
You can launch Azure Data Studio from the command line to quickly open a file, folder, or project. Typically, you open Azure Data Studio within the context of a folder. From an open terminal or command prompt, navigate to your project folder and type `azuredatastudio`.
59+
60+
If you have the Azure Data Studio Insiders build installed and want to open it from a command line, use `azuredatastudio-insiders`.
61+
62+
## Launch with Query Editor
63+
64+
Sometimes you may want to open a script in the Query Editor when opening Azure Data Studio. You can launch Azure Data Studio with an existing script by providing the path of the file:
65+
66+
```bash
67+
azuredatastudio .\samplescript.sql
68+
```
69+
70+
## Launch using URI
71+
72+
You can launch Azure Data Studio from browser using URL format to quickly establish connection on launch, or open a connection dialog, optionally opening a script in the Query Editor. The supported format for launching with URI is:
73+
74+
```bash
75+
azuredatastudio://{command}?{option1}={value1}&{option2}={value2}...
76+
```
77+
78+
### Supported commands
79+
80+
The following commands are supported when launching Azure Data Studio from a command line:
81+
82+
- `connect`: Connects to the target server using the provided options
83+
- `openConnectionDialog`: Opens the connection dialog using the provided options
84+
85+
### Supported options
86+
87+
The following options can be provided in the URL:
88+
89+
- `provider`: Connection provider to use, for example, MSSQL, PGSQL, and so on.
90+
- `server`: Name of target server or host name
91+
- `database`: Name of database
92+
- `user`: Name of user
93+
- `authenticationType`: Authentication mode to be used, accepted values: `AzureMFA`, `SqlLogin`, `Integrated`, and so on.
94+
- `applicationName`: Provide an application name that is used in the connection profile
95+
- `connectionProperties`: Advanced connection properties that a provider supports. Value must be a json object containing key-value pairs in format: `{"key1":"value1"}`.
96+
97+
## Examples
98+
99+
#### Command prompt: Integrated authentication
100+
101+
```bash
102+
azuredatastudio --server localhost --provider mssql --authenticationType Integrated
103+
```
104+
105+
#### Command prompt: Launch the Insider build with a saved script
106+
107+
```bash
108+
azuredatastudio-insider --server localhost --provider mssql --user sa .\samplescript.sql
109+
```
110+
111+
#### Browser
112+
113+
```bash
114+
azuredatastudio://connect?server=*****&user=*****&authenticationType=*****&connectionProperties={"key1":"value1"}
115+
```
116+
117+
## Next steps
118+
119+
- [Integrated terminal](integrated-terminal.md)
120+
- [Extend the functionality of Azure Data Studio](extensions/add-extensions.md)
121+
- [Modify user and workspace settings](settings.md)

‎docs/azure-data-studio/index.yml‎

Lines changed: 47 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
### YamlMime:Landing
22

33
title: Azure Data Studio
4-
summary: Learn how to use Azure Data Studio to run SQL Server, Azure SQL Database, PostgreSQL, Jupyter Notebooks and more.
4+
summary: Obtain the skills to connect and query various databases, including SQL Server, Azure SQL Database, PostgreSQL, MySQL and more.
55

66
metadata:
77
title: Azure Data Studio
8-
summary: Learn how to use Azure Data Studio to run SQL Server, Azure SQL Database, PostgreSQL, Jupyter Notebooks and more.
8+
description: Learn how to use Azure Data Studio to connect to and query SQL Server, Azure SQL Database, PostgreSQL, MySQL and more.
99
ms.service: azure-data-studio
1010
ms.topic: landing-page
1111
ms.custom: ignite-2022
12-
author: markingmyname
13-
ms.author: maghan
14-
ms.date: 05/09/2020
12+
author: erinstellato-ms
13+
ms.author: erinstellato
14+
ms.reviewer: maghan
15+
ms.date: 08/18/2023
1516
landingContent:
1617
- title: About Azure Data Studio
1718
linkLists:
@@ -32,9 +33,9 @@ landingContent:
3233
linkLists:
3334
- linkListType: quickstart
3435
links:
35-
- text: Connect and query SQL Server
36+
- text: Connect and query data in SQL Server
3637
url: quickstart-sql-server.md
37-
- text: Connect and query Azure SQL database
38+
- text: Connect and query data in Azure SQL database
3839
url: quickstart-sql-database.md
3940
- text: Connect and query data in Azure Synapse Analytics
4041
url: quickstart-sql-dw.md
@@ -47,10 +48,20 @@ landingContent:
4748
linkLists:
4849
- linkListType: how-to-guide
4950
links:
50-
- text: Enable Kerberos
51-
url: enable-kerberos.md
51+
- text: Connect
52+
url: connect.md
5253
- text: Manage servers and databases with Insight widgets in Azure Data Studio
5354
url: insight-widgets.md
55+
- text: Create and use code snippets
56+
url: code-snippets.md
57+
- text: Explore and manage Azure SQL resources
58+
url: azure-view.md
59+
- text: Create and edit keyboard shortcuts
60+
url: keyboard-shortcuts.md
61+
- text: Enable or disable usage data collection
62+
url: usage-data-collection.md
63+
- text: Enable Kerberos
64+
url: enable-kerberos.md
5465
- text: Modify User and Workspace Settings
5566
url: settings.md
5667

@@ -75,21 +86,36 @@ landingContent:
7586
links:
7687
- text: Extend the functionality of Azure Data Studio
7788
url: extensions/add-extensions.md
78-
- text: Extend the functionality by creating Azure Data Studio extensions
79-
url: extensions/extension-authoring.md
80-
- text: Jupyter Book extension
81-
url: extensions/jupyter-book-extension.md
89+
- text: GitHub Copilot extension
90+
url: extensions/github-copilot-extension.md
8291
- text: Kusto (KQL)
8392
url: extensions/kusto-extension.md
84-
- text: Notebook extension
85-
url: extensions/notebook-extension.md
86-
- text: Azure SQL migration extension
87-
url: extensions/azure-sql-migration-extension.md
8893
- text: MySQL extension
8994
url: extensions/mysql-extension.md
9095
- text: PostgreSQL extension
9196
url: extensions/postgres-extension.md
92-
- text: PowerShell Editor Support
93-
url: extensions/powershell-extension.md
94-
- text: Wizard extension
95-
url: extensions/wizard-extension.md
97+
- text: SandDance extension
98+
url: extensions/sanddance-extension.md
99+
- text: Schema Compare extension
100+
url: extensions/schema-compare-extension.md
101+
- text: SQL Database projects extension
102+
url: extensions/sql-database-project-extension.md
103+
- text: SQL Server Import extension
104+
url: extensions/sql-server-import-extension.md
105+
- text: SQL Server Profiler extension
106+
url: extensions/sql-server-profiler-extension.md
107+
108+
- title: Migration Extensions
109+
linkLists:
110+
- linkListType: concept
111+
links:
112+
- text: Azure SQL migration extension
113+
url: extensions/azure-sql-migration-extension.md
114+
- text: Azure PostgreSQL migration extension
115+
url: extensions/azure-postgresql-migration-extension.md
116+
- text: Database Migration Assessment for Oracle
117+
url: extensions/database-migration-assessment-for-oracle-extension.md
118+
- text: Azure Cosmos DB migration for MongoDB
119+
url: extensions/database-migration-for-mongo-extension.md
120+
- text: Database Schema Conversion Toolkit
121+
url: extensions/dsct/database-schema-conversion-toolkit.md

‎docs/azure-data-studio/media/command-line/cli-introduction.png‎

38.2 KB
Loading

‎docs/azure-data-studio/preview-features.md‎

Lines changed: 34 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,11 @@ title: Preview features in Azure Data Studio
33
description: Learn more about Azure Data Studio preview features and how to enable and use them.
44
author: erinstellato-ms
55
ms.author: erinstellato
6-
ms.reviewer: maghan
7-
ms.date: 10/14/2020
6+
ms.reviewer: maghan, randolphwest
7+
ms.date: 08/21/2023
88
ms.service: azure-data-studio
99
ms.topic: conceptual
10-
ms.custom: updatefrequency5
1110
---
12-
1311
# Preview features in Azure Data Studio
1412

1513
In Azure Data Studio, new features and improvements are often first released as preview features before they're made generally available (GA). The amount of time a feature remains in preview can vary based on user feedback, quality checks, and long-term road maps. By enabling preview features, you get full access to Azure Data Studio features and the chance to provide early feedback.
@@ -18,59 +16,55 @@ In Azure Data Studio, new features and improvements are often first released as
1816

1917
### On first launch
2018

21-
If you're a new user, you can opt into preview features when you launch Azure Data Studio for the first time. On startup, a toast notification will appear in the bottom-right corner of the screen that gives you the option to enable or disable preview features. Select **Yes (recommended)** to enable preview features.
19+
If you're a new user, you can opt into preview features when you launch Azure Data Studio for the first time. On startup, a toast notification appears in the bottom-right corner of the screen that gives you the option to enable or disable preview features. Select **Yes (recommended)** to enable preview features.
2220

23-
![Preview toast notification on first launch](./media/getting-started/preview-toast-notification.png)
21+
:::image type="content" source="media/getting-started/preview-toast-notification.png" alt-text="Screenshot of preview toast notification on first launch.":::
2422

2523
### In Settings
2624

27-
You can enable or disable preview features anytime in your Settings.
25+
You can enable or disable preview features at any time in Settings.
2826

29-
1. Select the **Gear** icon in the bottom-left corner and then select **Settings** from the context menu. The Settings tab will open.
27+
1. Select the **Gear** icon in the bottom-left corner and then select **Settings** from the context menu.
3028

31-
![Gear icon to access Settings in ADS](./media/settings/open-settings-menu.png)
29+
:::image type="content" source="media/settings/open-settings-menu.png" alt-text="Screenshot of gear icon to access Settings in ADS.":::
3230

33-
2. Type "enable preview features" in the search bar.
31+
1. Once the Settings tab is open, type "enable preview features" in the search bar.
3432

35-
3. To enable preview features, check the checkbox for **Enable unreleased preview features** under **Workbench: Enable Preview Features**. To disable preview features, clear the checkbox.
33+
1. To enable preview features, check the checkbox for **Enable unreleased preview features** under **Workbench: Enable Preview Features**. To disable preview features, clear the checkbox.
3634

37-
![Enable preview features setting in ADS](./media/settings/preview-features-settings.png)
35+
:::image type="content" source="media/settings/preview-features-settings.png" alt-text="Screenshot of enabling preview features setting in ADS.":::
3836

3937
## List of preview features in Azure Data Studio
4038

4139
### General features in preview
4240

43-
* Azure portal integration
44-
* Backup / Restore
45-
* Deployments
46-
* SQL Edge
47-
* Feature tour
48-
49-
### Notebook features in preview
50-
51-
* Dotnet interactive support
41+
- Backup / Restore
42+
- Create Database
43+
- Delete Database
44+
- User Management
5245

5346
### First-party extensions in preview
5447

55-
* Azure Monitor Logs
56-
* Azure SQL Edge Deployment
57-
* Central Management Servers
58-
* Cosmos
59-
* Database Administration Tool Extensions for Windows
60-
* Database Migration Assessment for Oracle
61-
* Kusto
62-
* Managed Instance Dashboard
63-
* Oracle
64-
* MySQL
65-
* PostgreSQL
66-
* SandDance for Azure Data Studio
67-
* Server Reports
68-
* SQL Assessment
69-
* SQL Database Projects
70-
* SQL Server Agent
71-
* SQL Server Profiler
72-
* whoisactive
48+
- Azure Cosmos DB API for MongoDB
49+
- Azure Cosmos DB Migration for MongoDB
50+
- Azure Monitor Logs
51+
- Azure PostgreSQL migration
52+
- Central Management Servers
53+
- Data Migration for Oracle
54+
- Database Administration Tool Extensions for Windows
55+
- Database Migration Assessment for Oracle
56+
- Database Schema Conversion Toolkit
57+
- Kusto
58+
- SQL Managed Instance Dashboard
59+
- Oracle
60+
- PostgreSQL
61+
- SandDance for Azure Data Studio
62+
- Server Reports
63+
- SQL Assessment
64+
- SQL Server Agent
65+
- SQL Server Profiler
66+
- whoisactive
7367

7468
## Next steps
7569

76-
* [Azure Data Studio](what-is-azure-data-studio.md)
70+
- [Azure Data Studio](what-is-azure-data-studio.md)

‎docs/azure-data-studio/toc.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,8 @@
156156
href: extensions/jupyter-book-extension.md
157157
- name: Wizard extension
158158
href: extensions/wizard-extension.md
159+
- name: Command line interface
160+
href: command-line.md
159161
- name: Integrated terminal (PowerShell, Bash)
160162
href: integrated-terminal.md
161163
- name: Preview features

0 commit comments

Comments
 (0)