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 a 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> <arg choice="opt" rep="repeat">mysql option</arg>
  27     </cmdsynopsis>
  28   </refsynopsisdiv>
  29
  30   <refsect1><title>Description</title>
  31   <para>Provide a 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>Run interactive mysql shell for speicified Koha instance</term>
  38         <listitem>
  39           <para><command>koha-mysql</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg></para>
  40         </listitem>
  41       </varlistentry>
  42       <varlistentry>
  43         <term>Run a query given as an argument without launching mysql shell</term>
  44         <listitem>
  45           <para><command>koha-mysql</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg> -e "SOME SQL QUERY"</para>
  46         </listitem>
  47       </varlistentry>
  48       <varlistentry>
  49         <term>Run a query, skip column names on output</term>
  50         <listitem>
  51           <para><command>koha-mysql</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg> -e "SOME SQL QUERY" --skip-column-names</para>
  52         </listitem>
  53       </varlistentry>
  54       <varlistentry>
  55         <term>Load a database dump (e.g. one produced by mysqldump) into the database of the given instance</term>
  56         <listitem>
  57           <para><command>koha-mysql</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg> &lt; /path/to/mysqldump.sql</para>
  58         </listitem>
  59       </varlistentry>
  60     </variablelist>
  61   </refsect1>
  62
  63   <refsect1><title>See also</title>
  64   <simplelist type="inline">
  65     <member><command>mysql (1)</command></member>
  66     <member><command>koha-dump-defaults(8)</command></member>
  67     <member><command>koha-reset-passwd(8)</command></member>
  68     <member><command>koha-upgrade-schema(8)</command></member>
  69   </simplelist>
  70   </refsect1>
  71
  72 </refentry>
  73
  74 </article>