mirror of
https://github.com/MariaDB/server.git
synced 2025-01-16 03:52:35 +01:00
6f955c262a
For the sake of readable diffs this change is done separately from the previous commit and it changes all man page headers to: - Use correct syntax \fB and \fR to make titles bold instead of previous capitalized version that had no effect - Omit unnecessary \&. syntax, works fine without it - Bump version to 10.11 Ideally the version would automatically be inherited from the build/release, but for now at least update it manually to match what is in the VERSION file of this release branch. All new code of the whole pull request, including one or several files that are either new files or modified ones, are contributed under the BSD-new license. I am contributing on behalf of my employer Amazon Web Services, Inc.
249 lines
5.4 KiB
Groff
249 lines
5.4 KiB
Groff
'\" t
|
|
.\"
|
|
.TH "\fBMYISAM_FTDUMP\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.\" myisam_ftdump
|
|
.SH "NAME"
|
|
myisam_ftdump \- display full\-text index information
|
|
.SH "SYNOPSIS"
|
|
.HP \w'\fBmyisam_ftdump\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fItbl_name\fR\fR\fB\ \fR\fB\fIindex_num\fR\fR\ 'u
|
|
\fBmyisam_ftdump [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fItbl_name\fR\fR\fB \fR\fB\fIindex_num\fR\fR
|
|
.SH "DESCRIPTION"
|
|
.PP
|
|
\fBmyisam_ftdump\fR
|
|
displays information about
|
|
FULLTEXT
|
|
indexes in
|
|
MyISAM
|
|
tables\&. It reads the
|
|
MyISAM
|
|
index file directly, so it must be run on the server host where the table is located\&. Before using
|
|
\fBmyisam_ftdump\fR, be sure to issue a
|
|
FLUSH TABLES
|
|
statement first if the server is running\&.
|
|
.PP
|
|
\fBmyisam_ftdump\fR
|
|
scans and dumps the entire index, which is not particularly fast\&. On the other hand, the distribution of words changes infrequently, so it need not be run often\&.
|
|
.PP
|
|
Invoke
|
|
\fBmyisam_ftdump\fR
|
|
like this:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
shell> \fBmyisam_ftdump [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fItbl_name\fR\fR\fB \fR\fB\fIindex_num\fR\fR
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
The
|
|
\fItbl_name\fR
|
|
argument should be the name of a
|
|
MyISAM
|
|
table\&. You can also specify a table by naming its index file (the file with the
|
|
\&.MYI
|
|
suffix)\&. If you do not invoke
|
|
\fBmyisam_ftdump\fR
|
|
in the directory where the table files are located, the table or index file name must be preceded by the path name to the table's database directory\&. Index numbers begin with 0\&.
|
|
.PP
|
|
Example: Suppose that the
|
|
test
|
|
database contains a table named
|
|
mytexttablel
|
|
that has the following definition:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
CREATE TABLE mytexttable
|
|
(
|
|
id INT NOT NULL,
|
|
txt TEXT NOT NULL,
|
|
PRIMARY KEY (id),
|
|
FULLTEXT (txt)
|
|
);
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
The index on
|
|
id
|
|
is index 0 and the
|
|
FULLTEXT
|
|
index on
|
|
txt
|
|
is index 1\&. If your working directory is the
|
|
test
|
|
database directory, invoke
|
|
\fBmyisam_ftdump\fR
|
|
as follows:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
shell> \fBmyisam_ftdump mytexttable 1\fR
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
If the path name to the
|
|
test
|
|
database directory is
|
|
/usr/local/mysql/data/test, you can also specify the table name argument using that path name\&. This is useful if you do not invoke
|
|
\fBmyisam_ftdump\fR
|
|
in the database directory:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
shell> \fBmyisam_ftdump /usr/local/mysql/data/test/mytexttable 1\fR
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
You can use
|
|
\fBmyisam_ftdump\fR
|
|
to generate a list of index entries in order of frequency of occurrence like this:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
shell> \fBmyisam_ftdump \-c mytexttable 1 | sort \-r\fR
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
\fBmyisam_ftdump\fR
|
|
supports the following options:
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" myisam_ftdump: help option
|
|
.\" help option: myisam_ftdump
|
|
\fB\-\-help\fR,
|
|
\fB\-h\fR
|
|
\fB\-?\fR
|
|
.sp
|
|
Display a help message and exit\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" myisam_ftdump: count option
|
|
.\" count option: myisam_ftdump
|
|
\fB\-\-count\fR,
|
|
\fB\-c\fR
|
|
.sp
|
|
Calculate per\-word statistics (counts and global weights)\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" myisam_ftdump: dump option
|
|
.\" dump option: myisam_ftdump
|
|
\fB\-\-dump\fR,
|
|
\fB\-d\fR
|
|
.sp
|
|
Dump the index, including data offsets and word weights\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" myisam_ftdump: length option
|
|
.\" length option: myisam_ftdump
|
|
\fB\-\-length\fR,
|
|
\fB\-l\fR
|
|
.sp
|
|
Report the length distribution\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" myisam_ftdump: stats option
|
|
.\" stats option: myisam_ftdump
|
|
\fB\-\-stats\fR,
|
|
\fB\-s\fR
|
|
.sp
|
|
Report global index statistics\&. This is the default operation if no other operation is specified\&.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
.\" myisam_ftdump: verbose option
|
|
.\" verbose option: myisam_ftdump
|
|
\fB\-\-verbose\fR,
|
|
\fB\-v\fR
|
|
.sp
|
|
Verbose mode\&. Print more output about what the program does\&.
|
|
.RE
|
|
.SH "COPYRIGHT"
|
|
.br
|
|
.PP
|
|
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation
|
|
.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-1335 USA or see http://www.gnu.org/licenses/.
|
|
.sp
|
|
.SH "SEE ALSO"
|
|
For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/
|
|
.SH AUTHOR
|
|
MariaDB Foundation (http://www.mariadb.org/).
|