-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmigrate.html
More file actions
135 lines (125 loc) · 2.96 KB
/
migrate.html
File metadata and controls
135 lines (125 loc) · 2.96 KB
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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Migrate Class - Fuel Documentation</title>
<link href="../assets/css/main.css" media="screen" rel="stylesheet" />
<script type="text/javascript" src="../assets/js/jquery-1.4.4.min.js"></script>
<script type="text/javascript" src="../assets/js/nav.js"></script>
<script type="text/javascript" src="../assets/js/highlight.pack.js"></script>
<script type="text/javascript">
$(function() {
show_nav('classes', '../');
});
hljs.tabReplace = ' ';
hljs.initHighlightingOnLoad();
</script>
</head>
<body>
<header>
<h1>Fuel Documentation</h1>
</header>
<div id="main-nav"></div>
<section id="content">
<h2>Migrate Class</h2>
<p>The migrate class allows you to run, walk through and revert <a href="../general/migrations.html">Migrations</a> from your controllers.</p>
<article>
<h4 id="method_current">current()</h4>
<p>Runs the up and down methods to the migration currently set in the migration config.</p>
<table class="method">
<tbody>
<tr>
<th>Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>None</td>
</tr>
<tr>
<th>Returns</th>
<td>bool</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre><code>Migrate::current();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_latest">latest()</h4>
<p>Runs up methods for ever migration between the current version and the last in the migrations folder.</p>
<table class="method">
<tbody>
<tr>
<th>Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>None</td>
</tr>
<tr>
<th>Returns</th>
<td>boolean</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre><code>Migrate::latest();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_version">version($version)</h4>
<p>The <strong>version</strong> method will move the migrations up or down to set the schema at a specific migration.</p>
<table class="method">
<tbody>
<tr>
<th>Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<th><kbd>$version</kbd></th>
<td><i>required</i></td>
<td>The version you are migrating to.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>mixed - Dependent on the <var>$return_type</var>.</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Migrate::version($version)</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
</section>
<section id="footer">
<p>
<a href="http://fuelphp.com">Fuel</a> is released under the MIT license.<br />
© 2010 - 2011 Fuel Development Team
</p>
</section>
</body>
</html>