~james-page/ubuntu/precise/mysql-5.5/misc-fixes

'\" t
.\"     Title: \fBndb_select_all\fR
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 04/19/2012
.\"    Manual: MySQL Database System
.\"    Source: MySQL 5.5
.\"  Language: English
.\"
.TH "\FBNDB_SELECT_ALL\FR" "1" "04/19/2012" "MySQL 5\&.5" "MySQL Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.\" ndb_select_all
.SH "NAME"
ndb_select_all \- print rows from an NDB table
.SH "SYNOPSIS"
.HP \w'\fBndb_select_all\ \-c\ \fR\fB\fIconnect_string\fR\fR\fB\ \fR\fB\fItbl_name\fR\fR\fB\ \-d\ \fR\fB\fIdb_name\fR\fR\fB\ [>\ \fR\fB\fIfile_name\fR\fR\fB]\fR\ 'u
\fBndb_select_all \-c \fR\fB\fIconnect_string\fR\fR\fB \fR\fB\fItbl_name\fR\fR\fB \-d \fR\fB\fIdb_name\fR\fR\fB [> \fR\fB\fIfile_name\fR\fR\fB]\fR
.SH "DESCRIPTION"
.PP
\fBndb_select_all\fR
prints all rows from an
NDB
table to
stdout\&.
          Usage
.sp
.if n \{\
.RS 4
.\}
.nf
ndb_select_all \-c \fIconnect_string\fR \fItbl_name\fR \-d \fIdb_name\fR [> \fIfile_name\fR]
.fi
.if n \{\
.RE
.\}
.sp
          Additional Options
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_select_all: lock option
.\" lock option: ndb_select_all
\fB\-\-lock=\fR\fB\fIlock_type\fR\fR,
\fB\-l \fR\fB\fIlock_type\fR\fR
.sp
Employs a lock when reading the table\&. Possible values for
\fIlock_type\fR
are:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
0: Read lock
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
1: Read lock with hold
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
2: Exclusive read lock
.RE
.RS 4
There is no default value for this option\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_select_all: order option
.\" order option: ndb_select_all
\fB\-\-order=\fR\fB\fIindex_name\fR\fR,
\fB\-o \fR\fB\fIindex_name\fR\fR
.sp
Orders the output according to the index named
\fIindex_name\fR\&. Note that this is the name of an index, not of a column, and that the index must have been explicitly named when created\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_select_all: descending option
.\" descending option: ndb_select_all
\fB\-\-descending\fR,
\fB\-z\fR
.sp
Sorts the output in descending order\&. This option can be used only in conjunction with the
\fB\-o\fR
(\fB\-\-order\fR) option\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_select_all: header option
.\" header option: ndb_select_all
\fB\-\-header=FALSE\fR
.sp
Excludes column headers from the output\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_select_all: useHexFormat option
.\" useHexFormat option: ndb_select_all
\fB\-\-useHexFormat\fR
\fB\-x\fR
.sp
Causes all numeric values to be displayed in hexadecimal format\&. This does not affect the output of numerals contained in strings or datetime values\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_select_all: delimiter option
.\" delimiter option: ndb_select_all
\fB\-\-delimiter=\fR\fB\fIcharacter\fR\fR,
\fB\-D \fR\fB\fIcharacter\fR\fR
.sp
Causes the
\fIcharacter\fR
to be used as a column delimiter\&. Only table data columns are separated by this delimiter\&.
.sp
The default delimiter is the tab character\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_select_all: disk option
.\" disk option: ndb_select_all
\fB\-\-disk\fR
.sp
Adds a disk reference column to the output\&. The column is nonempty only for Disk Data tables having nonindexed columns\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_select_all: rowid option
.\" rowid option: ndb_select_all
\fB\-\-rowid\fR
.sp
Adds a
ROWID
column providing information about the fragments in which rows are stored\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_select_all: gci option
.\" gci option: ndb_select_all
\fB\-\-gci\fR
.sp
Adds a column to the output showing the global checkpoint at which each row was last updated\&. See
Section\ \&17.1, \(lqMySQL Cluster Overview\(rq, and
Section\ \&17.5.5.2, \(lqMySQL Cluster Log Events\(rq, for more information about checkpoints\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_select_all: tupscan option
.\" tupscan option: ndb_select_all
\fB\-\-tupscan\fR,
\fB\-t\fR
.sp
Scan the table in the order of the tuples\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_select_all: nodata option
.\" nodata option: ndb_select_all
\fB\-\-nodata\fR
.sp
Causes any table data to be omitted\&.
.RE
          Sample Output
        .PP
Output from a MySQL
SELECT
statement:
.sp
.if n \{\
.RS 4
.\}
.nf
mysql> \fBSELECT * FROM ctest1\&.fish;\fR
+\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-+
| id | name      |
+\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-+
|  3 | shark     |
|  6 | puffer    |
|  2 | tuna      |
|  4 | manta ray |
|  5 | grouper   |
|  1 | guppy     |
+\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-+
6 rows in set (0\&.04 sec)
.fi
.if n \{\
.RE
.\}
.PP
Output from the equivalent invocation of
\fBndb_select_all\fR:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fB\&./ndb_select_all \-c localhost fish \-d ctest1\fR
id      name
3       [shark]
6       [puffer]
2       [tuna]
4       [manta ray]
5       [grouper]
1       [guppy]
6 rows returned
NDBT_ProgramExit: 0 \- OK
.fi
.if n \{\
.RE
.\}
.PP
Note that all string values are enclosed by square brackets (\(lq[\&.\&.\&.]\(rq) in the output of
\fBndb_select_all\fR\&. For a further example, consider the table created and populated as shown here:
.sp
.if n \{\
.RS 4
.\}
.nf
CREATE TABLE dogs (
    id INT(11) NOT NULL AUTO_INCREMENT,
    name VARCHAR(25) NOT NULL,
    breed VARCHAR(50) NOT NULL,
    PRIMARY KEY pk (id),
    KEY ix (name)
)
TABLESPACE ts STORAGE DISK
ENGINE=NDBCLUSTER;
INSERT INTO dogs VALUES
    (\'\', \'Lassie\', \'collie\'),
    (\'\', \'Scooby\-Doo\', \'Great Dane\'),
    (\'\', \'Rin\-Tin\-Tin\', \'Alsatian\'),
    (\'\', \'Rosscoe\', \'Mutt\');
.fi
.if n \{\
.RE
.\}
.PP
This demonstrates the use of several additional
\fBndb_select_all\fR
options:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fB\&./ndb_select_all \-d ctest1 dogs \-o ix \-z \-\-gci \-\-disk\fR
GCI     id name          breed        DISK_REF
834461  2  [Scooby\-Doo]  [Great Dane] [ m_file_no: 0 m_page: 98 m_page_idx: 0 ]
834878  4  [Rosscoe]     [Mutt]       [ m_file_no: 0 m_page: 98 m_page_idx: 16 ]
834463  3  [Rin\-Tin\-Tin] [Alsatian]   [ m_file_no: 0 m_page: 34 m_page_idx: 0 ]
835657  1  [Lassie]      [Collie]     [ m_file_no: 0 m_page: 66 m_page_idx: 0 ]
4 rows returned
NDBT_ProgramExit: 0 \- OK
.fi
.if n \{\
.RE
.\}
.SH "COPYRIGHT"
.br
.PP
Copyright \(co 1997, 2012, Oracle and/or its affiliates. All rights reserved.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
.PP
This documentation 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.
.PP
You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/.
.sp
.SH "SEE ALSO"
For more information, please refer to the MySQL Reference Manual,
which may already be installed locally and which is also available
online at http://dev.mysql.com/doc/.
.SH AUTHOR
Oracle Corporation (http://dev.mysql.com/).