Koha/debian/docs/koha-mysql.xml
Barton Chittenden 72372e3895 Bug 12372: Updated man pages for koha-mysql
http://bugs.koha-community.org/show_bug.cgi?id=12372
Signed-off-by: Liz Rea <liz@catalyst.net.nz>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
Signed-off-by: Tomas Cohen Arazi <tomascohen@unc.edu.ar>
2015-08-24 13:18:12 -03:00

74 lines
2.6 KiB
XML

<article xmlns='http://docbook.org/ns/docbook'>
<title>koha-mysql</title>
<info>
<productname>Koha</productname> is the first free software library automation package.
<author>
<orgname>The Koha Community</orgname>
<uri>http://koha-community.org/</uri>
</author>
</info>
<refentry xml:id="koha-mysql">
<refmeta>
<refentrytitle>koha-mysql</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>koha-mysql</refname>
<refpurpose>Provide a mysql shell set up for the specified Koha instance.</refpurpose>
<refclass>UNIX/Linux</refclass>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>koha-mysql</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg> <arg choice="opt" rep="repeat">mysql option</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Provide a mysql shell set up for the specified Koha instance.</para>
</refsect1>
<refsect1><title>Example usage</title>
<variablelist>
<varlistentry>
<term>Run interactive mysql shell for speicified Koha instance</term>
<listitem>
<para><command>koha-mysql</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg></para>
</listitem>
</varlistentry>
<varlistentry>
<term>Run a query given as an argument without launching mysql shell</term>
<listitem>
<para><command>koha-mysql</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg> -e "SOME SQL QUERY"</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Run a query, skip column names on output</term>
<listitem>
<para><command>koha-mysql</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg> -e "SOME SQL QUERY" --skip-column-names</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Load a database dump (e.g. one produced by mysqldump) into the database of the given instance</term>
<listitem>
<para><command>koha-mysql</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg> &lt; /path/to/mysqldump.sql</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1><title>See also</title>
<simplelist type="inline">
<member><command>mysql (1)</command></member>
<member><command>koha-dump-defaults(8)</command></member>
<member><command>koha-reset-passwd(8)</command></member>
<member><command>koha-upgrade-schema(8)</command></member>
</simplelist>
</refsect1>
</refentry>
</article>