* README fixes/improvements, fixes #453 * PR fixes * fixes
This commit is contained in:
Родитель
5deef28f3d
Коммит
7f4516371d
49
README.md
49
README.md
|
@ -4,7 +4,7 @@
|
|||
|
||||
# Prerequisites
|
||||
|
||||
- For Mongo DB support, install [Mongo DB and Mongo shell](https://docs.mongodb.com/manual/installation/).
|
||||
- Some less-common commands in the Mongo [scrapbook](#mongo-scrapbooks) and use of the Mongo shell require installing [Mongo DB and Mongo shell](https://docs.mongodb.com/manual/installation/).
|
||||
|
||||
# Features
|
||||
|
||||
|
@ -21,27 +21,20 @@
|
|||
|
||||
*Support for Table accounts in CosmosDB is coming soon!
|
||||
|
||||
## Mongo "Scrapbooks"
|
||||
![Browse CosmosDB and MongoDB databases](resources/Browse.png)
|
||||
|
||||
- Configure the user setting `mongo.shell.path` to your mongo shell executable path
|
||||
- Click on any DB to open the Mongo shell playground editor
|
||||
- Enter your scripts, eg: `db.<collectionName>.find()`
|
||||
- IntelliSense (completions) will be provided as you write your scripts
|
||||
- Select the script and press `CMD+"` (`CTRL+"` on Windows and Linux) to see the results
|
||||
## Mongo "Scrapbooks" (Run Mongo Commands with Rich Intellisense)
|
||||
|
||||
## Managing Azure Subscriptions
|
||||
- View your MongoDB database account by [signing in to Azure](#managing-azure-subscriptions) or attaching with a connection string
|
||||
- Optionally configure the user setting `mongo.shell.path` to your mongo shell executable path (many of the common commands have built-in support and do not require the Mongo shell to be installed - see [Prerequisites](#prerequisites))
|
||||
- Right-click on a database and select "Connect"
|
||||
- Click on "New Mongo Scrapbook" in the tree title bar
|
||||
- Enter your commands and/or comments, eg: `db.<collectionName>.find()`
|
||||
- IntelliSense (auto-completions) will be provided
|
||||
- Place the cursor inside the command to execute and press `CMD+"` (Mac) or `CTRL+"` (Windows and Linux) to see the results
|
||||
- Save and re-use later
|
||||
|
||||
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".
|
||||
|
||||
![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".
|
||||
|
||||
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.
|
||||
|
||||
![Select Azure Subscriptions](resources/SelectSubscriptions.gif)
|
||||
![Mongo Intellisense](resources/intellisense.gif)
|
||||
|
||||
## Use [Gremlin](https://docs.microsoft.com/azure/cosmos-db/gremlin-support) to query graphs
|
||||
|
||||
|
@ -78,10 +71,6 @@ To select which subscriptions show up in the extension's explorer, click on the
|
|||
|
||||
![Create Cosmos DB Account](resources/create.gif)
|
||||
|
||||
## Create and Run Mongo Commands in a Scrapbook with Rich Intellisense
|
||||
|
||||
![Mongo Intellisense](resources/intellisense.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
|
||||
|
@ -89,6 +78,20 @@ To select which subscriptions show up in the extension's explorer, click on the
|
|||
|
||||
![Attach Emulator](resources/attachEmulator.png)
|
||||
|
||||
## Managing Azure Subscriptions
|
||||
|
||||
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".
|
||||
|
||||
![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".
|
||||
|
||||
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.
|
||||
|
||||
![Select Azure Subscriptions](resources/SelectSubscriptions.gif)
|
||||
|
||||
## Known Issues
|
||||
|
||||
- Azure no longer supports gremlin queries on pre-GA graph accounts. If you see the error "Could not find a valid gremlin endpoint for *graph*", then choose "Open Portal" on the graph node and check the "Gremlin Endpoint" in the Overview tab. If it does not take the form of '...[graph-name].***gremlin***.cosmosdb.azure.com...', then you will need to create a new graph account using the Azure portal or the current version of the extension.
|
||||
|
|
Двоичный файл не отображается.
После Ширина: | Высота: | Размер: 43 KiB |
Загрузка…
Ссылка в новой задаче