Skip to content

Commit

Permalink
v0.19.0 App Centric Release prep (#2027)
Browse files Browse the repository at this point in the history
* Bump version

* Update NOTICE

* Update CHANGELOG

* Update README
  • Loading branch information
alexweininger committed May 24, 2022
1 parent dc38ac3 commit f32dd12
Show file tree
Hide file tree
Showing 19 changed files with 1,035 additions and 857 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

## Unreleased

## 1.19.0 - 2022-05-24

We've made some large design changes to the Azure extensions for VS Code. [View App Centric release notes](https://aka.ms/AzCode/AppCentric)
### Changed
- Minimum version of VS Code is now 1.57.0

Expand Down
1,843 changes: 1,011 additions & 832 deletions NOTICE.html

Large diffs are not rendered by default.

40 changes: 18 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@

Browse and query your Azure databases both locally and in the cloud using [_scrapbooks_](#mongo-scrapbooks) with rich Intellisense then connect to Azure to manage your PostgreSQL and Cosmos DB databases with support for MongoDB, Graph (Gremlin), and SQL (previously known as DocumentDB).

![Azure Databases Extension](resources/features.png)
![Azure Databases Extension](resources/readme/overview.png)

> Sign up today for your free Azure account and receive 12 months of free popular services, $200 free credit and 25+ always free services 👉 [Start Free](https://azure.microsoft.com/free/open-source).
# Prerequisites

Expand All @@ -28,12 +30,12 @@ Browse and query your Azure databases both locally and in the cloud using [_scra
- Edit a document and persist changes to the cloud
- Attach a Mongo server by clicking the plug icon in the title

![Browse PostgreSQL, CosmosDB, and MongoDB databases](resources/Browse.png)
![Browse PostgreSQL, CosmosDB, and MongoDB databases](resources/readme/explorer.png)

## Mongo Scrapbooks
### Run Mongo Commands with Rich Intellisense

- View your MongoDB database account by [signing in to Azure](#managing-azure-subscriptions) or using "Attach Database Account" to connect via a connection string
- View your MongoDB database account by by clicking "Sign in to Azure..." in the Azure Resources explorer or using "Attach Database Account" to connect via a connection string
- Optionally configure the settings `mongo.shell.path` and `mongo.shell.args` if your mongo executable is not already on your system's PATH (many of the common commands have built-in support and do not require the Mongo shell to be installed - see [Prerequisites](#prerequisites))
- Click on "New Mongo Scrapbook" in the tree title bar
- Click on "Connect to a database" to indicate which database to run the commands against
Expand All @@ -42,16 +44,16 @@ Browse and query your Azure databases both locally and in the cloud using [_scra
- Click on "Execute" above a command to execute it, or press `CMD+"` (Mac) or `CTRL+"` (Windows and Linux) to execute the line with the cursor
- To run all commands, click on "Execute All", or press `CMD+:` or `Ctrl+:`
- Save and re-use later
![Mongo Scrapbook](resources/Scrapbook.gif)
![Mongo Scrapbook](resources/readme/Scrapbook.gif)

## Import into Cosmos DB

- You can now import documents from your workspace into CosmosDB. Use the context menu of a collection or a document file (json) to get started!
![Import documents](resources/import_documents.gif)
![Import documents](resources/readme/import_documents.gif)

## Use [Gremlin](https://docs.microsoft.com/azure/cosmos-db/gremlin-support) to query graphs

![Query Graphs](resources/Graph.gif)
![Query Graphs](resources/readme/Graph.gif)

- <a name="graphSettings"></a>Configure the user setting `cosmosDB.graph.viewSettings` to customize which properties to display and which colors to use based on vertex label.
```javascript
Expand Down Expand Up @@ -82,28 +84,22 @@ Browse and query your Azure databases both locally and in the cloud using [_scra

## Create an Azure Databases Server

![Create Azure Databases Server](resources/create.gif)

## Attach to the Cosmos DB Emulator

* Install and run the [Cosmos DB Emulator](https://docs.microsoft.com/azure/cosmos-db/local-emulator) on your local machine
* Right click 'Attached Database Accounts' and select 'Attach Emulator'
1. Sign in to your Azure Account by clicking "Sign in to Azure..." in the Azure Resources explorer
> If you don't already have an Azure Account, click "Create a Free Azure Account"
1. Select the 'plus' button to open the "Create Resource" menu

![Attach Emulator](resources/attachEmulator.png)
![Create resource](resources/readme/createResource.png)

## Managing Azure Subscriptions
1. Choose "Create Database Server..."

If you are not signed in to Azure, you will see a "Sign in to Azure..." link. Alternatively, you can select "View->Command Palette" in the VS Code menu, and search for "Azure: Sign In".
![Create Database Server](resources/readme/createDatabaseServer.png)

![Sign in to Azure](resources/SignIn.gif)

If you don't have an Azure Account, you can sign up for one today for free and receive $200 in credits by selecting "Create a Free Azure Account..." or selecting "View->Command Palette" and searching for "Azure: Create an Account".

You may sign out of Azure by selecting "View->Command Palette" and searching for "Azure: Sign Out".
## Attach to the Cosmos DB Emulator

To select which subscriptions show up in the extension's explorer, click on the "Select Subscriptions..." button on any subscription node (indicated by a "filter" icon when you hover over it), or select "View->Command Palette" and search for "Azure: Select Subscriptions". Note that this selection affects all VS Code extensions that support the [Azure Account and Sign-In](https://github.com/Microsoft/vscode-azure-account) extension.
* Install and run the [Cosmos DB Emulator](https://docs.microsoft.com/azure/cosmos-db/local-emulator) on your local machine
* Right click 'Attached Database Accounts' and select 'Attach Emulator'

![Select Azure Subscriptions](resources/SelectSubscriptions.gif)
![Attach Emulator](resources/readme/attachEmulator.png)

## Known Issues

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "vscode-cosmosdb",
"version": "0.18.2-alpha.18",
"version": "0.19.0",
"aiKey": "AIF-d9b70cd4-b9f9-4d70-929b-a071c400b217",
"publisher": "ms-azuretools",
"displayName": "Azure Databases",
Expand Down
Binary file removed resources/Browse.png
Binary file not shown.
Binary file removed resources/SelectSubscriptions.gif
Binary file not shown.
Binary file removed resources/SignIn.gif
Binary file not shown.
Binary file removed resources/attachEmulator.png
Binary file not shown.
Binary file removed resources/create.gif
Binary file not shown.
Binary file removed resources/features.png
Binary file not shown.
File renamed without changes
File renamed without changes
Binary file added resources/readme/attachEmulator.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/readme/createDatabaseServer.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/readme/createResource.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/readme/explorer.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file added resources/readme/overview.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f32dd12

Please sign in to comment.