.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "ISQL-FB 1"
.TH ISQL-FB 1 2024-03-05 "Firebird 3.0" "Firebird documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
isql \-\- Firebird Interactive SQL shell
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBisql\fR [\-a] [\-cache \fInumber\fR] [\-database \fIpath\fR] [\-echo] [\-input \fIfile\fR]
[\-merge_stderr] [\-noautocommit] [\-nowarnings] [\-output \fIfile\fR] [\-password
\&\fIstring\fR] [\-page \fInumber\fR] [\-role \fIstring\fR] [\-s \fInumber\fR] [\-terminator
\&\fIstring\fR] [\-user \fIname\fR] [\-x] [\-z]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBisql\fR is a program that allows the user to issue arbitrary SQL commands
as well as exctacting the metadata.
.PP
\&\fBisql\fR in \fBDebian\fR is available under the \fBisql-fb\fR name due to filename
conflict with an executable from another package.
.SH OPTIONS
.IX Header "OPTIONS"
\&\fBisql\fR can handle various command line options. Most options can be
abbreviated. Below are given the shortest abbreviations as well as the full
versions.
.IP \fB\-a\fR 4
.IX Item "-a"
Extract DDL (Data definition language) statements necessary to re-create
database's structure, triggers and other metadata. The \f(CW\*(C`CREATE DATABASE\*(C'\fR
statement is in a comment. Statements are printed to standard
output unless \-output is used. See also \-extract.
.IP "\fB\-c\fR \fIbuffers\fR" 4
.IX Item "-c buffers"
.PD 0
.IP "\fB\-cache\fR \fInumber\fR" 4
.IX Item "-cache number"
.PD
Specify default size of the buffers to be used in database pages.
.IP "\fB\-d\fR \fIpath\fR" 4
.IX Item "-d path"
.PD 0
.IP "\fB\-database\fR \fIpath\fR" 4
.IX Item "-database path"
.PD
Specifies target database name when extracting the metadata with the
\&\-extract option.
.IP \fB\-e\fR 4
.IX Item "-e"
.PD 0
.IP \fB\-echo\fR 4
.IX Item "-echo"
.PD
Prints each statement before executing it.
.IP \fB\-x\fR 4
.IX Item "-x"
.PD 0
.IP \fB\-ex\fR 4
.IX Item "-ex"
.IP \fB\-extract\fR 4
.IX Item "-extract"
.PD
Extracts DDL statements to recreate database metadata.
.Sp
If no \-database option is given, \fB\-extract\fR behaves exactly as \-a. If
\&\-database is given, the \f(CW\*(C`CREATE DATABASE\*(C'\fR statement is not commented and
the database name is replaced with \fIpath\fR.
.IP "\fB\-i\fR \fIfile\fR" 4
.IX Item "-i file"
.PD 0
.IP "\fB\-input\fR \fIfile\fR" 4
.IX Item "-input file"
.PD
Reads commands from \fIfile\fR instead of standard input. Exits with commit after
the last command.
.IP \fB\-m\fR 4
.IX Item "-m"
.PD 0
.IP \fB\-merge_stderr\fR 4
.IX Item "-merge_stderr"
.PD
Merges standard error to standard output. Useful for redirecting both streams.
.IP \fB\-n\fR 4
.IX Item "-n"
.PD 0
.IP \fB\-noautocommit\fR 4
.IX Item "-noautocommit"
.PD
Normally, all DDL statements like \f(CW\*(C`CREATE TABLE\*(C'\fR are automatically committed
in a separate transaction. This option disables the automatic commit of DDL
statements.
.IP \fB\-nowarnings\fR 4
.IX Item "-nowarnings"
Disables displaying of SQL warnings.
.IP "\fB\-o\fR \fIfile\fR" 4
.IX Item "-o file"
.PD 0
.IP "\fB\-output\fR \fIfile\fR" 4
.IX Item "-output file"
.PD
All output is redirected to the given \fIfile\fR.
.IP "\fB\-page\fR \fInumber\fR" 4
.IX Item "-page number"
.PD 0
.IP "\fB\-pagelength\fR \fInumber\fR" 4
.IX Item "-pagelength number"
.PD
Prints column headers every \fInumber\fR output lines. Default is \f(CW20\fR.
.IP "\fB\-pas\fR \fIstring\fR" 4
.IX Item "-pas string"
.PD 0
.IP "\fB\-password\fR \fIstring\fR" 4
.IX Item "-password string"
.PD
Uses given password as a default when connecting to databases.
.IP "\fB\-r\fR \fIstring\fR" 4
.IX Item "-r string"
.PD 0
.IP "\fB\-role\fR \fIstring\fR" 4
.IX Item "-role string"
.PD
Uses given SQL role as a default when connecting to databases.
.IP "\fB\-s\fR \fInumber\fR" 4
.IX Item "-s number"
.PD 0
.IP "\fB\-sqldialect\fR \fInumber\fR" 4
.IX Item "-sqldialect number"
.PD
Uses given SQL dialect as a default when connecting to databases. The default
is \f(CW1\fR.
.IP "\fB\-t\fR \fIstring\fR" 4
.IX Item "-t string"
.PD 0
.IP "\fB\-terminator\fR \fIstring\fR" 4
.IX Item "-terminator string"
.PD
Set command line terminator. Default is semicolon \f(CW\*(C`;\*(C'\fR.
.IP "\fB\-u\fR \fIstring\fR" 4
.IX Item "-u string"
.PD 0
.IP "\fB\-user\fR \fIstring\fR" 4
.IX Item "-user string"
.PD
Uses given user name as a default when connecting to databases.
.IP \fB\-z\fR 4
.IX Item "-z"
Prints program version string before doing anything else. Prints server version
after connecting to a database.
.SH ENVIRONMENT
.IX Header "ENVIRONMENT"
.IP \fBISC_USER\fR 4
.IX Item "ISC_USER"
Default value for the \-user option.
.IP \fBISC_ROLE\fR 4
.IX Item "ISC_ROLE"
Default value for the \-role option.
.IP \fBISC_PASSWORD\fR 4
.IX Item "ISC_PASSWORD"
Default value for the \-password option.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBgbak\fR\|(1), \fBgfix\fR\|(1), \fBfbstat\fR\|(1).
.PP
Additional documentation about Firebird can be found on the Firebird Project
website, <http://www.firebirdsql.org>.
.SH AUTHOR
.IX Header "AUTHOR"
This manual page was written by Damyan Ivanov dmn@debian.org for the Debian
project. Permission is granted to use this document, with or without
modifications, provided that this notice is retained. If we meet some day, and
you think this stuff is worth it, you can buy me a beer in return.