updated vscode connection management, closes influxdata/DAR#247 (#3447)
parent
86f67a8e50
commit
c00176719d
|
@ -19,6 +19,7 @@ integration that lets you run Flux scripts natively and show results in VS Code.
|
||||||
##### On this page
|
##### On this page
|
||||||
- [Install the Flux VS Code extension](#install-the-flux-vs-code-extension)
|
- [Install the Flux VS Code extension](#install-the-flux-vs-code-extension)
|
||||||
- [Connect to InfluxDB](#connect-to-influxdb)
|
- [Connect to InfluxDB](#connect-to-influxdb)
|
||||||
|
- [Manage InfluxDB connections](#manage-influxdb-connections)
|
||||||
- [Query InfluxDB from VS Code](#query-influxdb-from-vs-code)
|
- [Query InfluxDB from VS Code](#query-influxdb-from-vs-code)
|
||||||
- [Explore your schema](#explore-your-schema)
|
- [Explore your schema](#explore-your-schema)
|
||||||
- [Debug Flux queries](#debug-flux-queries)
|
- [Debug Flux queries](#debug-flux-queries)
|
||||||
|
@ -33,17 +34,26 @@ see the [Extension Marketplace documentation](https://code.visualstudio.com/docs
|
||||||
## Connect to InfluxDB
|
## Connect to InfluxDB
|
||||||
To create an InfluxDB connection in VS Code:
|
To create an InfluxDB connection in VS Code:
|
||||||
|
|
||||||
1. Open the **VS Code Command Pallet** ({{< keybind mac="⇧⌘P" other="Ctrl+Shift+P" >}}).
|
1. Hover over the **InfluxDB** pane and then click the **{{< icon "plus" >}}** icon that appears.
|
||||||
2. Run `influxdb.addConnection`.
|
|
||||||
3. Provide the required connection credentials:
|
{{< img-hd src="/img/influxdb/2-1-tools-vsflux-add-connection.png" alt="Add an InfluxDB connection in VS Code" />}}
|
||||||
|
|
||||||
|
2. Provide the required connection credentials:
|
||||||
- **Type:** type of InfluxDB data source. Select **InfluxDB v2**.
|
- **Type:** type of InfluxDB data source. Select **InfluxDB v2**.
|
||||||
- **Name:** unique identifier for your InfluxDB connection.
|
- **Name:** unique identifier for your InfluxDB connection.
|
||||||
- **Hostname and Port:** InfluxDB host and port
|
- **Hostname and Port:** InfluxDB host and port
|
||||||
(see [InfluxDB OSS URLs](/influxdb/v2.1/reference/urls/) or [InfluxDB Cloud regions](/influxdb/cloud/reference/regions/)).
|
(see [InfluxDB OSS URLs](/influxdb/v2.1/reference/urls/) or [InfluxDB Cloud regions](/influxdb/cloud/reference/regions/)).
|
||||||
- **Token:** InfluxDB [API token](/influxdb/v2.1/security/tokens/).
|
- **Token:** InfluxDB [API token](/influxdb/v2.1/security/tokens/).
|
||||||
- **Organization:** InfluxDB organization name.
|
- **Organization:** InfluxDB organization name.
|
||||||
4. Click **Test** to test the connection.
|
3. Click **Test** to test the connection.
|
||||||
5. Once tested successfully, click **Save**.
|
4. Once tested successfully, click **Save**.
|
||||||
|
|
||||||
|
### Manage InfluxDB connections
|
||||||
|
In the **InfluxDB** pane:
|
||||||
|
|
||||||
|
- **To edit a connection**, right click on the connection to edit and select **Edit Connection**.
|
||||||
|
- **To remove a connection**, right click on the connection to remove and select **Remove Connection**.
|
||||||
|
- **To switch to a connection**, right click on the connection to switch to and select **Switch To This Connection**.
|
||||||
|
|
||||||
## Query InfluxDB from VS Code
|
## Query InfluxDB from VS Code
|
||||||
1. Write your Flux query in a new VS Code file.
|
1. Write your Flux query in a new VS Code file.
|
||||||
|
@ -76,8 +86,4 @@ and then `Reload Window`) to initialize the updated extensions.
|
||||||
| Command | Description | Keyboard shortcut | Menu context |
|
| Command | Description | Keyboard shortcut | Menu context |
|
||||||
|:------- |:----------- |:-----------------: | ------------: |
|
|:------- |:----------- |:-----------------: | ------------: |
|
||||||
| `influxdb.refresh` | Refresh | | |
|
| `influxdb.refresh` | Refresh | | |
|
||||||
| `influxdb.addConnection` | Add Connection | | view/title |
|
|
||||||
| `influxdb.runQuery` | Run Query | {{< keybind mac="⌃⌥E" other="Ctrl+Alt+E" >}} | editor/context |
|
| `influxdb.runQuery` | Run Query | {{< keybind mac="⌃⌥E" other="Ctrl+Alt+E" >}} | editor/context |
|
||||||
| `influxdb.removeConnection` | Remove Connection | | view/item/context |
|
|
||||||
| `influxdb.switchConnection` | Switch Connection | | |
|
|
||||||
| `influxdb.editConnection` | Edit Connection | | view/item/context |
|
|
||||||
|
|
Binary file not shown.
After Width: | Height: | Size: 5.5 KiB |
Loading…
Reference in New Issue