Skip to content
Shell for MySQL connections (optionally forwarded over SSH) with Ruby-based recipes to save common queries and processing tasks.
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
bin
lib
test
.yardopts
LICENSE
README.rdoc
Rakefile
example.rsqlrc
example.rsqlrc.rdoc

README.rdoc

RSQL

Homepage

rubygems.org/gems/rsql

DESCRIPTION

This is an application to make working with a SQL command line more convenient by allowing interaction with recipes and Ruby code in addition to embedding the common operation of using a SSH connection to an intermediary host for access to the SQL server.

Installation

gem install rsql

Alternatively, RSQL can be downloaded as a tar.gz or zip and run directly from within the unpacked source directory as long as the MySQL Ruby library is available. SSH functionality will be disabled unless the Net::SSH Ruby library is also installed and available.

USAGE

RSQL is invoked from the command line using:

rsql [<options>] <mysql_host> [<database>] [-e [<query>]]

Options

-version

Display the version of RSQL that is installed.

-verbose

Display details on SSH connections and evaluation stack traces.

-rc rcfile

Override loading the .rsqlrc file from the HOME directory for one in a different location.

-maxrows max

Override the maximum number of rows to process.

-batch field_separator

Run in batch mode using the separator specified (e.g. a /t will separate fields with a tab character).

-ssh ssh_host

Establish a SSH connection before connecting to the MySQL host.

-sshconfig ssh_config

Use a specific SSH configuration file instead of the default files loaded at runtime by Net::SSH.

-e [query]

Run a query from the command line (i.e. not interactive). If a query is not provided, STDIN will be read. Multiple commands can be issued in one set by separation with semicolons just as if they had been provided at the RSQL prompt interactively. This option must be the last option specified.

The ssh_host and mysql_host arguments may optionally include user, password, or port values using the following syntax:

[<user>[:<password>]@]<host>[:<port>]

Once at the rsql prompt, normal MySQL queries can be entered as expected, ending each with a semicolon (;) for columnar output or \G for line-by-line output formatting.

Ruby commands will be evaluated for any content entered at the RSQL prompt beginning with a period.

Command Line Examples

Connect as the “root” user to a MySQL server running on the local host, with no password (because there are no characters listed between the colon and the at sign):

rsql root:@127.0.0.1

Connect as the “readonly” user to the “internal.database.acme.com” host's MySQL server after establishing a SSH tunnel to the “external.acme.com” gateway. In this case, we are expecting that our SSH configuration is set up with the right user name. Because we did not provide a password for MySQL, one will be obtained directly from the console (without echoing the characters typed):

rsql -ssh external.acme.com readonly@internal.database.acme.com

GETTING STARTED

Try out the {file:example.rsqlrc.rdoc} for a painless introduction on how to leverage RSQL.

The file is available as example.rsqlrc installed with the gem or downloaded with the source.

LICENSE

RSQL is licensed under the MIT License:

Copyright (C) 2011-2012 by Brad Robel-Forrest <brad+rsql@gigglewax.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.