Skip to content

gaia-platform/GaiaPlatform_VSCode_Extension

Repository files navigation

Gaia Platform Tools

Features

The Gaia Platform Tools extension offers the following features:

  • Syntax highlighting, IntelliSense support, and snippets for Gaia's schema definition and ruleset languages.
    • DDL syntax is used to write DDL files that define the schema for the objects used in a Gaia application.
    • Declarative C++ syntax is used to write rules in ruleset files.
  • A database explorer that allows you to browse database, table, and column metadata stored in a Gaia server instance.
  • A data navigator that allows you to view the records stored in the database. In addition, the navigator allows you to view records related to the current record if the schema has defined one or more relationships between the current record's table and other tables in the database.

Please note that database explorer and navigator functionality requires version 0.5.0-beta or higher of the Gaia Platform SDK.

Using the Extension

It may be helpful to reference the VS Code User Interface documentation to understand how this extension exposes its functionality.

Two new Language Modes named ruleset and ddl are available on the rightmost section of the Status Bar. The Language Mode will change automatically when editing a .ddl or .ruleset file. To change the mode manually, use Ctrl+K M (Windows/Linux) or Cmd+K M (macOS).

The database explorer is accessed by clicking the Gaia icon on the Activity Bar. An explorer view of the Gaia databases will show in the Side Bar. Clicking on the icon while highlighting a table will show that table's records in an editor pane. If that table is related to other tables, then clicking on the icon for the related link's record will show the related record in a new editor window.

Getting Started with Gaia Platform

About

Visual Studio Code extension for GaiaPlatform

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published