deploy: 00b266e

techouse · Jun 28, 2024 · c676556 · c676556
commit c676556
Show file tree

Hide file tree

Showing 39 changed files with 6,937 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: dc0dd1a56861401d0e4dd5e50a1e6483
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/README.doctree b/.doctrees/README.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/modules.doctree b/.doctrees/modules.doctree
diff --git a/.doctrees/mysql_to_sqlite3.doctree b/.doctrees/mysql_to_sqlite3.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/README.html b/README.html
@@ -0,0 +1,210 @@
+<!DOCTYPE html>
+
+<html lang="en" data-content_root="./">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>Usage &#8212; mysql-to-sqlite3 2.2.1 documentation</title>
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
+    <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=12dfc556" />
+    <script src="_static/documentation_options.js?v=16656018"></script>
+    <script src="_static/doctools.js?v=9a2dae69"></script>
+    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="mysql_to_sqlite3" href="modules.html" />
+    <link rel="prev" title="MySQL to SQLite3" href="index.html" />
+
+  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
+
+
+
+
+
+  </head><body>
+
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+
+
+          <div class="body" role="main">
+
+  <section id="usage">
+<h1>Usage<a class="headerlink" href="#usage" title="Link to this heading">¶</a></h1>
+<section id="options">
+<h2>Options<a class="headerlink" href="#options" title="Link to this heading">¶</a></h2>
+<p>The command line options for the <code class="docutils literal notranslate"><span class="pre">mysql2sqlite</span></code> tool are as follows:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>mysql2sqlite<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
+</pre></div>
+</div>
+<section id="required-options">
+<h3>Required Options<a class="headerlink" href="#required-options" title="Link to this heading">¶</a></h3>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">-f,</span> <span class="pre">--sqlite-file</span> <span class="pre">PATH</span></code>: SQLite3 database file. This option is required.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">-d,</span> <span class="pre">--mysql-database</span> <span class="pre">TEXT</span></code>: MySQL database name. This option is required.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">-u,</span> <span class="pre">--mysql-user</span> <span class="pre">TEXT</span></code>: MySQL user. This option is required.</p></li>
+</ul>
+</section>
+<section id="password-options">
+<h3>Password Options<a class="headerlink" href="#password-options" title="Link to this heading">¶</a></h3>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">-p,</span> <span class="pre">--prompt-mysql-password</span></code>: Prompt for MySQL password.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">--mysql-password</span> <span class="pre">TEXT</span></code>: MySQL password.</p></li>
+</ul>
+</section>
+<section id="table-options">
+<h3>Table Options<a class="headerlink" href="#table-options" title="Link to this heading">¶</a></h3>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">-t,</span> <span class="pre">--mysql-tables</span> <span class="pre">TUPLE</span></code>: Transfer only these specific tables (space separated table names). Implies –without-foreign-keys which inhibits the transfer of foreign keys. Can not be used together with –exclude-mysql-tables.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">-e,</span> <span class="pre">--exclude-mysql-tables</span> <span class="pre">TUPLE</span></code>: Transfer all tables except these specific tables (space separated table names). Implies –without-foreign-keys which inhibits the transfer of foreign keys. Can not be used together with –mysql-tables.</p></li>
+</ul>
+</section>
+<section id="transfer-options">
+<h3>Transfer Options<a class="headerlink" href="#transfer-options" title="Link to this heading">¶</a></h3>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">-L,</span> <span class="pre">--limit-rows</span> <span class="pre">INTEGER</span></code>: Transfer only a limited number of rows from each table.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">-C,</span> <span class="pre">--collation</span> <span class="pre">[BINARY|NOCASE|RTRIM]</span></code>: Create datatypes of TEXT affinity using a specified collation sequence. The default is BINARY.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">-K,</span> <span class="pre">--prefix-indices</span></code>: Prefix indices with their corresponding tables. This ensures that their names remain unique across the SQLite database.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">-X,</span> <span class="pre">--without-foreign-keys</span></code>: Do not transfer foreign keys.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">-Z,</span> <span class="pre">--without-tables</span></code>: Do not transfer tables, data only.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">-W,</span> <span class="pre">--without-data</span></code>: Do not transfer table data, DDL only.</p></li>
+</ul>
+</section>
+<section id="connection-options">
+<h3>Connection Options<a class="headerlink" href="#connection-options" title="Link to this heading">¶</a></h3>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">-h,</span> <span class="pre">--mysql-host</span> <span class="pre">TEXT</span></code>: MySQL host. Defaults to localhost.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">-P,</span> <span class="pre">--mysql-port</span> <span class="pre">INTEGER</span></code>: MySQL port. Defaults to 3306.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">-S,</span> <span class="pre">--skip-ssl</span></code>: Disable MySQL connection encryption.</p></li>
+</ul>
+</section>
+<section id="other-options">
+<h3>Other Options<a class="headerlink" href="#other-options" title="Link to this heading">¶</a></h3>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">-c,</span> <span class="pre">--chunk</span> <span class="pre">INTEGER</span></code>: Chunk reading/writing SQL records.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">-l,</span> <span class="pre">--log-file</span> <span class="pre">PATH</span></code>: Log file.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">--json-as-text</span></code>: Transfer JSON columns as TEXT.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">-V,</span> <span class="pre">--vacuum</span></code>: Use the VACUUM command to rebuild the SQLite database file, repacking it into a minimal amount of disk space.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">--use-buffered-cursors</span></code>: Use MySQLCursorBuffered for reading the MySQL database. This can be useful in situations where multiple queries, with small result sets, need to be combined or computed with each other.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">-q,</span> <span class="pre">--quiet</span></code>: Quiet. Display only errors.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">--debug</span></code>: Debug mode. Will throw exceptions.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">--version</span></code>: Show the version and exit.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">--help</span></code>: Show this message and exit.</p></li>
+</ul>
+</section>
+</section>
+<section id="docker">
+<h2>Docker<a class="headerlink" href="#docker" title="Link to this heading">¶</a></h2>
+<p>If you don’t want to install the tool on your system, you can use the
+Docker image instead.</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>docker<span class="w"> </span>run<span class="w"> </span>-it<span class="w"> </span><span class="se">\</span>
+<span class="w">    </span>--workdir<span class="w"> </span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span><span class="w"> </span><span class="se">\</span>
+<span class="w">    </span>--volume<span class="w"> </span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span>:<span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span><span class="w"> </span><span class="se">\</span>
+<span class="w">    </span>--rm<span class="w"> </span>ghcr.io/techouse/mysql-to-sqlite3:latest<span class="w"> </span><span class="se">\</span>
+<span class="w">    </span>--sqlite-file<span class="w"> </span>baz.db<span class="w"> </span><span class="se">\</span>
+<span class="w">    </span>--mysql-user<span class="w"> </span>foo<span class="w"> </span><span class="se">\</span>
+<span class="w">    </span>--mysql-password<span class="w"> </span>bar<span class="w"> </span><span class="se">\</span>
+<span class="w">    </span>--mysql-database<span class="w"> </span>baz<span class="w"> </span><span class="se">\</span>
+<span class="w">    </span>--mysql-host<span class="w"> </span>host.docker.internal
+</pre></div>
+</div>
+<p>This will mount your host current working directory (pwd) inside the
+Docker container as the current working directory. Any files Docker
+would write to the current working directory are written to the host
+directory where you did docker run. Note that you have to also use a
+<a class="reference external" href="https://docs.docker.com/desktop/networking/#use-cases-and-workarounds-for-all-platforms">special
+hostname</a>
+<code class="docutils literal notranslate"><span class="pre">host.docker.internal</span></code> to access your host machine from inside the
+Docker container.</p>
+</section>
+<section id="homebrew">
+<h2>Homebrew<a class="headerlink" href="#homebrew" title="Link to this heading">¶</a></h2>
+<p>If you’re on macOS, you can install the tool using
+<a class="reference external" href="https://brew.sh/">Homebrew</a>.</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>brew<span class="w"> </span>tap<span class="w"> </span>techouse/mysql-to-sqlite3
+brew<span class="w"> </span>install<span class="w"> </span>mysql-to-sqlite3
+mysql2sqlite<span class="w"> </span>--help
+</pre></div>
+</div>
+</section>
+</section>
+
+
+          </div>
+
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="index.html">mysql-to-sqlite3</a></h1>
+
+
+
+
+
+
+
+
+<h3>Navigation</h3>
+<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Usage</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#options">Options</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#docker">Docker</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#homebrew">Homebrew</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="modules.html">mysql_to_sqlite3</a></li>
+</ul>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="index.html">Documentation overview</a><ul>
+      <li>Previous: <a href="index.html" title="previous chapter">MySQL to SQLite3</a></li>
+      <li>Next: <a href="modules.html" title="next chapter">mysql_to_sqlite3</a></li>
+  </ul></li>
+</ul>
+</div>
+<search id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</search>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+
+
+
+
+
+
+
+
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &#169;2024, Klemen Tusar.
+
+      |
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.3.7</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
+
+      |
+      <a href="_sources/README.rst.txt"
+          rel="nofollow">Page source</a>
+    </div>
+
+
+
+
+  </body>
+</html>
diff --git a/_modules/index.html b/_modules/index.html
@@ -0,0 +1,105 @@
+<!DOCTYPE html>
+
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Overview: module code &#8212; mysql-to-sqlite3 2.2.1 documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d1102ebc" />
+    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=12dfc556" />
+    <script src="../_static/documentation_options.js?v=16656018"></script>
+    <script src="../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+
+  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+
+
+
+  </head><body>
+
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+
+
+          <div class="body" role="main">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="mysql_to_sqlite3/click_utils.html">mysql_to_sqlite3.click_utils</a></li>
+<li><a href="mysql_to_sqlite3/debug_info.html">mysql_to_sqlite3.debug_info</a></li>
+<li><a href="mysql_to_sqlite3/sqlite_utils.html">mysql_to_sqlite3.sqlite_utils</a></li>
+<li><a href="mysql_to_sqlite3/transporter.html">mysql_to_sqlite3.transporter</a></li>
+<li><a href="mysql_to_sqlite3/types.html">mysql_to_sqlite3.types</a></li>
+<li><a href="re.html">re</a></li>
+</ul>
+
+          </div>
+
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="../index.html">mysql-to-sqlite3</a></h1>
+
+
+
+
+
+
+
+
+<h3>Navigation</h3>
+<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../README.html">Usage</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../modules.html">mysql_to_sqlite3</a></li>
+</ul>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="../index.html">Documentation overview</a><ul>
+  </ul></li>
+</ul>
+</div>
+<search id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</search>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+
+
+
+
+
+
+
+
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &#169;2024, Klemen Tusar.
+
+      |
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.3.7</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
+
+    </div>
+
+
+
+
+  </body>
+</html>