summaryrefslogtreecommitdiff
path: root/man/myisam_ftdump.1
blob: cc807d7872b0232a6a0179299c7e9e97230a44b3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
'\" t
.\"
.TH "\FBMYISAM_FTDUMP\FR" "1" "9 May 2017" "MariaDB 10\&.3" "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-2015 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-1301 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/).