-
Notifications
You must be signed in to change notification settings - Fork 10
/
db_migration.html
257 lines (148 loc) · 9.47 KB
/
db_migration.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Upgrade with database migration — Digdag 0.10.5 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Digdag
</a>
<div class="version">
0.10
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="architecture.html">Architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="concepts.html">Concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="workflow_definition.html">Workflow definition</a></li>
<li class="toctree-l1"><a class="reference internal" href="scheduling_workflow.html">Scheduling workflow</a></li>
<li class="toctree-l1"><a class="reference internal" href="operators.html">Operators</a></li>
<li class="toctree-l1"><a class="reference internal" href="command_reference.html">Command reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="python_api.html">Language API - Python</a></li>
<li class="toctree-l1"><a class="reference internal" href="ruby_api.html">Language API - Ruby</a></li>
<li class="toctree-l1"><a class="reference internal" href="rest_api.html">REST API</a></li>
<li class="toctree-l1"><a class="reference internal" href="command_executor.html">Command Executor</a></li>
<li class="toctree-l1"><a class="reference internal" href="internal.html">Internal architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="metrics.html">Digdag metrics (experimental)</a></li>
<li class="toctree-l1"><a class="reference internal" href="community_contributions.html">Community Contributions</a></li>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="logo.html">Logo</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Digdag</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Upgrade with database migration</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/db_migration.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="upgrade-with-database-migration">
<h1>Upgrade with database migration<a class="headerlink" href="#upgrade-with-database-migration" title="Permalink to this headline">¶</a></h1>
<div class="section" id="automatic-migration">
<h2>1. Automatic migration<a class="headerlink" href="#automatic-migration" title="Permalink to this headline">¶</a></h2>
<p>Digdag supports automatic migration when newer version requires database schema modification.
When a digdag server start, it check <code class="docutils literal notranslate"><span class="pre">schema_migrations</span></code> table and execute each migration sequentially and automatically.
This is default enable, but you can enable/disable with system parameter <code class="docutils literal notranslate"><span class="pre">database.migrate</span></code>.
This parameter is documented from 0.9.36</p>
</div>
<div class="section" id="change-of-migration-behavior-from-0-9-36">
<h2>2. Change of migration behavior from 0.9.36<a class="headerlink" href="#change-of-migration-behavior-from-0-9-36" title="Permalink to this headline">¶</a></h2>
<p>Each migration is executed with transaction. So if migrations fail, you can fix the cause and then retry it.
From 0.9.36, we added non-transactional migration. This is because some DDL cannot run in transaction.
In such migration, if the migration fail, there is a possibility to be required fix by hand before you retry.
So we explain how to recover when a non-transactional migration fails in section 4.</p>
</div>
<div class="section" id="how-to-upgrade-digdag-safely">
<h2>3. How to upgrade Digdag safely<a class="headerlink" href="#how-to-upgrade-digdag-safely" title="Permalink to this headline">¶</a></h2>
<p>If you are running a Digdag cluster in production, we recommend the following way to avoid trouble.</p>
<ol class="simple">
<li><p>Disable auto migration: <code class="docutils literal notranslate"><span class="pre">database.migrate:</span> <span class="pre">false</span></code></p></li>
<li><p>Stop all Digdag servers.</p></li>
<li><p>Upgrade Digdag binary.</p></li>
<li><p>Check migrations by <code class="docutils literal notranslate"><span class="pre">digdag</span> <span class="pre">migrate</span> <span class="pre">check</span></code> and confirm which migrations will be applied.</p></li>
<li><p>Run cli <code class="docutils literal notranslate"><span class="pre">digdag</span> <span class="pre">migrate</span> <span class="pre">run</span></code> in a server.</p></li>
<li><p>Start Digdag servers.</p></li>
</ol>
</div>
<div class="section" id="list-of-non-transactional-migrations">
<h2>4. List of non-transactional migrations<a class="headerlink" href="#list-of-non-transactional-migrations" title="Permalink to this headline">¶</a></h2>
<div class="section" id="ver-0-9-36">
<h3>ver. 0.9.36<a class="headerlink" href="#ver-0-9-36" title="Permalink to this headline">¶</a></h3>
<div class="section" id="id1">
<h4>20190318175338<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h4>
<p>This migration add an index to session_attempts to avoid performance degrade with large session_attempts.
If you want to retry this migration because of unexpected errors, please run following sql.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">drop</span> <span class="n">index</span> <span class="n">session_attempts_on_site_id_and_state_flags_partial_2</span><span class="p">;</span>
<span class="n">delete</span> <span class="kn">from</span> <span class="nn">schema_migrations</span> <span class="n">where</span> <span class="n">name</span> <span class="n">like</span> <span class="s1">'20190318175338'</span><span class="p">;</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2016-2024, Digdag Project
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
<br/>
<br/>
<p><a href="https://digdag.io/">Digdag</a> is an open source project, invented and sponsored by <a href="https://www.treasuredata.com/">Treasure Data, Inc.</a> under the Apache 2.0 Licence.</p>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>