<info>
<productname>Koha</productname> is the first free software library automation package.
<author>
- <orgname>The Koha Communnity</orgname>
+ <orgname>The Koha Community</orgname>
<uri>http://koha-community.org/</uri>
</author>
</info>
<refnamediv>
<refname>koha-mysql</refname>
- <refpurpose>Provide an interactive mysql shell set up for the specified koha instance.</refpurpose>
+ <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>
+ <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 an interactive mysql shell set up for the specified koha instance.</para>
+ <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> < /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>