|
NAMEsql - execute a command on a database determined by a dburlSYNOPSISsql [options] dburl [commands]sql [options] dburl < commandfile #!/usr/bin/sql --shebang [options] dburl DESCRIPTIONGNU sql aims to give a simple, unified interface for accessing databases through all the different databases' command line clients. So far the focus has been on giving a common way to specify login information (protocol, username, password, hostname, and port number), size (database and table size), and running queries.The database is addressed using a DBURL. If commands are left out you will get that database's interactive shell. GNU sql is often used in combination with GNU parallel.
DBURLA DBURL has the following syntax: [sql:]vendor:// [[user][:password]@][host][:port]/[database][?sqlquery]To quote special characters use %-encoding specified in http://tools.ietf.org/html/rfc3986#section-2.1 (E.g. a password containing '/' would contain '%2F'). Examples: mysql://scott:tiger@my.example.com/mydb sql:oracle://scott:tiger@ora.example.com/xe postgresql://scott:tiger@pg.example.com/pgdb pg:/// postgresqlssl://scott@pg.example.com:3333/pgdb sql:sqlite2:////tmp/db.sqlite?SELECT * FROM foo; sqlite3:///../db.sqlite3?SELECT%20*%20FROM%20foo; Currently supported vendors: MySQL (mysql), MySQL with SSL (mysqls, mysqlssl), Oracle (oracle, ora), PostgreSQL (postgresql, pg, pgsql, postgres), PostgreSQL with SSL (postgresqlssl, pgs, pgsqlssl, postgresssl, pgssl, postgresqls, pgsqls, postgress), SQLite2 (sqlite, sqlite2), SQLite3 (sqlite3). Aliases must start with ':' and are read from /etc/sql/aliases and ~/.sql/aliases. The user's own ~/.sql/aliases should only be readable by the user. Example of aliases: :myalias1 pg://scott:tiger@pg.example.com/pgdb :myalias2 ora://scott:tiger@ora.example.com/xe # Short form of mysql://`whoami`:nopassword@localhost:3306/`whoami` :myalias3 mysql:/// # Short form of mysql://`whoami`:nopassword@localhost:33333/mydb :myalias4 mysql://:33333/mydb # Alias for an alias :m :myalias4 # the sortest alias possible : sqlite2:////tmp/db.sqlite # Including an SQL query :query sqlite:////tmp/db.sqlite?SELECT * FROM foo; EXAMPLESGet an interactive promptThe most basic use of GNU sql is to get an interactive prompt:sql sql:oracle://scott:tiger@ora.example.com/xe If you have setup an alias you can do: sql :myora Run a queryTo run a query directly from the command line:sql :myalias "SELECT * FROM foo;" Oracle requires newlines after each statement. This can be done like this: sql :myora "SELECT * FROM foo;" "SELECT * FROM bar;" Or this: sql :myora "SELECT * FROM foo;\nSELECT * FROM bar;" Copy a PostgreSQL databaseTo copy a PostgreSQL database use pg_dump to generate the dump and GNU sql to import it:pg_dump pg_database | sql pg://scott:tiger@pg.example.com/pgdb Empty all tables in a MySQL databaseUsing GNU parallel it is easy to empty all tables without dropping them:sql -n mysql:/// 'show tables' | parallel sql mysql:/// DELETE FROM {}; Drop all tables in a PostgreSQL databaseTo drop all tables in a PostgreSQL database do:sql -n pg:/// '\dt' | parallel --colsep '\|' -r sql pg:/// DROP TABLE {2}; Run as a scriptInstead of doing:sql mysql:/// < sqlfile you can combine the sqlfile with the DBURL to make a UNIX-script. Create a script called demosql: #!/usr/bin/sql -Y mysql:/// SELECT * FROM foo; Then do: chmod +x demosql; ./demosql Use --colsep to process multiple columnsUse GNU parallel's --colsep to separate columns:sql -s '\t' :myalias 'SELECT * FROM foo;' | parallel --colsep '\t' do_stuff {4} {1} Retry if the connection failsIf the access to the database fails occasionally --retries can help make sure the query succeeds:sql --retries 5 :myalias 'SELECT * FROM really_big_foo;' Get info about the running database systemShow how big the database is:sql --db-size :myalias List the tables: sql --list-tables :myalias List the size of the tables: sql --table-size :myalias List the running processes: sql --show-processlist :myalias REPORTING BUGSGNU sql is part of GNU parallel. Report bugs to <bug-parallel@gnu.org>.AUTHORWhen using GNU sql for a publication please cite:O. Tange (2011): GNU SQL - A Command Line Tool for Accessing Different Databases Using DBURLs, ;login: The USENIX Magazine, April 2011:29-32. Copyright (C) 2008-2010 Ole Tange http://ole.tange.dk Copyright (C) 2010-2022 Ole Tange, http://ole.tange.dk and Free Software Foundation, Inc. LICENSEThis program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or at your option any later version.This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>. Documentation license IPermission is granted to copy, distribute and/or modify this documentation under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the file LICENSES/GFDL-1.3-or-later.txt.Documentation license IIYou are free:
Under the following conditions:
With the understanding that:
A copy of the full license is included in the file as cc-by-sa.txt. DEPENDENCIESGNU sql uses Perl. If mysql is installed, MySQL dburls will work. If psql is installed, PostgreSQL dburls will work. If sqlite is installed, SQLite2 dburls will work. If sqlite3 is installed, SQLite3 dburls will work. If sqlplus is installed, Oracle dburls will work. If rlwrap is installed, GNU sql will have a command history for Oracle.FILES~/.sql/aliases - user's own aliases with DBURLs/etc/sql/aliases - common aliases with DBURLs SEE ALSOmysql(1), psql(1), rlwrap(1), sqlite(1), sqlite3(1), sqlplus(1)
Visit the GSP FreeBSD Man Page Interface. |