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
|
// Copyright (C) 2009 The Android Open Source Project
// Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.gerrit.server.schema;
import com.google.gerrit.reviewdb.CurrentSchemaVersion;
import com.google.gerrit.reviewdb.ReviewDb;
import com.google.gwtorm.client.OrmException;
import com.google.gwtorm.client.StatementExecutor;
import com.google.gwtorm.jdbc.JdbcExecutor;
import com.google.gwtorm.jdbc.JdbcSchema;
import com.google.inject.AbstractModule;
import com.google.inject.Provider;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
/** A version of the database schema. */
public abstract class SchemaVersion {
/** The current schema version. */
private static final Class<? extends SchemaVersion> C = Schema_8111655.class;
public static class Module extends AbstractModule {
@Override
protected void configure() {
bind(SchemaVersion.class).annotatedWith(Current.class).to(C);
}
}
private final Provider<? extends SchemaVersion> prior;
private final int versionNbr;
protected SchemaVersion(final Provider<? extends SchemaVersion> prior) {
this.prior = prior;
this.versionNbr = guessVersion(getClass());
}
private static int guessVersion(Class<?> c) {
String n = c.getName();
n = n.substring(n.lastIndexOf('_') + 1);
while (n.startsWith("0"))
n = n.substring(1);
return Integer.parseInt(n);
}
protected SchemaVersion(final Provider<? extends SchemaVersion> prior,
final int versionNbr) {
this.prior = prior;
this.versionNbr = versionNbr;
}
/** @return the {@link CurrentSchemaVersion#versionNbr} this step targets. */
public final int getVersionNbr() {
return versionNbr;
}
public final void check(UpdateUI ui, CurrentSchemaVersion curr, ReviewDb db, boolean toTargetVersion)
throws OrmException, SQLException {
if (curr.versionNbr == versionNbr) {
// Nothing to do, we are at the correct schema.
//
} else {
upgradeFrom(ui, curr, db, toTargetVersion);
}
}
/** Runs check on the prior schema version, and then upgrades. */
protected void upgradeFrom(UpdateUI ui, CurrentSchemaVersion curr, ReviewDb db, boolean toTargetVersion)
throws OrmException, SQLException {
final JdbcSchema s = (JdbcSchema) db;
prior.get().check(ui, curr, db, false);
ui.message("Upgrading database schema from version " + curr.versionNbr
+ " to " + versionNbr + " ...");
preUpdateSchema(db);
final JdbcExecutor e = new JdbcExecutor(s);
try {
s.updateSchema(e);
migrateData(db, ui);
if (toTargetVersion) {
final List<String> pruneList = new ArrayList<String>();
s.pruneSchema(new StatementExecutor() {
public void execute(String sql) {
pruneList.add(sql);
}
});
if (!pruneList.isEmpty()) {
ui.pruneSchema(e, pruneList);
}
}
} finally {
e.close();
}
finish(curr, db);
}
/** Invoke before updateSchema adds new columns/tables. */
protected void preUpdateSchema(ReviewDb db) throws OrmException, SQLException {
}
/**
* Invoked between updateSchema (adds new columns/tables) and pruneSchema
* (removes deleted columns/tables).
*/
protected void migrateData(ReviewDb db, UpdateUI ui) throws OrmException, SQLException {
}
/** Mark the current schema version. */
protected void finish(CurrentSchemaVersion curr, ReviewDb db)
throws OrmException {
curr.versionNbr = versionNbr;
db.schemaVersion().update(Collections.singleton(curr));
}
/** Rename an existing column. */
protected void renameColumn(ReviewDb db, String table, String from, String to)
throws OrmException {
final JdbcSchema s = (JdbcSchema) db;
final JdbcExecutor e = new JdbcExecutor(s);
try {
s.renameField(e, table, from, to);
} finally {
e.close();
}
}
/** Execute a SQL statement. */
protected void execute(ReviewDb db, String sql) throws SQLException {
Statement s = ((JdbcSchema) db).getConnection().createStatement();
try {
s.execute(sql);
} finally {
s.close();
}
}
}
|
