Documentation Home
MySQL Shell for VS Code


MySQL Shell for VS Code  /  Getting Started  /  MySQL Shell for VS Code Components

Pre-General Availability: 2024-03-18

2.2 MySQL Shell for VS Code Components

This section identifies the visual components provided by the MySQL Shell for VS Code extension. You can hide or show most of them.

Some aspects of the extension's behavior can be customized by modifying settings values. The figure that follows shows the various extension components. Both the DB Notebook (shown as active) and GUI Console toolbar appear below the main menu in tabs.

Figure 2.1 MySQL Shell for VS Code

Content is described in the surrounding text.

Activity bar icon and view container

The view container appears as an icon in the activity bar after you install the MySQL Shell for VS Code extension. For instructions, see Section 2.1, “Set Up MySQL Shell for VS Code”.

When you select the view container, the side bar populates with the predetermined views of the container (described later). Each view is empty initially.

To hide or show an individual view in the side bar:

  • Click ... (Views and More Actions) in the title bar and select the view to hide or show.

    Content is described in the surrounding text.

To hide or show the view container:

  • Right-click the icon in the activity bar and select MySQL Shell for VS Code.

  • Alternatively, select Hide 'MySQL Shell for VS Code' while the container is visible.

    Hiding the MySQL Shell for VS Code container redirects the side bar to the top container in the activity bar, but it does not close your editors or consoles.

To hide or show the side bar and all of the views:

  • Click the MySQL Shell for VS Code icon in the activity bar.

    This action enables you to maximized the area for your editors and consoles when the individual views are not the focus of your work.

Views in the side bar

  • OPEN EDITORS

  • DATABASE CONNECTIONS

  • ORACLE CLOUD INFRASTRUSTURE

  • MYSQL SHELL TASKS

Editors and consoles

General editors:

  • Settings

Code editors:

  • DB Notebooks (notebook or script)

    Supports SQL (MySQL & SQLite), JavaScript, and TypeScript languages.

  • MySQL Shell Consoles

    Supports SQL (MySQL only), JavaScript, and Python languages.