The Stroz

MySQL Shell Alias For PowerShell

Sep 09, 2022
2 minutes

MySQL MySQL Shell PowerShell

Yesterday, my colleague, Fred (AKA LeFred), shared a blog post that discusses setting up aliases that allow us to run MySQL Shell when we enter mysql at a command prompt.

Since I also use Windows regularly, I wanted to share how you can set up those same aliases in Windows PowerShell.

We need to update our profile script to create permanent aliases in PowerShell. To determine where this file is located, open a PowerShell window and enter:

$profile

You should see text that looks like this:

C:\Users\{username}\Documents\WindowsPowerShell\Microsoft.PowerShell_profile.ps1

{username} will be the user currently logged in.

Once we have this file path, open that file in a text editor and add the following lines:

Function myshell{ mysqlsh --sql mysqlx://localhost }
Function myshellx{ mysqlsh --js mysqlx://localhost}

Set-Alias -Name mysql -Value myshell
Set-Alias -Name mysqlx -Value myshellx

Breaking these down, we see that running mysql from a PowerShell prompt will run mysqlsh in ‘SQL mode’, and running mysqlx will run mysqlsh in ‘JS Mode’. In both cases, it will attempt to connect to MySQL on the local system.

As Fred noted, by default MySQL Shell will try to log in to the MySQL server with the user running the command. If you want to use a different user, root for example (but this is frowned upon, especially outside a development environment), you could modify the function definitions to look like this:

Function myshell{ mysqlsh --sql mysqlx://root@localhost }
Function myshellx{ mysqlsh --js mysqlx://root@localhost}

I have my local development environment set up for MySQL with a user that matches the username of my Windows user, so I can use the first examples.

Make sure you have saved your changes, and then from a PowerShell prompt, run:

. $profile

This will reload our profile and pull in our new aliases.

Now, when we run the mysql command in PowerShell, we will see the following results:

MySQL Shell SQL mode example

If we want to start MySQL Shell in JS mode, we use the mysqlx command.

MySQL Shell JS mode example

I have become a big fan of MySQL Shell, and these aliases allow me to open MySQL Shell in the mode I want much quicker.

Photo by Stéphan Valentin on Unsplash