RBR-OS

RBENREJEB@RBR-OS:/USR/SHARE/DOC/DATAFORM-INTELLIJ-PLUGIN/PROJECT-SETUP$ CAT README

Project setup

Dataform Plugin for IntelliJ · Documentation

Program page Features Source on GitHub

Create a project

  1. Choose File ▸ New ▸ Project and select Dataform.
  2. Fill in the project settings:
Field Description
GCP Project ID The default Google Cloud project, written as defaultProject.
Default schema The default BigQuery dataset, written as defaultDataset.
Default location The default BigQuery location, written as defaultLocation.
Dataform core version The @dataform/core version of the project. The latest published version is proposed.
  1. Click Create.

The wizard creates:

workflow_settings.yaml   defaultProject, defaultLocation and defaultDataset
package.json             the @dataform/core dependency
definitions/
  example_table.sqlx     an example table
includes/
.gitignore               node_modules/, .dataform/ and logs
.gcloudignore            files not to push to the Dataform workspace
README.md

Once the project is open, the plugin installs its packages with npm and compiles it.

Open an existing project

Open the folder of a Dataform project, or pull one from Google Cloud with the Dataform panel. The plugin detects it and enables its features.

If workflow_settings.yaml pins the @dataform/core version, the plugin offers to Move to package.json, so the version is managed with npm like the other packages.

Node.js and the Dataform CLI must be set up first; see Configuration.