Release Notes for MariaDB Shell 23.01.1

Notable Changes

• When MariaDB Shell raises an error to the user, the error message contains a URL that can be visited in a web browser to find error codes and other product details in the MariaDB Documentation. (TENT-265)

• For each sys sub-command that contains the legacy term slave, MariaDB Shell implements a replacement sub-command that replaces the legacy term slave with the replacement term replica (TENT-181):

  Old Sub-command	New Sub-command
  start-all-slaves	start-all-replicas
  start-slave	start-replica
  stop-all-slaves	stop-all-replicas
  stop-slave	stop-replica

• For consistency, MariaDB Shell also implements aliases for some other replication-related sys sub-commands that do not contain the legacy term slave:

  Old Sub-command	New Sub-command
  all-replication-status	all-replica-status
  replication-status	replica-status

• When the grants dump sub-command encounters errors, the error messages are output as SQL comments using the -- prefix, so that the sub-command output is valid SQL that can be executed. (TENT-192)

• MariaDB Shell adds support for connecting to database servers using a remote SSH tunnel. (TENT-59)

  • When the --ssh-user and --ssh-host command-line options are specified, a remote SSH tunnel is created between the client and the remote host.

  • On the client, the tunnel uses a random ephemeral TCP port. The client initiates the tunnel by connecting to the remote server on the standard SSH port. If the remote server uses a non-standard SSH port, it can be specified using the --ssh-port command-line option.

  • On the remote server, the traffic at the end of the tunnel is forwarded to the IP address 127.0.0.1 on the database port. The database port is specified in the normal way using the --port command-line option. Since the traffic is forwarded to 127.0.0.1, the SSH tunnel must terminate at the database server itself. Jump hosts are not currently supported.

  • MariaDB Shell supports password authentication and public key authentication for SSH tunnels:

    • The --ssh-pass command-line option can be used to enable password authentication. If an argument is provided, the argument is interpreted as the password. If no argument is provided, the user is prompted for the password.

    • The --ssh-key command-line option can be used to enable public key authentication. The argument must be the absolute path to the private key file. If the private key file is encrypted, the --ssh-key-pass command-line option can be used to specify the encryption password.

  • For example, to use a remote SSH tunnel with password authentication:

    $ mariadb-shell \
       --ssh-host HOSTNAME --ssh-port SSH_PORT \
       --ssh-user SSH_USER --ssh-password SSH_PASSWORD \
       --port TCP_PORT \
       --user DATABASE_USER --password DATABASE_PASSWORD
    

  • Or to use a remote SSH tunnel with public key authentication:

    $ mariadb-shell \
       --ssh-host HOSTNAME --ssh-port SSH_PORT \
       --ssh-user SSH_USER --ssh-key /home/MY_USER/.ssh/id_rsa --ssh-key-pass SSH_KEY_PASSWORD \
       --port TCP_PORT \
       --user DATABASE_USER --password DATABASE_PASSWORD
    

Issues Fixed

Known Issues

• This release of MariaDB Shell fails during execution if the installed MariaDB Connector/C package is the package bundled with MariaDB Enterprise Server. (CONPY-243)

  • The following error message can occur upon execution:

      File "/root/.pyenv/versions/3.10.7/lib/python3.10/site-packages/mariadb/__init__.py", line 136, in <module>
      File "/root/.pyenv/versions/3.10.7/lib/python3.10/site-packages/mariadb/__init__.py", line 136, in <genexpr>
    ValueError: invalid literal for int() with base 10: '17-12'
    

  • To use this release of MariaDB Shell, ensure that your MariaDB Connector/C package is the package bundled with MariaDB Community Server, which can be installed from the MariaDB Community Repository.

  • On CentOS, RHEL, and Rocky Linux, the MariaDB Connector/C package is called MariaDB-shared.

  • On Debian and Ubuntu, the MariaDB Connector/C package is called libmariadb3.

• This release of MariaDB Shell fails during execution if the MariaDB Connector/C package is not installed. (CONPY-243)

  • The following error message can occur upon execution:

      File "/root/.pyenv/versions/3.10.7/lib/python3.10/site-packages/mariadb/__init__.py", line 7, in <module>
    ImportError: libmariadb.so.3: cannot open shared object file: No such file or directory
    

  • To use this release of MariaDB Shell, ensure that the MariaDB Connector/C package is installed.

• When a file is piped to MariaDB Shell, the output still contains headers and prompts, as if an interactive shell were being used. (TENT-132)

  • This issue can impact users who want to use MariaDB Shell for non-interactive use cases.

• When a stored procedure is called and the database can't be determined, because no default database is currently selected and the procedure name is not fully qualified, MariaDB Shell raises an error with an unclear error message. (TENT-130)

  • In this release, the following error can be raised:

    MariaDB (No Database) » CALL example_sp();
    SLHE (21243) - Unknown prepared statement handler (4294967295) given to mysqld_stmt_execute
    For more information see: https://docs.mariadb.com/mariadb-shell/SLHE21243
    

• When a connection profile is used that defines a default database, MariaDB Shell does not select the database. (TENT-196)

• When MariaDB Shell is installed on WSL2 for Ubuntu, it does not install the libffi7 and OpenSSL 1.1.1 dependencies. (TENT-263)

Platforms

MariaDB Shell 23.01.1 is provided for:

• Apple macOS (x86_64, M1)

• CentOS 7 (x86_64)

• Debian 10 (x86_64)

• Debian 11 (x86_64)

• Microsoft Windows (x86_64)

• Red Hat Enterprise Linux 7 (x86_64)

• Red Hat Enterprise Linux 8 (x86_64)

• Red Hat Enterprise Linux 9 (x86_64)

• Rocky Linux 8 (x86_64)

• Rocky Linux 9 (x86_64)

• Ubuntu 18.04 (x86_64)

• Ubuntu 20.04 (x86_64)

• Ubuntu 22.04 (x86_64)

Installation

• Install MariaDB Shell

Resources

• Usage Documentation

• Usage Documentation for SkySQL

• Reference Documentation

• Issue Reporting