source: server/databases/mariadb.xml@ 1ef4adb9

trunk
Last change on this file since 1ef4adb9 was bf257d4e, checked in by Douglas R. Reno <renodr@…>, 10 days ago

Adapt the systemd units to work with the recent MariaDB update.

  • Property mode set to 100644
File size: 41.5 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7
8 <!ENTITY mariadb-download-http "https://downloads.mariadb.org/interstitial/mariadb-&mariadb-version;/source/mariadb-&mariadb-version;.tar.gz">
9 <!ENTITY mariadb-download-ftp " ">
10 <!ENTITY mariadb-md5sum "c19f97dc1ea3165fb282a8384155dc0a">
11 <!ENTITY mariadb-size "103 MB">
12 <!ENTITY mariadb-buildsize "2.1 GB (741 MB installed)">
13 <!ENTITY mariadb-time "3.3 SBU (with parallelism=8, add 0.5 SBU for tests)">
14]>
15
16<sect1 id="mariadb" xreflabel="MariaDB-&mariadb-version;">
17 <?dbhtml filename="mariadb.html"?>
18
19
20 <title>MariaDB-&mariadb-version;</title>
21
22 <indexterm zone="mariadb">
23 <primary sortas="a-MariaDB">MariaDB</primary>
24 </indexterm>
25
26 <sect2 role="package">
27 <title>Introduction to MariaDB</title>
28
29 <para>
30 <application>MariaDB</application> is a community-developed fork and a
31 drop-in replacement for the <application>MySQL</application> relational
32 database management system.
33 </para>
34
35 &lfs122_checked;
36
37 <bridgehead renderas="sect3">Package Information</bridgehead>
38 <itemizedlist spacing="compact">
39 <listitem>
40 <para>
41 Download (HTTP): <ulink url="&mariadb-download-http;"/>
42 </para>
43 </listitem>
44 <listitem>
45 <para>
46 Download (FTP): <ulink url="&mariadb-download-ftp;"/>
47 </para>
48 </listitem>
49 <listitem>
50 <para>
51 Download MD5 sum: &mariadb-md5sum;
52 </para>
53 </listitem>
54 <listitem>
55 <para>
56 Download size: &mariadb-size;
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Estimated disk space required: &mariadb-buildsize;
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Estimated build time: &mariadb-time;
67 </para>
68 </listitem>
69 </itemizedlist>
70
71 <note>
72 <para>
73 The installed size of MariaDB is 741 MB, but this can be
74 reduced by about 263 MB, if desired, by removing the <filename
75 class="directory">/usr/share/mariadb/test</filename>
76 directory after installation.
77 </para>
78 </note>
79<!--
80 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
81 <itemizedlist spacing="compact">
82 <listitem>
83 <para>
84 Required patch to prevent a stack smashing error when using openssl-3:
85 <ulink url="&patch-root;/mariadb-&mariadb-version;-openssl3_fix-1.patch"/>
86 </para>
87 </listitem>
88 </itemizedlist>
89-->
90 <bridgehead renderas="sect3">MariaDB Dependencies</bridgehead>
91
92 <bridgehead renderas="sect4">Required</bridgehead>
93 <para role="required">
94 <xref linkend="cmake"/>
95 </para>
96
97 <bridgehead renderas="sect4">Recommended</bridgehead>
98 <para role="recommended">
99 <xref linkend="libevent"/>
100 </para>
101
102 <bridgehead renderas="sect4">Optional</bridgehead>
103 <para role="optional">
104 <xref linkend="boost"/>,
105 <xref linkend="libaio"/>,
106 <xref linkend="libxml2"/>,
107 <xref linkend="linux-pam"/>,
108 <xref linkend="lzo"/>,
109 <xref linkend="mitkrb"/>,
110 <xref linkend="pcre2"/>,
111 <xref linkend="ruby"/>,
112 <xref linkend="sphinx"/>,
113 <xref linkend="unixodbc"/>,
114 <xref linkend="valgrind"/>,
115 <ulink url="https://groonga.org/">Groonga</ulink>,
116 <ulink url="https://www.phontron.com/kytea/">KyTea</ulink>,
117 <ulink url="https://sourceforge.net/projects/judy/">Judy</ulink>,
118 <ulink url="https://taku910.github.io/mecab">MeCab</ulink>,
119 <ulink url="https://msgpack.org/">MessagePack</ulink>,
120 <ulink url="https://www.mruby.org/">mruby</ulink>,
121 <ulink url="https://mariadb.com/kb/en/myrocks/">MyRocks</ulink>,
122 <ulink url="https://github.com/google/snappy">Snappy</ulink>, and
123 <ulink url="https://zeromq.org/">ZeroMQ</ulink>
124 </para>
125
126 </sect2>
127
128 <sect2 role="installation">
129 <title>Installation of MariaDB</title>
130
131 <warning>
132 <para>
133 MariaDB and MySQL cannot be installed on the same system without
134 extensive changes to the build configuration of one of the two applications.
135 </para>
136 </warning>
137
138 <para>
139 For security reasons, running the server as an unprivileged user
140 and group is strongly encouraged. Issue the following (as
141 <systemitem class="username">root</systemitem>) to create the
142 user and group:
143 </para>
144
145<screen role="root"><userinput>groupadd -g 40 mariadb &amp;&amp;
146useradd -c "MariaDB Server" -d /srv/mariadb -g mariadb -s /bin/false -u 40 mariadb</userinput></screen>
147
148 <para>
149 Install <application>MariaDB</application> by running the
150 following commands:
151 </para>
152
153<screen><userinput>mkdir build &amp;&amp;
154cd build &amp;&amp;
155
156cmake -D CMAKE_BUILD_TYPE=Release \
157 -D CMAKE_INSTALL_PREFIX=/usr \
158 -D GRN_LOG_PATH=/var/log/groonga.log \
159 -D INSTALL_DOCDIR=share/doc/mariadb-&mariadb-version; \
160 -D INSTALL_DOCREADMEDIR=share/doc/mariadb-&mariadb-version; \
161 -D INSTALL_MANDIR=share/man \
162 -D INSTALL_MYSQLSHAREDIR=share/mariadb \
163 -D INSTALL_MYSQLTESTDIR=share/mariadb/test \
164 -D INSTALL_PAMDIR=lib/security \
165 -D INSTALL_PAMDATADIR=/etc/security \
166 -D INSTALL_PLUGINDIR=lib/mariadb/plugin \
167 -D INSTALL_SBINDIR=sbin \
168 -D INSTALL_SCRIPTDIR=bin \
169 -D INSTALL_SQLBENCHDIR=share/mariadb/bench \
170 -D INSTALL_SUPPORTFILESDIR=share/mariadb \
171 -D MYSQL_DATADIR=/srv/mariadb \
172 -D MYSQL_UNIX_ADDR=/run/mariadb/mariadb.sock \
173 -D WITH_EXTRA_CHARSETS=complex \
174 -D WITH_EMBEDDED_SERVER=ON \
175 -D SKIP_TESTS=ON \
176 -D TOKUDB_OK=0 \
177 .. &amp;&amp;
178make</userinput></screen>
179
180 <para>
181 To test the results, issue: <command>make test</command>.
182 Two tests, my_tzinfo and test-connect, are known to fail.
183 </para>
184
185 <note><para>
186 A more extensive set of tests can be run with the following:</para>
187
188<screen remap="test"><userinput>pushd mysql-test
189./mtr --parallel <replaceable>&lt;N&gt;</replaceable> --mem --force
190popd</userinput></screen>
191
192 <para>
193 Where N is the number of tests to run in parallel.
194 Over 5400 tests are run in about 24 SBU with N=4. A few tests
195 may fail, mainly due to character set issues.
196 </para></note>
197
198 <para>
199 Now, as the <systemitem class="username">root</systemitem> user:
200 </para>
201
202<screen role="root"><userinput>make install</userinput></screen>
203
204 <para>
205 If you have <xref linkend="linux-pam" role="nodep"/> installed, move the
206 PAM module and configuration file installed by this package as the
207 &root; user:
208 </para>
209
210<screen role="nodump"><userinput>mv -v /usr/share/pam_use_map.so /lib/security &amp;&amp;
211mv -v /usr/share/user_map.conf /etc/security</userinput></screen>
212
213 </sect2>
214
215 <sect2 role="commands">
216 <title>Command Explanations</title>
217
218 <para>
219 <parameter>-D WITH_EMBEDDED_SERVER=ON</parameter>: This switch enables
220 compiling the embedded server library needed by certain applications,
221 such as <application>Amarok</application>.
222 </para>
223
224 <para>
225 <parameter>-D WITH_EXTRA_CHARSETS=complex</parameter>: This switch enables
226 support for the complex character sets.
227 </para>
228
229 <para>
230 <parameter>-D SKIP_TESTS=ON</parameter>: This switch disables
231 tests for MariaDB Connector/C which are not supported without
232 additional setup.
233 </para>
234
235 <para>
236 <option>-D WITHOUT_SERVER=ON</option>: Use this
237 switch if you don't want the server and would like to build the client
238 only.
239 </para>
240
241 <note><para>
242 There are numerous options available to <command>cmake</command>. Check
243 the output of the <command>cmake . -LH</command> for additional
244 customization options.
245 </para></note>
246
247 </sect2>
248
249 <sect2 role="configuration">
250 <title>Configuring MySQL</title>
251
252 <sect3 id="mariadb-config">
253 <title>Config Files</title>
254
255 <para>
256 <filename>/etc/mariadb/my.cnf</filename> and
257 <filename>~/.my.cnf</filename>
258 </para>
259
260 <indexterm zone="mariadb mariadb-config">
261 <primary sortas="e-AA.my.cnf">~/.my.cnf</primary>
262 </indexterm>
263
264 <indexterm zone="mariadb mariadb-config">
265 <primary sortas="e-etc-mariadb-my.cnf">/etc/mariadb/my.cnf</primary>
266 </indexterm>
267
268 </sect3>
269
270 <sect3>
271 <title>Configuration Information</title>
272
273 <para>
274 Create a basic <filename>/etc/mariadb/my.cnf</filename>
275 file using the following command as the <systemitem
276 class="username">root</systemitem> user:
277 </para>
278
279<screen role="root"><userinput>install -v -dm 755 /etc/mariadb &amp;&amp;
280cat &gt; /etc/mariadb/my.cnf &lt;&lt; "EOF"
281<literal># Begin /etc/mariadb/my.cnf
282
283# The following options will be passed to all MySQL clients
284[client]
285#password = your_password
286port = 3306
287socket = /run/mariadb/mariadb.sock
288
289# The MySQL server
290[mariadb]
291port = 3306
292socket = /run/mariadb/mariadb.sock
293datadir = /srv/mariadb
294skip-external-locking
295key_buffer_size = 16M
296max_allowed_packet = 1M
297sort_buffer_size = 512K
298net_buffer_length = 16K
299myisam_sort_buffer_size = 8M
300
301# Don't listen on a TCP/IP port at all.
302skip-networking
303
304# required unique id between 1 and 2^32 - 1
305server-id = 1
306
307# Uncomment the following if you are using BDB tables
308#bdb_cache_size = 4M
309#bdb_max_lock = 10000
310
311# InnoDB tables are now used by default
312innodb_data_home_dir = /srv/mariadb
313innodb_log_group_home_dir = /srv/mariadb
314# All the innodb_xxx values below are the default ones:
315innodb_data_file_path = ibdata1:12M:autoextend
316# You can set .._buffer_pool_size up to 50 - 80 %
317# of RAM but beware of setting memory usage too high
318innodb_buffer_pool_size = 128M
319innodb_log_file_size = 48M
320innodb_log_buffer_size = 16M
321innodb_flush_log_at_trx_commit = 1
322innodb_lock_wait_timeout = 50
323
324[mariadbdump]
325quick
326max_allowed_packet = 16M
327
328[mariadb]
329no-auto-rehash
330# Remove the next comment character if you are not familiar with SQL
331#safe-updates
332
333[isamchk]
334key_buffer = 20M
335sort_buffer_size = 20M
336read_buffer = 2M
337write_buffer = 2M
338
339[myisamchk]
340key_buffer_size = 20M
341sort_buffer_size = 20M
342read_buffer = 2M
343write_buffer = 2M
344
345[mariadbhotcopy]
346interactive-timeout
347
348# End /etc/mariadb/my.cnf</literal>
349EOF</userinput></screen>
350
351 <para>
352 You can now install a database and change the ownership to the
353 unprivileged user and group (perform as the <systemitem
354 class="username">root</systemitem> user):
355 </para>
356
357<screen role="root"><userinput>mariadb-install-db --basedir=/usr --datadir=/srv/mariadb --user=mariadb &amp;&amp;
358chown -R mariadb:mariadb /srv/mariadb</userinput></screen>
359
360 <para>
361 Further configuration requires that the
362 <application>MariaDB</application> server is running. Start
363 the server using the following commands as the <systemitem
364 class="username">root</systemitem> user:
365 </para>
366
367<screen role="root"><userinput>install -v -m755 -o mariadb -g mariadb -d /run/mariadb &amp;&amp;
368mariadbd-safe --user=mariadb 2&gt;&amp;1 &gt;/dev/null &amp;</userinput></screen>
369
370 <para>
371 A default installation does not set up a password for the
372 administrator, so use the following command as the <systemitem
373 class="username">root</systemitem> user to set one.
374 </para>
375
376<screen role="root"><userinput>mariadb-admin -u root password</userinput></screen>
377
378 <para>
379 Configuration of the server is now finished. Shut the server
380 down using the following command as the <systemitem
381 class="username">root</systemitem> user:
382 </para>
383
384<screen role="root"><userinput>mariadb-admin -p shutdown</userinput></screen>
385
386 </sect3>
387
388 <sect3 id="mariadb-init">
389 <title><phrase revision="sysv">Boot Script</phrase>
390 <phrase revision="systemd">Systemd Unit</phrase></title>
391
392 <para>
393 Install the
394 <phrase revision="sysv"><filename>/etc/rc.d/init.d/mariadb</filename> init
395 script</phrase>
396 <phrase revision="systemd"><filename>mariadb.service</filename>
397 unit</phrase> included in the
398 <xref linkend="bootscripts" revision="sysv"/>
399 <xref linkend="systemd-units" revision="systemd"/> package as
400 the <systemitem class="username">root</systemitem> user to start the
401 <application>MariaDB</application> server during system boot-up.
402 </para>
403
404 <indexterm zone="mariadb mariadb-init">
405 <primary sortas="f-mariadb">mariadb</primary>
406 </indexterm>
407
408<screen role="root" revision="sysv"><userinput>make install-mariadb</userinput></screen>
409
410<screen role="root" revision="systemd"><userinput>make install-mariadb</userinput></screen>
411
412 <note>
413 <para>
414 If you have an existing database already and this
415 installation of binaries was just an upgrade to a newer
416 version, check the upstream documentation for upgrading. It
417 is recommended to run:
418 <screen role="nodump"><userinput>mariadb-upgrade</userinput></screen>
419 </para>
420 </note>
421 </sect3>
422
423 </sect2>
424
425 <sect2 role="content">
426 <title>Contents</title>
427
428 <segmentedlist>
429 <segtitle>Installed Programs</segtitle>
430 <segtitle>Installed Libraries</segtitle>
431 <segtitle>Installed Directories</segtitle>
432
433 <seglistitem>
434 <seg>
435 aria_chk, aria_dump_log, aria_ftdump, aria_pack, aria_read_log,
436 aria_s3_copy, galera_new_cluster, galera_recovery,
437 innochecksum, mariabackup, mariadb, mariadbd, mariadb-access,
438 mariadb-admin, mariadb-backup, mariadb-binlog, mariadb-check,
439 mariadb-client-test, mariadb-client-test-embedded, mariadb-conv,
440 mariadb-convert-table-format, mariadb-find-rows, mariadbd-multi,
441 mariadbd-safe, mariadbd-safe-helper, mariadb-dump, mariadb-dumpslow,
442 mariadb-embedded, mariadb-fix-extensions, mariadb-hotcopy,
443 mariadb-import, mariadb-install-db, mariadb-ldb, mariadb-plugin,
444 mariadb-secure-installation, mariadb-setpermission,
445 mariadb-service-convert, mariadb-show,
446 mariadb-slap, mariadb-test, mariadb-test-embedded,
447 mariadb-tzinfo-to-sql, mariadb-upgrade, mariadb-waitpid,
448 mariadb_config,
449 mbstream, msql2mysql, my_print_defaults, myisamchk,
450 myisam_ftdump, myisamlog, myisampack, mysql_config, mytop, perror,
451 replace, resolve_stack_dump, resolveip, sst_dump, wsrep_sst_common,
452 wsrep_sst_mariabackup, wsrep_sst_mysqldump, and wsrep_sst_rsync
453 </seg>
454 <seg>
455 libmariadb.a (symlink to libmariadbclient.a),
456 libmariadb.so (symlink to libmariadb.so.3),
457 libmariadbclient.a,
458 libmariadbd.a,
459 libmariadbd.so (symlink to libmariadbd.so.19),
460 libmariadbd.so.19,
461 libmariadb.so.3,
462 libmysqlclient.a (symlink to libmariadbclient.a),
463 libmysqlclient.so (symlink to libmariadb.so.3),
464 libmysqlclient_r.a (symlink to libmariadbclient.a),
465 libmysqlclient_r.so (symlink to libmariadbclient.a),
466 libmysqld.a (symlink to libmariadbd.a),
467 libmysqld.so (symlink to libmariadbd.so.19),
468 libmysqlservices.a, and
469 about 70 modules under /usr/lib/mysql/plugin/
470 </seg>
471 <seg>
472 /usr/{include,lib,share}/mysql,
473 /usr/share/groonga{,-normalizer-mysql}, and
474 /usr/share/doc/mariadb-&mariadb-version;
475 </seg>
476 </seglistitem>
477 </segmentedlist>
478
479 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
480
481 <para>
482 There are several symlinks from mysql* to their mariadb
483 counterparts. These are maintained for compatibility.
484 </para>
485
486<!--
487 <para>
488 Descriptions of all the programs and libraries would be several
489 pages long. Instead, consult the man pages
490 or the online documentation at <ulink
491 url="https://mariadb.com/kb/en/mariadb-documentation/"/>.
492 </para>
493-->
494 <para>
495 The <application>Perl</application> DBI modules must be installed
496 for some of the <application>MariaDB</application> support programs to
497 function properly.
498 </para>
499
500 <variablelist>
501 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
502 <?dbfo list-presentation="list"?>
503 <?dbhtml list-presentation="table"?>
504
505 <varlistentry id="aria_chk-mariadb">
506 <term><command>aria_chk</command></term>
507 <listitem>
508 <para>
509 is used to check, repair, optimize, sort and get information
510 about Aria tables
511 </para>
512 <indexterm zone="mariadb aria_chk-mariadb">
513 <primary sortas="b-aria_chk-mariadb">aria_chk</primary>
514 </indexterm>
515 </listitem>
516 </varlistentry>
517
518 <varlistentry id="aria_dump_log-mariadb">
519 <term><command>aria_dump_log</command></term>
520 <listitem>
521 <para>
522 is a tool to dump the contents of Aria log pages
523 </para>
524 <indexterm zone="mariadb aria_dump_log-mariadb">
525 <primary sortas="b-aria_dump_log-mariadb">aria_dump_log</primary>
526 </indexterm>
527 </listitem>
528 </varlistentry>
529
530 <varlistentry id="aria_ftdump-mariadb">
531 <term><command>aria_ftdump</command></term>
532 <listitem>
533 <para>
534 displays full-text index information
535 </para>
536 <indexterm zone="mariadb aria_ftdump-mariadb">
537 <primary sortas="b-aria_ftdump-mariadb">aria_ftdump</primary>
538 </indexterm>
539 </listitem>
540 </varlistentry>
541
542 <varlistentry id="aria_pack-mariadb">
543 <term><command>aria_pack</command></term>
544 <listitem>
545 <para>
546 is a tool to generate compressed, read-only Aria tables
547 </para>
548 <indexterm zone="mariadb aria_pack-mariadb">
549 <primary sortas="b-aria_pack-mariadb">aria_pack</primary>
550 </indexterm>
551 </listitem>
552 </varlistentry>
553
554 <varlistentry id="aria_read_log-mariadb">
555 <term><command>aria_read_log</command></term>
556 <listitem>
557 <para>
558 displays Aria log file contents
559 </para>
560 <indexterm zone="mariadb aria_read_log-mariadb">
561 <primary sortas="b-aria_read_log-mariadb">aria_read_log</primary>
562 </indexterm>
563 </listitem>
564 </varlistentry>
565
566 <varlistentry id="aria_s3_copy-mariadb">
567 <term><command>aria_s3_copy</command></term>
568 <listitem>
569 <para>
570 copies an aria table to and from AWS S3
571 </para>
572 <indexterm zone="mariadb aria_s3_copy-mariadb">
573 <primary sortas="b-aria_s3_copy-mariadb">aria_s3_copy</primary>
574 </indexterm>
575 </listitem>
576 </varlistentry>
577
578 <varlistentry id="galera_new_cluster-mariadb">
579 <term><command>galera_new_cluster</command></term>
580 <listitem>
581 <para>
582 bootstraps a new Galera cluster
583 </para>
584 <indexterm zone="mariadb galera_new_cluster-mariadb">
585 <primary sortas="b-galera_new_cluster-mariadb">galera_new_cluster</primary>
586 </indexterm>
587 </listitem>
588 </varlistentry>
589
590 <varlistentry id="galera_recovery-mariadb">
591 <term><command>galera_recovery</command></term>
592 <listitem>
593 <para>
594 recovers data from a Galera cluster
595 </para>
596 <indexterm zone="mariadb galera_recovery-mariadb">
597 <primary sortas="b-galera_recovery-mariadb">galera_recovery</primary>
598 </indexterm>
599 </listitem>
600 </varlistentry>
601
602 <varlistentry id="innochecksum-mariadb">
603 <term><command>innochecksum</command></term>
604 <listitem>
605 <para>
606 prints checksums for InnoDB files
607 </para>
608 <indexterm zone="mariadb innochecksum-mariadb">
609 <primary sortas="b-innochecksum-mariadb">innochecksum</primary>
610 </indexterm>
611 </listitem>
612 </varlistentry>
613
614 <varlistentry id="mariabackup-mariadb">
615 <term><command>mariabackup</command></term>
616 <listitem>
617 <para>
618 is an open source backup tool for InnoDB and XtraDB
619 </para>
620 <indexterm zone="mariadb mariabackup-mariadb">
621 <primary sortas="b-mariabackup-mariadb">mariabackup</primary>
622 </indexterm>
623 </listitem>
624 </varlistentry>
625
626 <varlistentry id="mariadb-mariadb">
627 <term><command>mariadb</command></term>
628 <listitem>
629 <para>
630 is a simple SQL shell with input line editing capabilities
631 </para>
632 <indexterm zone="mariadb mariadb-mariadb">
633 <primary sortas="b-mariadb-mariadb">mariadb</primary>
634 </indexterm>
635 </listitem>
636 </varlistentry>
637
638 <varlistentry id="mariadbd-mariadb">
639 <term><command>mariadbd</command></term>
640 <listitem>
641 <para>
642 is the MySQL server daemon
643 </para>
644 <indexterm zone="mariadb mariadbd-mariadb">
645 <primary sortas="b-mariadbd-mariadb">mariadbd</primary>
646 </indexterm>
647 </listitem>
648 </varlistentry>
649
650 <varlistentry id="mariadb-access-mariadb">
651 <term><command>mariadb-access</command></term>
652 <listitem>
653 <para>
654 checks the access privileges for a host name, user name, and
655 database combination
656 </para>
657 <indexterm zone="mariadb mariadb-access-mariadb">
658 <primary sortas="b-mariadb-access-mariadb">mariadb-access</primary>
659 </indexterm>
660 </listitem>
661 </varlistentry>
662
663 <varlistentry id="mariadb-admin-mariadb">
664 <term><command>mariadb-admin</command></term>
665 <listitem>
666 <para>
667 is a client for performing administrative operations
668 </para>
669 <indexterm zone="mariadb mariadb-admin-mariadb">
670 <primary sortas="b-mariadb-admin-mariadb">mariadb-admin</primary>
671 </indexterm>
672 </listitem>
673 </varlistentry>
674
675 <varlistentry id="mariadb-binlog-mariadb">
676 <term><command>mariadb-binlog</command></term>
677 <listitem>
678 <para>
679 reads binary log files
680 </para>
681 <indexterm zone="mariadb mariadb-binlog-mariadb">
682 <primary sortas="b-mariadb-binlog-mariadb">mariadb-binlog</primary>
683 </indexterm>
684 </listitem>
685 </varlistentry>
686
687 <varlistentry id="mariadb-check-mariadb">
688 <term><command>mariadb-check</command></term>
689 <listitem>
690 <para>
691 performs table maintenance: It checks, repairs, optimizes,
692 or analyzes tables
693 </para>
694 <indexterm zone="mariadb mariadb-check-mariadb">
695 <primary sortas="b-mariadb-check-mariadb">mariadb-check</primary>
696 </indexterm>
697 </listitem>
698 </varlistentry>
699
700 <varlistentry id="mariadb-client-test-mariadb">
701 <term><command>mariadb-client-test</command></term>
702 <listitem>
703 <para>
704 is used for testing aspects of the MySQL client API that cannot be
705 tested using mariadb-test and its test language
706 </para>
707 <indexterm zone="mariadb mariadb-client-test-mariadb">
708 <primary sortas="b-mariadb-client-test-mariadb">mariadb-client-test</primary>
709 </indexterm>
710 </listitem>
711 </varlistentry>
712
713 <varlistentry id="mariadb-client-test-embedded-mariadb">
714 <term><command>mariadb-client-test-embedded</command></term>
715 <listitem>
716 <para>
717 is a tool to test the client API for the embedded server
718 </para>
719 <indexterm zone="mariadb mariadb-client-test-embedded-mariadb">
720 <primary sortas="b-mariadb-client-test-embedded-mariadb">mariadb-client-test-embedded</primary>
721 </indexterm>
722 </listitem>
723 </varlistentry>
724
725 <varlistentry id="mariadb-conv-mariadb">
726 <term><command>mariadb-conv</command></term>
727 <listitem>
728 <para>
729 converts character sets for use with MariaDB
730 </para>
731 <indexterm zone="mariadb mariadb-conv-mariadb">
732 <primary sortas="b-mariadb-conv-mariadb">mariadb-conv</primary>
733 </indexterm>
734 </listitem>
735 </varlistentry>
736
737 <varlistentry id="mariadb-convert-table-format-mariadb">
738 <term><command>mariadb-convert-table-format</command></term>
739 <listitem>
740 <para>
741 converts the tables in a database to use a particular storage
742 engine
743 </para>
744 <indexterm zone="mariadb mariadb-convert-table-format-mariadb">
745 <primary sortas="b-mariadb-convert-table-format-mariadb">mariadb-convert-table-format</primary>
746 </indexterm>
747 </listitem>
748 </varlistentry>
749
750 <varlistentry id="mariadbd-multi-mariadb">
751 <term><command>mariadbd-multi</command></term>
752 <listitem>
753 <para>
754 is designed to manage several mariadb processes that listen for
755 connections on different Unix socket files and TCP/IP ports
756 </para>
757 <indexterm zone="mariadb mariadbd-multi-mariadb">
758 <primary sortas="b-mariadbd-multi-mariadb">mariadbd-multi</primary>
759 </indexterm>
760 </listitem>
761 </varlistentry>
762
763 <varlistentry id="mariadbd-safe-mariadb">
764 <term><command>mariadbd-safe</command></term>
765 <listitem>
766 <para>
767 is the recommended way to start a mariadb server on Unix
768 and NetWare
769 </para>
770 <indexterm zone="mariadb mariadbd-safe-mariadb">
771 <primary sortas="b-mariadbd-safe-mariadb">mariadbd-safe</primary>
772 </indexterm>
773 </listitem>
774 </varlistentry>
775
776 <varlistentry id="mariadb-dump-mariadb">
777 <term><command>mariadb-dump</command></term>
778 <listitem>
779 <para>
780 is a backup program
781 </para>
782 <indexterm zone="mariadb mariadb-dump-mariadb">
783 <primary sortas="b-mariadb-dump-mariadb">mariadb-dump</primary>
784 </indexterm>
785 </listitem>
786 </varlistentry>
787
788 <varlistentry id="mariadb-dumpslow-mariadb">
789 <term><command>mariadb-dumpslow</command></term>
790 <listitem>
791 <para>
792 parses MySQL slow query log files and prints a summary of their
793 contents
794 </para>
795 <indexterm zone="mariadb mariadb-dumpslow-mariadb">
796 <primary sortas="b-mariadb-dumpslow-mariadb">mariadb-dumpslow</primary>
797 </indexterm>
798 </listitem>
799 </varlistentry>
800
801 <varlistentry id="mariadb-embedded-mariadb">
802 <term><command>mariadb-embedded</command></term>
803 <listitem>
804 <para>
805 is a MySQL client statically linked to
806 libmariadbd
807 </para>
808 <indexterm zone="mariadb mariadb-embedded-mariadb">
809 <primary sortas="b-mariadbd-embedded-mariadb">mariadbd-embedded</primary>
810 </indexterm>
811 </listitem>
812 </varlistentry>
813
814 <varlistentry id="mariadb-find-rows-mariadb">
815 <term><command>mariadb-find-rows</command></term>
816 <listitem>
817 <para>
818 reads files containing SQL statements and extracts statements that
819 match a given regular expression or that contain USE db_name or
820 SET statements
821 </para>
822 <indexterm zone="mariadb mariadb-find-rows-mariadb">
823 <primary sortas="b-mariadb-find-rows-mariadb">mariadb-find-rows</primary>
824 </indexterm>
825 </listitem>
826 </varlistentry>
827
828 <varlistentry id="mariadb-fix-extensions-mariadb">
829 <term><command>mariadb-fix-extensions</command></term>
830 <listitem>
831 <para>
832 converts the extensions for MyISAM (or ISAM) table files to
833 their canonical forms
834 </para>
835 <indexterm zone="mariadb mariadb-fix-extensions-mariadb">
836 <primary sortas="b-mariadb-fix-extensions-mariadb">mariadb-fix-extensions</primary>
837 </indexterm>
838 </listitem>
839 </varlistentry>
840
841 <varlistentry id="mariadb-hotcopy-mariadb">
842 <term><command>mariadb-hotcopy</command></term>
843 <listitem>
844 <para>
845 locks the table, flushes the table and then performs a copy of
846 the database
847 </para>
848 <indexterm zone="mariadb mariadb-hotcopy-mariadb">
849 <primary sortas="b-mariadb-hotcopy-mariadb">mariadb-hotcopy</primary>
850 </indexterm>
851 </listitem>
852 </varlistentry>
853
854 <varlistentry id="mariadb-import-mariadb">
855 <term><command>mariadb-import</command></term>
856 <listitem>
857 <para>
858 reads a range of data formats, and inserts the data into a
859 database
860 </para>
861 <indexterm zone="mariadb mariadb-import-mariadb">
862 <primary sortas="b-mariadb-import-mariadb">mariadb-import</primary>
863 </indexterm>
864 </listitem>
865 </varlistentry>
866
867 <varlistentry id="mariadb-install-db-mariadb">
868 <term><command>mariadb-install-db</command></term>
869 <listitem>
870 <para>
871 initializes the MySQL data directory and creates the system
872 tables that it contains, if they do not exist
873 </para>
874 <indexterm zone="mariadb mariadb-install-db-mariadb">
875 <primary sortas="b-mariadb-install-db-mariadb">mariadb-install-db</primary>
876 </indexterm>
877 </listitem>
878 </varlistentry>
879
880 <varlistentry id="mariadb-ldb-mariadb">
881 <term><command>mariadb-ldb</command></term>
882 <listitem>
883 <para>
884 is the RocksDB tool
885 </para>
886 <indexterm zone="mariadb mariadb-ldb-mariadb">
887 <primary sortas="b-mariadb-ldb-mariadb">mariadb-ldb</primary>
888 </indexterm>
889 </listitem>
890 </varlistentry>
891
892 <varlistentry id="mariadb-plugin-mariadb">
893 <term><command>mariadb-plugin</command></term>
894 <listitem>
895 <para>
896 is a utility that enables MySQL administrators to manage which
897 plugins a MySQL server loads
898 </para>
899 <indexterm zone="mariadb mariadb-plugin-mariadb">
900 <primary sortas="b-mariadb-plugin-mariadb">mariadb-plugin</primary>
901 </indexterm>
902 </listitem>
903 </varlistentry>
904
905 <varlistentry id="mariadb-secure-installation-mariadb">
906 <term><command>mariadb-secure-installation</command></term>
907 <listitem>
908 <para>
909 is a tool to improve MySQL installation security
910 </para>
911 <indexterm zone="mariadb mariadb-secure-installation-mariadb">
912 <primary sortas="b-mariadb-secure-installation-mariadb">mariadb-secure-installation</primary>
913 </indexterm>
914 </listitem>
915 </varlistentry>
916
917 <varlistentry id="mariadb-service-convert-mariadb">
918 <term><command>mariadb-service-convert</command></term>
919 <listitem>
920 <para>
921 generates a systemd unit based on the current mariadb settings
922 </para>
923 <indexterm zone="mariadb mariadb-service-convert-mariadb">
924 <primary sortas="b-mariadb-service-convert-mariadb">mariadb-service-convert</primary>
925 </indexterm>
926 </listitem>
927 </varlistentry>
928
929 <varlistentry id="mariadb-setpermission-mariadb">
930 <term><command>mariadb-setpermission</command></term>
931 <listitem>
932 <para>
933 sets permissions in the MySQL grant tables
934 </para>
935 <indexterm zone="mariadb mariadb-setpermission-mariadb">
936 <primary sortas="b-mariadb-setpermission-mariadb">mariadb-setpermission</primary>
937 </indexterm>
938 </listitem>
939 </varlistentry>
940
941 <varlistentry id="mariadb-show-mariadb">
942 <term><command>mariadb-show</command></term>
943 <listitem>
944 <para>
945 shows the structure of a MariaDB database
946 </para>
947 <indexterm zone="mariadb mariadb-show-mariadb">
948 <primary sortas="b-mariadb-show-mariadb">mariadb-show</primary>
949 </indexterm>
950 </listitem>
951 </varlistentry>
952
953 <varlistentry id="mariadb-slap-mariadb">
954 <term><command>mariadb-slap</command></term>
955 <listitem>
956 <para>
957 is a diagnostic program designed to emulate client load for a
958 MySQL server and to report the timing of each stage
959 </para>
960 <indexterm zone="mariadb mariadb-slap-mariadb">
961 <primary sortas="b-mariadb-slap-mariadb">mariadb-slap</primary>
962 </indexterm>
963 </listitem>
964 </varlistentry>
965
966 <varlistentry id="mariadb-test-mariadb">
967 <term><command>mariadb-test</command></term>
968 <listitem>
969 <para>
970 runs a test case against a MySQL server and optionally compares
971 the output with a result file
972 </para>
973 <indexterm zone="mariadb mariadb-test-mariadb">
974 <primary sortas="b-mariadb-test-mariadb">mariadb-test</primary>
975 </indexterm>
976 </listitem>
977 </varlistentry>
978
979 <varlistentry id="mariadb-test-embedded-mariadb">
980 <term><command>mariadb-test-embedded</command></term>
981 <listitem>
982 <para>
983 is similar to the <command>mariadb-test</command> command but is built
984 with support for the libmariadbd embedded server
985 </para>
986 <indexterm zone="mariadb mariadb-test-embedded-mariadb">
987 <primary sortas="b-mariadb-test-embedded-mariadb">mariadb-test-embedded</primary>
988 </indexterm>
989 </listitem>
990 </varlistentry>
991
992 <varlistentry id="mariadb-tzinfo-to-sql-mariadb">
993 <term><command>mariadb-tzinfo-to-sql</command></term>
994 <listitem>
995 <para>
996 loads the time zone tables in the mariadb database
997 </para>
998 <indexterm zone="mariadb mariadb-tzinfo-to-sql-mariadb">
999 <primary sortas="b-mariadb-tzinfo-to-sql-mariadb">mariadb-tzinfo-to-sql</primary>
1000 </indexterm>
1001 </listitem>
1002 </varlistentry>
1003
1004 <varlistentry id="mariadb-upgrade-mariadb">
1005 <term><command>mariadb-upgrade</command></term>
1006 <listitem>
1007 <para>
1008 examines all tables in all databases for incompatibilities with
1009 the current version of MySQL Server
1010 </para>
1011 <indexterm zone="mariadb mariadb-upgrade-mariadb">
1012 <primary sortas="b-mariadb-upgrade-mariadb">mariadb-upgrade</primary>
1013 </indexterm>
1014 </listitem>
1015 </varlistentry>
1016
1017 <varlistentry id="mariadb-waitpid-mariadb">
1018 <term><command>mariadb-waitpid</command></term>
1019 <listitem>
1020 <para>
1021 signals a process to terminate and waits for the process to exit
1022 </para>
1023 <indexterm zone="mariadb mariadb-waitpid-mariadb">
1024 <primary sortas="b-mariadb-waitpid-mariadb">mariadb-waitpid</primary>
1025 </indexterm>
1026 </listitem>
1027 </varlistentry>
1028
1029 <varlistentry id="mariadb_config-mariadb">
1030 <term><command>mariadb_config</command></term>
1031 <listitem>
1032 <para>
1033 gets compiler flags for using the MariaDB Connector/C
1034 </para>
1035 <indexterm zone="mariadb mariadb_config-mariadb">
1036 <primary sortas="b-mariadb_config-mariadb">mariadb_config</primary>
1037 </indexterm>
1038 </listitem>
1039 </varlistentry>
1040
1041 <varlistentry id="mbstream-mariadb">
1042 <term><command>mbstream</command></term>
1043 <listitem>
1044 <para>
1045 is an utility for sending InnoDB and XTraDB backups over a stream
1046 </para>
1047 <indexterm zone="mariadb mbstream-mariadb">
1048 <primary sortas="b-mbstream-mariadb">mbstream</primary>
1049 </indexterm>
1050 </listitem>
1051 </varlistentry>
1052
1053 <varlistentry id="msql2mysql-mariadb">
1054 <term><command>msql2mysql</command></term>
1055 <listitem>
1056 <para>
1057 is a tool to convert mSQL programs for use with MySQL
1058 </para>
1059 <indexterm zone="mariadb msql2mysql-mariadb">
1060 <primary sortas="b-msql2mysql-mariadb">msql2mysql</primary>
1061 </indexterm>
1062 </listitem>
1063 </varlistentry>
1064
1065 <varlistentry id="my_print_defaults-mariadb">
1066 <term><command>my_print_defaults</command></term>
1067 <listitem>
1068 <para>
1069 displays the options from option groups of option files
1070 </para>
1071 <indexterm zone="mariadb my_print_defaults-mariadb">
1072 <primary sortas="b-my_print_defaults-mariadb">my_print_defaults</primary>
1073 </indexterm>
1074 </listitem>
1075 </varlistentry>
1076
1077 <varlistentry id="myisam_ftdump-mariadb">
1078 <term><command>myisam_ftdump</command></term>
1079 <listitem>
1080 <para>
1081 displays information about FULLTEXT indexes in MyISAM tables
1082 </para>
1083 <indexterm zone="mariadb myisam_ftdump-mariadb">
1084 <primary sortas="b-myisam_ftdump-mariadb">myisam_ftdump</primary>
1085 </indexterm>
1086 </listitem>
1087 </varlistentry>
1088
1089 <varlistentry id="myisamchk-mariadb">
1090 <term><command>myisamchk</command></term>
1091 <listitem>
1092 <para>
1093 gets information about your database tables or checks, repairs,
1094 or optimizes them
1095 </para>
1096 <indexterm zone="mariadb myisamchk-mariadb">
1097 <primary sortas="b-myisamchk-mariadb">myisamchk</primary>
1098 </indexterm>
1099 </listitem>
1100 </varlistentry>
1101
1102 <varlistentry id="myisamlog-mariadb">
1103 <term><command>myisamlog</command></term>
1104 <listitem>
1105 <para>
1106 displays MyISAM log file contents
1107 </para>
1108 <indexterm zone="mariadb myisamlog-mariadb">
1109 <primary sortas="b-myisamlog-mariadb">myisamlog</primary>
1110 </indexterm>
1111 </listitem>
1112 </varlistentry>
1113
1114 <varlistentry id="myisampack-mariadb">
1115 <term><command>myisampack</command></term>
1116 <listitem>
1117 <para>
1118 is a tool for compressing MyISAM tables
1119 </para>
1120 <indexterm zone="mariadb myisampack-mariadb">
1121 <primary sortas="b-myisampack-mariadb">myisampack</primary>
1122 </indexterm>
1123 </listitem>
1124 </varlistentry>
1125
1126 <varlistentry id="mysql_config-mariadb">
1127 <term><command>mysql_config</command></term>
1128 <listitem>
1129 <para>
1130 provides you with useful information for compiling your MySQL
1131 client and connecting it to MySQL
1132 </para>
1133 <indexterm zone="mariadb mysql_config-mariadb">
1134 <primary sortas="b-mysql_config-mariadb">mysql_config</primary>
1135 </indexterm>
1136 </listitem>
1137 </varlistentry>
1138
1139 <varlistentry id="mytop-mariadb">
1140 <term><command>mytop</command></term>
1141 <listitem>
1142 <para>
1143 is a console-based tool for monitoring the threads and overall
1144 performance of a MySQL server
1145 </para>
1146 <indexterm zone="mariadb mytop-mariadb">
1147 <primary sortas="b-mytop-mariadb">mytop</primary>
1148 </indexterm>
1149 </listitem>
1150 </varlistentry>
1151
1152 <varlistentry id="perror-mariadb">
1153 <term><command>perror</command></term>
1154 <listitem>
1155 <para>
1156 is a utility that displays descriptions for system or storage
1157 engine error codes
1158 </para>
1159 <indexterm zone="mariadb perror-mariadb">
1160 <primary sortas="b-perror-mariadb">perror</primary>
1161 </indexterm>
1162 </listitem>
1163 </varlistentry>
1164
1165 <varlistentry id="replace-mariadb">
1166 <term><command>replace</command></term>
1167 <listitem>
1168 <para>
1169 is a MariaDB/MySQL extension to the SQL standard
1170 </para>
1171 <indexterm zone="mariadb replace-mariadb">
1172 <primary sortas="b-replace-mariadb">replace</primary>
1173 </indexterm>
1174 </listitem>
1175 </varlistentry>
1176
1177 <varlistentry id="resolve_stack_dump-mariadb">
1178 <term><command>resolve_stack_dump</command></term>
1179 <listitem>
1180 <para>
1181 resolves a numeric stack dump to symbols
1182 </para>
1183 <indexterm zone="mariadb resolve_stack_dump-mariadb">
1184 <primary sortas="b-resolve_stack_dump-mariadb">resolve_stack_dump</primary>
1185 </indexterm>
1186 </listitem>
1187 </varlistentry>
1188
1189 <varlistentry id="resolveip-mariadb">
1190 <term><command>resolveip</command></term>
1191 <listitem>
1192 <para>
1193 is a utility for resolving IP addresses to host names and
1194 vice versa
1195 </para>
1196 <indexterm zone="mariadb resolveip-mariadb">
1197 <primary sortas="b-resolveip-mariadb">resolveip</primary>
1198 </indexterm>
1199 </listitem>
1200 </varlistentry>
1201
1202 <varlistentry id="sst_sump-mariadb">
1203 <term><command>sst_sump</command></term>
1204 <listitem>
1205 <para>
1206 dumps the content of sst files (the format used by RocksDB)
1207 </para>
1208 <indexterm zone="mariadb sst_sump-mariadb">
1209 <primary sortas="b-sst_sump-mariadb">sst_sump</primary>
1210 </indexterm>
1211 </listitem>
1212 </varlistentry>
1213
1214 </variablelist>
1215
1216 </sect2>
1217
1218</sect1>
Note: See TracBrowser for help on using the repository browser.