Skip to content

Commit 327615a

Browse files
techousetechouse
committed
deploy: a03a6c6 
0 parents  commit 327615a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+9406
-0
lines changed

‎.buildinfo‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: ebe5db0208bdbbd073566d39c1688797
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎.doctrees/README.doctree‎

21.7 KB
Binary file not shown.

‎.doctrees/environment.pickle‎

215 KB
Binary file not shown.

‎.doctrees/index.doctree‎

22.6 KB
Binary file not shown.

‎.doctrees/modules.doctree‎

2.75 KB
Binary file not shown.

‎.doctrees/mysql_to_sqlite3.doctree‎

135 KB
Binary file not shown.

‎.nojekyll‎

Whitespace-only changes.

‎README.html‎

Lines changed: 213 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,213 @@
1+
<!DOCTYPE html>
2+
3+
<html lang="en" data-content_root="./">
4+
<head>
5+
<meta charset="utf-8" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
7+
8+
<title>Usage &#8212; mysql-to-sqlite3 2.5.5 documentation</title>
9+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
10+
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
11+
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
12+
<script src="_static/documentation_options.js?v=644f8b71"></script>
13+
<script src="_static/doctools.js?v=9bcbadda"></script>
14+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
15+
<link rel="index" title="Index" href="genindex.html" />
16+
<link rel="search" title="Search" href="search.html" />
17+
<link rel="next" title="mysql_to_sqlite3" href="modules.html" />
18+
<link rel="prev" title="MySQL to SQLite3" href="index.html" />
19+
20+
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
21+
22+
23+
24+
25+
26+
</head><body>
27+
28+
29+
<div class="document">
30+
<div class="documentwrapper">
31+
<div class="bodywrapper">
32+
33+
34+
<div class="body" role="main">
35+
36+
<section id="usage">
37+
<h1>Usage<a class="headerlink" href="#usage" title="Link to this heading"></a></h1>
38+
<section id="options">
39+
<h2>Options<a class="headerlink" href="#options" title="Link to this heading"></a></h2>
40+
<p>The command line options for the <code class="docutils literal notranslate"><span class="pre">mysql2sqlite</span></code> tool are as follows:</p>
41+
<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>
42+
</pre></div>
43+
</div>
44+
<section id="required-options">
45+
<h3>Required Options<a class="headerlink" href="#required-options" title="Link to this heading"></a></h3>
46+
<ul class="simple">
47+
<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>
48+
<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>
49+
<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>
50+
</ul>
51+
</section>
52+
<section id="password-options">
53+
<h3>Password Options<a class="headerlink" href="#password-options" title="Link to this heading"></a></h3>
54+
<ul class="simple">
55+
<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>
56+
<li><p><code class="docutils literal notranslate"><span class="pre">--mysql-password</span> <span class="pre">TEXT</span></code>: MySQL password.</p></li>
57+
</ul>
58+
</section>
59+
<section id="table-options">
60+
<h3>Table Options<a class="headerlink" href="#table-options" title="Link to this heading"></a></h3>
61+
<ul class="simple">
62+
<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>
63+
<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>
64+
</ul>
65+
</section>
66+
<section id="transfer-options">
67+
<h3>Transfer Options<a class="headerlink" href="#transfer-options" title="Link to this heading"></a></h3>
68+
<ul class="simple">
69+
<li><p><code class="docutils literal notranslate"><span class="pre">-T,</span> <span class="pre">--mysql-views-as-tables</span></code>: Materialize MySQL VIEWs as SQLite tables (legacy behavior).</p></li>
70+
<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>
71+
<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>
72+
<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>
73+
<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>
74+
<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>
75+
<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>
76+
<li><p><code class="docutils literal notranslate"><span class="pre">-M,</span> <span class="pre">--strict</span></code>: Create SQLite STRICT tables when supported.</p></li>
77+
</ul>
78+
</section>
79+
<section id="connection-options">
80+
<h3>Connection Options<a class="headerlink" href="#connection-options" title="Link to this heading"></a></h3>
81+
<ul class="simple">
82+
<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>
83+
<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>
84+
<li><p><code class="docutils literal notranslate"><span class="pre">--mysql-charset</span> <span class="pre">TEXT</span></code>: MySQL database and table character set. The default is utf8mb4.</p></li>
85+
<li><p><code class="docutils literal notranslate"><span class="pre">--mysql-collation</span> <span class="pre">TEXT</span></code>: MySQL database and table collation</p></li>
86+
<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>
87+
</ul>
88+
</section>
89+
<section id="other-options">
90+
<h3>Other Options<a class="headerlink" href="#other-options" title="Link to this heading"></a></h3>
91+
<ul class="simple">
92+
<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>
93+
<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>
94+
<li><p><code class="docutils literal notranslate"><span class="pre">--json-as-text</span></code>: Transfer JSON columns as TEXT.</p></li>
95+
<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>
96+
<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>
97+
<li><p><code class="docutils literal notranslate"><span class="pre">-q,</span> <span class="pre">--quiet</span></code>: Quiet. Display only errors.</p></li>
98+
<li><p><code class="docutils literal notranslate"><span class="pre">--debug</span></code>: Debug mode. Will throw exceptions.</p></li>
99+
<li><p><code class="docutils literal notranslate"><span class="pre">--version</span></code>: Show the version and exit.</p></li>
100+
<li><p><code class="docutils literal notranslate"><span class="pre">--help</span></code>: Show this message and exit.</p></li>
101+
</ul>
102+
</section>
103+
</section>
104+
<section id="docker">
105+
<h2>Docker<a class="headerlink" href="#docker" title="Link to this heading"></a></h2>
106+
<p>If you don’t want to install the tool on your system, you can use the
107+
Docker image instead.</p>
108+
<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>
109+
<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>
110+
<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>
111+
<span class="w"> </span>--rm<span class="w"> </span>ghcr.io/techouse/mysql-to-sqlite3:latest<span class="w"> </span><span class="se">\</span>
112+
<span class="w"> </span>--sqlite-file<span class="w"> </span>baz.db<span class="w"> </span><span class="se">\</span>
113+
<span class="w"> </span>--mysql-user<span class="w"> </span>foo<span class="w"> </span><span class="se">\</span>
114+
<span class="w"> </span>--mysql-password<span class="w"> </span>bar<span class="w"> </span><span class="se">\</span>
115+
<span class="w"> </span>--mysql-database<span class="w"> </span>baz<span class="w"> </span><span class="se">\</span>
116+
<span class="w"> </span>--mysql-host<span class="w"> </span>host.docker.internal
117+
</pre></div>
118+
</div>
119+
<p>This will mount your host current working directory (pwd) inside the
120+
Docker container as the current working directory. Any files Docker
121+
would write to the current working directory are written to the host
122+
directory where you did docker run. Note that you have to also use a
123+
<a class="reference external" href="https://docs.docker.com/desktop/networking/#use-cases-and-workarounds-for-all-platforms">special
124+
hostname</a>
125+
<code class="docutils literal notranslate"><span class="pre">host.docker.internal</span></code> to access your host machine from inside the
126+
Docker container.</p>
127+
</section>
128+
<section id="homebrew">
129+
<h2>Homebrew<a class="headerlink" href="#homebrew" title="Link to this heading"></a></h2>
130+
<p>If you’re on macOS, you can install the tool using
131+
<a class="reference external" href="https://brew.sh/">Homebrew</a>.</p>
132+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>brew<span class="w"> </span>install<span class="w"> </span>mysql-to-sqlite3
133+
mysql2sqlite<span class="w"> </span>--help
134+
</pre></div>
135+
</div>
136+
</section>
137+
</section>
138+
139+
140+
</div>
141+
142+
</div>
143+
</div>
144+
<div class="sphinxsidebar" role="navigation" aria-label="Main">
145+
<div class="sphinxsidebarwrapper">
146+
<h1 class="logo"><a href="index.html">mysql-to-sqlite3</a></h1>
147+
148+
149+
150+
151+
152+
153+
154+
155+
156+
<search id="searchbox" style="display: none" role="search">
157+
<div class="searchformwrapper">
158+
<form class="search" action="search.html" method="get">
159+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
160+
<input type="submit" value="Go" />
161+
</form>
162+
</div>
163+
</search>
164+
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
165+
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
166+
<ul class="current">
167+
<li class="toctree-l1 current"><a class="current reference internal" href="#">Usage</a><ul>
168+
<li class="toctree-l2"><a class="reference internal" href="#options">Options</a></li>
169+
<li class="toctree-l2"><a class="reference internal" href="#docker">Docker</a></li>
170+
<li class="toctree-l2"><a class="reference internal" href="#homebrew">Homebrew</a></li>
171+
</ul>
172+
</li>
173+
<li class="toctree-l1"><a class="reference internal" href="modules.html">mysql_to_sqlite3</a></li>
174+
</ul>
175+
176+
<div class="relations">
177+
<h3>Related Topics</h3>
178+
<ul>
179+
<li><a href="index.html">Documentation overview</a><ul>
180+
<li>Previous: <a href="index.html" title="previous chapter">MySQL to SQLite3</a></li>
181+
<li>Next: <a href="modules.html" title="next chapter">mysql_to_sqlite3</a></li>
182+
</ul></li>
183+
</ul>
184+
</div>
185+
186+
187+
188+
189+
190+
191+
192+
193+
</div>
194+
</div>
195+
<div class="clearer"></div>
196+
</div>
197+
<div class="footer">
198+
&#169;2025, Klemen Tusar.
199+
200+
|
201+
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
202+
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
203+
204+
|
205+
<a href="_sources/README.rst.txt"
206+
rel="nofollow">Page source</a>
207+
</div>
208+
209+
210+
211+
212+
</body>
213+
</html>

0 commit comments

Comments
 (0)