debian/docs/koha-mysql.xml

   1 <article xmlns='http://docbook.org/ns/docbook'>
   2 <title>koha-mysql</title>
   3 <info>
   4 <productname>Koha</productname> is the first free software library automation package.
   5 <author>
   6   <orgname>The Koha Community</orgname>
   7   <uri>http://koha-community.org/</uri>
   8 </author>
   9 </info>
  10
  11 <refentry xml:id="koha-mysql">
  12
  13   <refmeta>
  14     <refentrytitle>koha-mysql</refentrytitle>
  15     <manvolnum>8</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>koha-mysql</refname>
  20     <refpurpose>Provide an interactive mysql shell set up for the specified Koha instance.</refpurpose>
  21     <refclass>UNIX/Linux</refclass>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>koha-mysql</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg>
  27     </cmdsynopsis>
  28   </refsynopsisdiv>
  29
  30   <refsect1><title>Description</title>
  31   <para>Provide an interactive mysql shell set up for the specified Koha instance.</para>
  32   </refsect1>
  33
  34   <refsect1><title>Example usage</title>
  35     <variablelist>
  36       <varlistentry>
  37         <term>Send an SQL query to MySQL</term>
  38         <listitem>
  39           <para>"Some SQL query" | <command>koha-mysql</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg></para>
  40         </listitem>
  41       </varlistentry>
  42       <varlistentry>
  43         <term>Load a database dump (e.g. one produced by mysqldump) into the database of the given instance</term>
  44         <listitem>
  45           <para><command>koha-mysql</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg> &lt; /path/to/mysqldump.sql</para>
  46         </listitem>
  47       </varlistentry>
  48     </variablelist>
  49   </refsect1>
  50
  51   <refsect1><title>See also</title>
  52   <simplelist type="inline">
  53     <member><command>koha-dump-defaults(8)</command></member>
  54     <member><command>koha-reset-passwd(8)</command></member>
  55     <member><command>koha-upgrade-schema(8)</command></member>
  56   </simplelist>
  57   </refsect1>
  58
  59 </refentry>
  60
  61 </article>