Documentation Home
MySQL Shell for VS Code


Pre-General Availability: 2022-11-22

MySQL Shell GUI / MySQL Shell for VS Code

Abstract

MySQL Shell GUI is a repository of MySQL Shell extensions. (MySQL Shell is part of MySQL Server.) MySQL Shell GUI uses the functionality of MySQL Shell, but provides additional functionality such as a native interface from within Visual Studio Code.

MySQL Shell is an advanced client for MySQL. In addition to the provided SQL functionality, similar to mysql, MySQL Shell provides scripting capabilities for JavaScript and Python and includes APIs for working with MySQL. For the detailed documentation about MySQL Shell, see MySQL Shell 8.0.

For help with using MySQL, please visit the MySQL Forums, where you can discuss your issues with other MySQL users.

Licensing information.  This release may include third-party software, used under license. If you are using a Community release of MySQL Shell, see MySQL Shell Community License Information User Manual for licensing information, including licensing information relating to third-party software that may be included in this Community release.

Document generated on: 2022-11-22 (revision: 74567)

Table of Contents

1 Welcome
2 Getting Started
2.1 Set Up MySQL Shell for VS Code
2.2 MySQL Shell for VS Code Components
2.3 Settings
2.3.1 Settings for DB Notebooks
2.3.2 Settings for MySQL Shell Consoles
2.3.3 Settings for the Extension and All Editors
2.3.4 Settings for Advanced Usage
2.4 Notebook Editors
2.4.1 Code Completion
2.4.2 Navigate Code Blocks
2.5 Run Embedded SQL
3 View MySQL Resources
3.1 DATABASE CONNECTIONS View
3.1.1 Quick Database Connection Tasks
3.1.2 MySQL REST Service
3.1.3 MySQL Administration
3.2 ORACLE CLOUD INFRASTRUCTURE View
3.3 MYSQL SHELL CONSOLES View
3.4 MYSQL SHELL TASKS View
4 Database Connections and DB Notebooks
4.1 DB Connection Browser
4.2 Configure Database Connections
4.2.1 Configure an SQLite Database Connection
4.2.2 Configure a Basic MySQL Database Connection
4.2.3 Configure a Connection with SSL Encryption
4.2.4 Configure a Connection Using SSH Tunneling
4.2.5 Configure a Connection Using MySQL Database Service (MDS)
4.2.6 Configure Advanced Settings
4.3 Commands in a DB Notebook
4.4 DB Notebook Toolbar
4.5 Work with Result Sets
4.6 Edit a Single-Language Script
4.7 Server Status
4.8 Client Connections
4.9 Performance Dashboard
5 MySQL Shell Consoles
5.1 Console Browser
5.2 GUI Console and Toolbar
5.3 Add a New Shell Session
5.4 Connect to MySQL Shell Sessions
5.5 Process Commands in GUI Console
5.6 AdminAPI
5.6.1 Dba Methods in AdminAPI
5.6.2 InnoDB Cluster Methods
5.6.3 InnoDB ClusterSet Methods
5.6.4 InnoDB ReplicaSet Methods
5.7 X DevAPI
5.8 ShellAPI
5.9 MySQL Shell, MySQL Router, and InnoDB Cluster
5.10 Extending MySQL Shell Consoles
6 SQL
6.1 Create User Accounts
6.2 Retrieve Data with SELECT Statements
6.3 Join Tables, Update Records, and Insert Values
7 Python
7.1 MySQL Shell Consoles: Set up InnoDB Cluster using Python
8 JavaScript
8.1 Global Functions for JavaScript
8.2 DB Notebook: Retrieve Data with SELECT Statements
8.3 DB Notebook: Create and Drop a View
8.4 DB Notebook: Show Data in Visual Graph Format
9 TypeScript
9.1 TypeScript Global Functions
9.2 DB Notebook: Retrieve Data with SELECT Statements
9.3 DB Notebook: Create and Drop a View
9.4 DB Notebook: Show Data in Visual Graph Format
I Appendices
A AdminAPI Quick Reference
A.1 Dba Class Methods
A.2 Cluster Class Methods
A.3 ClusterSet Class Methods
A.4 ReplicaSet Class Methods
B Command Palette and Display Setting Reference
B.1 Command Palette
B.2 Display Settings
C Icons for Auto-Completion
D MySQL Shell for VS Code Certificates