1IBD2SDI(1)                   MySQL Database System                  IBD2SDI(1)
2
3
4

NAME

6       ibd2sdi - InnoDB utility for extracting serialized dictionary
7       information (SDI) from an InnoDB tablespace
8

SYNOPSIS

10       ibd2sdi [options] file_name1 [file_name2 file_name3 ...]
11

DESCRIPTION

13       ibd2sdi is a utility for extracting serialized dictionary information
14       (SDI) from InnoDB tablespace files. SDI data is present all persistent
15       InnoDB tablespace files.
16
17       ibd2sdi can be run on file-per-table tablespace files (*.ibd files),
18       general tablespace files (*.ibd files), system tablespace files
19       (ibdata* files), and the data dictionary tablespace (mysql.ibd). It is
20       not supported for use with temporary tablespaces or undo tablespaces.
21
22       ibd2sdi can be used at runtime or while the server is offline. During
23       DDL operations, ROLLBACK operations, and undo log purge operations
24       related to SDI, there may be a short interval of time when ibd2sdi
25       fails to read SDI data stored in the tablespace.
26
27       ibd2sdi performs an uncommitted read of SDI from the specified
28       tablespace. Redo logs and undo logs are not accessed.
29
30       Invoke the ibd2sdi utility like this:
31
32           shell> ibd2sdi [options] file_name1 [file_name2 file_name3 ...]
33
34       ibd2sdi supports multi-file tablespaces like the InnoDB system
35       tablespace, but it cannot be run on more than one tablespace at a time.
36       For multi-file tablespaces, specify each file:
37
38           shell> ibd2sdi ibdata1 ibdata2
39
40       The files of a multi-file tablespace must be specified in order of the
41       ascending page number. If two successive files have the same space ID,
42       the later file must start with the last page number of the previous
43       file + 1.
44
45       ibd2sdi outputs SDI (containing id, type, and data fields) in JSON
46       format.  ibd2sdi Options
47
48       ibd2sdi supports the following options:
49
50       ·   --help, -h
51
52           Displays command-line help.
53
54               shell> ibd2sdi --help
55               Usage: ./ibd2sdi [-v] [-c <strict-check>] [-d <dump file name>] [-n] filename1 [filenames]
56               See http://dev.mysql.com/doc/refman/8.0/en/ibd2sdi.html for usage hints.
57                 -h, --help          Display this help and exit.
58                 -v, --version       Display version information and exit.
59                 -#, --debug[=name]  Output debug log. See
60                                     http://dev.mysql.com/doc/refman/8.0/en/dbug-package.html
61                 -d, --dump-file=name
62                                     Dump the tablespace SDI into the file passed by user.
63                                     Without the filename, it will default to stdout
64                 -s, --skip-data     Skip retrieving data from SDI records. Retrieve only id
65                                     and type.
66                 -i, --id=#          Retrieve the SDI record matching the id passed by user.
67                 -t, --type=#        Retrieve the SDI records matching the type passed by
68                                     user.
69                 -c, --strict-check=name
70                                     Specify the strict checksum algorithm by the user.
71                                     Allowed values are innodb, crc32, none.
72                 -n, --no-check      Ignore the checksum verification.
73                 -p, --pretty        Pretty format the SDI output.If false, SDI would be not
74                                     human readable but it will be of less size
75                                     (Defaults to on; use --skip-pretty to disable.)
76               Variables (--variable-name=value)
77               and boolean options {FALSE|TRUE}  Value (after reading options)
78               --------------------------------- ----------------------------------------
79               debug                             (No default value)
80               dump-file                         (No default value)
81               skip-data                         FALSE
82               id                                0
83               type                              0
84               strict-check                      crc32
85               no-check                          FALSE
86               pretty                            TRUE
87
88       ·   --version, -v
89
90           Displays MySQL version information.
91
92               shell> ibd2sdi --version
93               ibd2sdi  Ver 8.0.3-dmr for Linux on x86_64 (Source distribution)
94
95       ·   --debug[=debug_options], -# [debug_options]
96
97           Prints a debug log. For debug options, refer to Section 29.5.4,
98           “The DBUG Package”.
99
100               shell> ibd2sdi --debug=d:t /tmp/ibd2sdi.trace
101
102           This option is available only if MySQL was built using WITH_DEBUG.
103           MySQL release binaries provided by Oracle are not built using this
104           option.
105
106       ·   --dump-file=, -d
107
108           Dumps serialized dictionary information (SDI) into the specified
109           dump file. If a dump file is not specified, the tablespace SDI is
110           dumped to stdout.
111
112               shell> ibd2sdi --dump-file=file_name ../data/test/t1.ibd
113
114       ·   --skip-data, -s
115
116           Skips retrieval of data field values from the serialized dictionary
117           information (SDI) and only retrieves the id and type field values,
118           which are primary keys for SDI records.
119
120               shell> ibd2sdi --skip-data ../data/test/t1.ibd
121               ["ibd2sdi"
122               ,
123               {
124                    "type": 1,
125                    "id": 330
126               }
127               ,
128               {
129                    "type": 2,
130                    "id": 7
131               }
132               ]
133
134       ·   --id=#, -i #
135
136           Retrieves serialized dictionary information (SDI) matching the
137           specified table or tablespace object id. An object id is unique to
138           the object type. Table and tablespace object IDs are also found in
139           the id column of the mysql.tables and mysql.tablespace data
140           dictionary tables. For information about data dictionary tables,
141           see Section 14.1, “Data Dictionary Schema”.
142
143               shell> ibd2sdi --id=7 ../data/test/t1.ibd
144               ["ibd2sdi"
145               ,
146               {
147                    "type": 2,
148                    "id": 7,
149                    "object":
150                         {
151                   "mysqld_version_id": 80003,
152                   "dd_version": 80003,
153                   "sdi_version": 1,
154                   "dd_object_type": "Tablespace",
155                   "dd_object": {
156                       "name": "test/t1",
157                       "comment": "",
158                       "options": "",
159                       "se_private_data": "flags=16417;id=2;server_version=80003;space_version=1;",
160                       "engine": "InnoDB",
161                       "files": [
162                           {
163                               "ordinal_position": 1,
164                               "filename": "./test/t1.ibd",
165                               "se_private_data": "id=2;"
166                           }
167                       ]
168                   }
169               }
170               }
171               ]
172
173       ·   --type=#, -t #
174
175           Retrieves serialized dictionary information (SDI) matching the
176           specified object type. SDI is provided for table (type=1) and
177           tablespace (type=2) objects.
178
179               shell> ibd2sdi --type=2 ../data/test/t1.ibd
180               ["ibd2sdi"
181               ,
182               {
183                    "type": 2,
184                    "id": 7,
185                    "object":
186                         {
187                   "mysqld_version_id": 80003,
188                   "dd_version": 80003,
189                   "sdi_version": 1,
190                   "dd_object_type": "Tablespace",
191                   "dd_object": {
192                       "name": "test/t1",
193                       "comment": "",
194                       "options": "",
195                       "se_private_data": "flags=16417;id=2;server_version=80003;space_version=1;",
196                       "engine": "InnoDB",
197                       "files": [
198                           {
199                               "ordinal_position": 1,
200                               "filename": "./test/t1.ibd",
201                               "se_private_data": "id=2;"
202                           }
203                       ]
204                   }
205               }
206               }
207               ]
208
209       ·   --strict-check, -c
210
211           Specifies a strict checksum algorithm for validating the checksum
212           of pages that are read. Options include innodb, crc32, and none.
213
214           In this example, the strict version of the innodb checksum
215           algorithm is specified:
216
217               shell> ibd2sdi --strict-check=innodb ../data/test/t1.ibd
218
219           In this example, the strict version of crc32 checksum algorithm is
220           specified:
221
222               shell> ibd2sdi -c crc32 ../data/test/t1.ibd
223
224           If you do not specify the --strict-check option, validation is
225           performed against non-strict innodb, crc32 and none checksums.
226
227       ·   --no-check, -n
228
229           Skips checksum validation for pages that are read.
230
231               shell> ibd2sdi --no-check ../data/test/t1.ibd
232
233       ·   --pretty, -p
234
235           Outputs SDI data in JSON pretty print format. Enabled by default.
236           If disabled, SDI is not human readable but is smaller in size. Use
237           --skip-pretty to disable.
238
239               shell> ibd2sdi --skip-pretty ../data/test/t1.ibd
240
242       Copyright © 1997, 2020, Oracle and/or its affiliates. All rights
243       reserved.
244
245       This documentation is free software; you can redistribute it and/or
246       modify it only under the terms of the GNU General Public License as
247       published by the Free Software Foundation; version 2 of the License.
248
249       This documentation is distributed in the hope that it will be useful,
250       but WITHOUT ANY WARRANTY; without even the implied warranty of
251       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
252       General Public License for more details.
253
254       You should have received a copy of the GNU General Public License along
255       with the program; if not, write to the Free Software Foundation, Inc.,
256       51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see
257       http://www.gnu.org/licenses/.
258
259

SEE ALSO

261       For more information, please refer to the MySQL Reference Manual, which
262       may already be installed locally and which is also available online at
263       http://dev.mysql.com/doc/.
264

AUTHOR

266       Oracle Corporation (http://dev.mysql.com/).
267
268
269
270MySQL 8.0                         03/06/2020                        IBD2SDI(1)
Impressum