https://github.com/materializeinc/vscode-extension

A VSCode extension to interact with Materialize
https://github.com/materializeinc/vscode-extension

Last synced: 5 months ago
JSON representation

A VSCode extension to interact with Materialize

• Host: GitHub
• URL: https://github.com/materializeinc/vscode-extension
• Owner: MaterializeInc
• License: apache-2.0
• Created: 2023-06-20T07:58:48.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2025-10-03T22:00:56.000Z (9 months ago)
• Last Synced: 2025-10-20T04:50:18.625Z (8 months ago)
• Language: TypeScript
• Size: 14.6 MB
• Stars: 13
• Watchers: 1
• Forks: 0
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# Materialize extension for Visual Studio Code

The Materialize extension lets you connect, explore and query Materialize.

![Extension](media/Extension.png)

## Features

* [Profiles](#profiles)

    * Add and switch between profiles.

    * Configure the database, schema, or cluster.

* [Schema explorer](#schema-explorer)

    * Browse through your catalog.

* [SQL execution](#sql-execution)

    * Run `.sql` code (`⌘ Cmd + ⤶ Enter`) on your Materialize account and view the results in Visual Studio Code.

### Profiles

The extension authenticates and creates a profile using the web browser. As a user you can add and switch between profiles or change any runtime configuration, like cluster, database, or schema, at any time given.

![Extension](media/ProfileSwitch.gif)

### Schema explorer

The extension explorer enables you to browse through your schema. Also provides access to the internal schemas `mz_catalog` and `mz_internal`.

![Extension](media/SchemaExplorer.gif)

### SQL execution

The extension provides a way to run SQL code inside `.sql` files.

Run the SQL code from two ways:

* Using the shortcut (⌘ Cmd + ⤶ Enter).

* Pressing the Materialize icon in the editor toolbar.

![Extension](media/Queries.gif)

## Contributing

For more information on contributing, please refer to the [CONTRIBUTING.md](https://github.com/MaterializeInc/vscode-extension/blob/main/CONTRIBUTING.md) document.