Use the Flux VS Code extension

The Flux Visual Studio Code (VS Code) extension provides Flux syntax highlighting, autocompletion, and a direct InfluxDB server integration that lets you run Flux scripts natively and show results in VS Code.

{{% note %}}

Enable Flux in InfluxDB 1.11

To use the Flux VS Code extension with InfluxDB 1.11, ensure Flux is enabled in your InfluxDB configuration file. For more information, see Enable Flux. {{% /note %}}

On this page

• Install the Flux VS Code extension
• Connect to InfluxDB 1.11
• Query InfluxDB from VS Code
• Explore your schema
• Debug Flux queries
• Upgrade the Flux extension
• Flux extension commands

Install the Flux VS Code extension

The Flux VS Code extension is available in the Visual Studio Marketplace. For information about installing extensions from the Visual Studio marketplace, see the Extension Marketplace documentation.

Connect to InfluxDB 1.11

To create an InfluxDB connection in VS Code:

1. Open the VS Code Command Pallet ({{< keybind mac="⇧⌘P" other="Ctrl+Shift+P" >}}).
2. Run influxdb.addConnection.
3. Provide the required connection credentials:
   • Type: type of InfluxDB data source. Select InfluxDB v1.
   • Name: unique identifier for your InfluxDB connection.
   • Hostname and Port: InfluxDB host and port.
4. Click Test to test the connection.
5. Once tested successfully, click Save.

Query InfluxDB from VS Code

1. Write your Flux query in a new VS Code file.
2. Save your Flux script with the .flux extension or set the VS Code Language Mode to Flux.
3. Execute the query with the influxdb.runQuery command or {{< keybind mac="⌃⌥E" other="Ctrl+Alt+E" >}}.
4. Query results appear in a new tab. If query results do not appear, see Debug Flux queries.

Explore your schema

After you've configured an InfluxDB connection, VS Code provides an overview of buckets, measurements, and tags in your InfluxDB organization. Use the InfluxDB pane in VS code to explore your schema.

{{< img-hd src="/img/influxdb/1-8-tools-vsflux-explore-schema.png" alt="Explore your InfluxDB schema in VS Code" />}}

Debug Flux queries

To view errors returned from Flux script executions, click the Errors and Warnings icons in the bottom left of your VS Code window, and then select the Output tab in the debugging pane.

{{< img-hd src="/img/influxdb/2-0-tools-vsflux-errors-warnings.png" alt="VS Code errors and warnings"/>}}

Upgrade the Flux extension

VS Code auto-updates extensions by default, but you are able to disable auto-update. If you disable auto-update, manually update your VS Code Flux extension. After updating the extension, reload your VS Code window ({{< keybind mac="⇧⌘P" other="Ctrl+Shift+P" >}}, and then Reload Window) to initialize the updated extensions.

Flux extension commands

Command	Description	Keyboard shortcut	Menu context
influxdb.refresh	Refresh
influxdb.addConnection	Add Connection		view/title
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