Documentation

Use the Flux VS Code extension

This page documents an earlier version of InfluxDB. InfluxDB v2.0 is the latest stable version. See the equivalent InfluxDB v2.0 documentation: 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.

Enable Flux in InfluxDB 1.8

To use the Flux VS Code extension with InfluxDB 1.8, ensure Flux is enabled in your InfluxDB configuration file. For more information, see Enable Flux.

On this page

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.8

To create an InfluxDB connection in VS Code:

  1. Open the VS Code Command Pallet (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 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.

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.

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 (Ctrl+Shift+P, and then Reload Window) to initialize the updated extensions.

Flux extension commands

CommandDescriptionKeyboard shortcutMenu context
influxdb.refreshRefresh
influxdb.addConnectionAdd Connectionview/title
influxdb.runQueryRun QueryCtrl+Alt+Eeditor/context
influxdb.removeConnectionRemove Connectionview/item/context
influxdb.switchConnectionSwitch Connection
influxdb.editConnectionEdit Connectionview/item/context

New! Cloud or OSS?

InfluxDB OSS 2.0 now generally available!

InfluxDB OSS 2.0 is now generally available and ready for production use. See the InfluxDB OSS 2.0 release notes.

For information about upgrading to InfluxDB OSS 2.0, see: