summaryrefslogtreecommitdiff
path: root/man/ndbd_redo_log_reader.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/ndbd_redo_log_reader.1')
-rw-r--r--man/ndbd_redo_log_reader.1176
1 files changed, 176 insertions, 0 deletions
diff --git a/man/ndbd_redo_log_reader.1 b/man/ndbd_redo_log_reader.1
new file mode 100644
index 00000000000..f6a2326cab4
--- /dev/null
+++ b/man/ndbd_redo_log_reader.1
@@ -0,0 +1,176 @@
+'\" t
+.\" Title: \fBndbd_redo_log_reader\fR
+.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
+.\" Date: 04/06/2010
+.\" Manual: MySQL Database System
+.\" Source: MySQL 5.1
+.\" Language: English
+.\"
+.TH "\FBNDBD_REDO_LOG_REA" "1" "04/06/2010" "MySQL 5\&.1" "MySQL Database System"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.\" ndbd_redo_log_reader
+.SH "NAME"
+ndbd_redo_log_reader \- check and print content of cluster redo log
+.SH "SYNOPSIS"
+.HP \w'\fBndbd_redo_log_reader\ \fR\fB\fIfile_name\fR\fR\fB\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u
+\fBndbd_redo_log_reader \fR\fB\fIfile_name\fR\fR\fB [\fR\fB\fIoptions\fR\fR\fB]\fR
+.SH "DESCRIPTION"
+.PP
+Reads a redo log file, checking it for errors, printing its contents in a human\-readable format, or both\&.
+\fBndbd_redo_log_reader\fR
+is intended for use primarily by MySQL developers and support personnel in debugging and diagnosing problems\&.
+.PP
+This utility was made available as part of default builds beginning with MySQL Cluster NDB 6\&.1\&.3\&. It remains under development, and its syntax and behavior are subject to change in future releases\&. For this reason, it should be considered experimental at this time\&.
+.PP
+The C++ source files for
+\fBndbd_redo_log_reader\fR
+can be found in the directory
+/storage/ndb/src/kernel/blocks/dblqh/redoLogReader\&.
+.PP
+The following table includes options that are specific to the MySQL Cluster program
+\fBndbd_redo_log_reader\fR\&. Additional descriptions follow the table\&. For options common to all MySQL Cluster programs, see
+Section\ \&17.4.2, \(lqOptions Common to MySQL Cluster Programs\(rq\&.
+.PP
+\fBUsage\fR:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+ndbd_redo_log_reader \fIfile_name\fR [\fIoptions\fR]
+.fi
+.if n \{\
+.RE
+.\}
+.PP
+\fIfile_name\fR
+is the name of a cluster REDO log file\&. REDO log files are located in the numbered directories under the data node\'s data directory (DataDir); the path under this directory to the REDO log files matches the pattern
+ndb_\fI#\fR_fs/D\fI#\fR/LCP/\fI#\fR/T\fI#\fRF\fI#\fR\&.Data\&. In each case, the
+\fI#\fR
+represents a number (not necessarily the same number)\&. For more information, see
+\m[blue]\fBCluster Data Node FileSystemDir Files\fR\m[]\&\s-2\u[1]\d\s+2\&.
+.PP
+The name of the file to be read may be followed by one or more of the options listed here:
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.TS
+allbox tab(:);
+l l s
+l l s
+^ l l
+^ l l.
+T{
+\fBCommand\-Line Format\fR
+T}:T{
+\-noprint
+T}
+T{
+\ \&
+T}:T{
+\fBPermitted Values \fR
+T}
+:T{
+\fBType\fR
+T}:T{
+boolean
+T}
+:T{
+\fBDefault\fR
+T}:T{
+FALSE
+T}
+.TE
+.sp 1
+\fB\-noprint\fR: Do not print the contents of the log file\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.TS
+allbox tab(:);
+l l s
+l l s
+^ l l
+^ l l.
+T{
+\fBCommand\-Line Format\fR
+T}:T{
+\-nocheck
+T}
+T{
+\ \&
+T}:T{
+\fBPermitted Values \fR
+T}
+:T{
+\fBType\fR
+T}:T{
+boolean
+T}
+:T{
+\fBDefault\fR
+T}:T{
+FALSE
+T}
+.TE
+.sp 1
+\fB\-nocheck\fR: Do not check the log file for errors\&.
+.RE
+.sp
+.RE
+.PP
+Like
+\fBndb_print_backup_file\fR
+and
+\fBndb_print_schema_file\fR
+(and unlike most of the
+NDB
+utilities that are intended to be run on a management server host or to connect to a management server)
+\fBndbd_redo_log_reader\fR
+must be run on a cluster data node, since it accesses the data node file system directly\&. Because it does not make use of the management server, this utility can be used when the management server is not running, and even when the cluster has been completely shut down\&.
+.SH "COPYRIGHT"
+.br
+.PP
+Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
+.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 "NOTES"
+.IP " 1." 4
+Cluster Data Node FileSystemDir Files
+.RS 4
+\%http://dev.mysql.com/doc/ndbapi/en/ndb-internals-ndbd-filesystemdir-files.html
+.RE
+.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
+Sun Microsystems, Inc. (http://www.mysql.com/).