Newer
Older
/*
* _____________________________________________________________________________
*
* INAF - OATS National Institute for Astrophysics - Astronomical Observatory of
* Trieste INAF - IA2 Italian Center for Astronomical Archives
* _____________________________________________________________________________
*
* Copyright (C) 2016 Istituto Nazionale di Astrofisica
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License Version 3 as published by the
* Free Software Foundation.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License along with
* this program; if not, write to the Free Software Foundation, Inc., 51
* Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package it.inaf.oats.ia2.tapschemamanager.api;
import it.inaf.oats.ia2.tapschemamanager.api.contract.DatabaseType;
import it.inaf.oats.ia2.tapschemamanager.api.contract.Key;
import it.inaf.oats.ia2.tapschemamanager.api.contract.KeyColumn;
import it.inaf.oats.ia2.tapschemamanager.api.contract.Schema;
import it.inaf.oats.ia2.tapschemamanager.api.contract.Table;
import it.inaf.oats.ia2.tapschemamanager.api.contract.TapSchema;
import it.inaf.oats.ia2.tapschemamanager.api.contract.TapSchemaEntity;
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
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.regex.Pattern;
import javax.sql.DataSource;
import org.postgresql.ds.PGPoolingDataSource;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Utility class that contains static methods for managing {@link Key}s and
* {@link KeyColumn}s into the database.
*
* @author Sonia Zorba {@literal <zorba at oats.inaf.it>}
*/
public class DaoKey {
private static final Logger log = LoggerFactory.getLogger(DaoKey.class);
/**
* Generate list of KeyEntity for a given schema, specifying its
* <code>DataSource</code> and its name.<br>
* <strong>IMPORTANT</strong>: this keys are without id. The id has to be
* set when a table is added to a schema.
*/
protected static List<Key> getSchemaKeys(DBWrapper dbWrapper, TapSchema tapSchema, String schemaName) throws SQLException {
log.debug("getSchemaKeys");
DataSource dataSource = TSMUtil.getSchemaDataSource(dbWrapper, tapSchema, schemaName);
DatabaseType dbType = TSMUtil.getSchemaDatabaseType(dbWrapper, tapSchema, schemaName);
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
if (dbType == DatabaseType.MYSQL) {
Map<String, Key> schemaKeys = new HashMap<>();
String query = "SELECT\n"
+ "c.`CONSTRAINT_NAME` AS constraint_name,\n"
+ "k.`TABLE_SCHEMA` AS from_schema,\n"
+ "k.`TABLE_NAME` AS from_table,\n"
+ "k.`COLUMN_NAME` AS from_column,\n"
+ "k.`REFERENCED_TABLE_SCHEMA` AS target_schema,\n"
+ "k.`REFERENCED_TABLE_NAME` AS target_table,\n"
+ "k.`REFERENCED_COLUMN_NAME` AS target_column\n"
+ "FROM information_schema.TABLE_CONSTRAINTS c \n"
+ "LEFT JOIN information_schema.KEY_COLUMN_USAGE k \n"
+ "ON c.`CONSTRAINT_NAME` = k.`CONSTRAINT_NAME` AND c.`TABLE_SCHEMA` = k.`TABLE_SCHEMA`\n"
+ "WHERE c.`CONSTRAINT_TYPE` = 'FOREIGN KEY' \n"
+ "AND k.`TABLE_SCHEMA` = '" + schemaName + "' OR k.`REFERENCED_TABLE_SCHEMA` = '" + schemaName + "'";
try (Connection connection = dataSource.getConnection();
Statement statement = connection.createStatement();
ResultSet resultSet = statement.executeQuery(query)) {
while (resultSet.next()) {
String constraintName = resultSet.getString("constraint_name");
Key key = schemaKeys.get(constraintName);
if (key == null) {
key = new KeyImpl(
dbWrapper,
tapSchema,
resultSet.getString("from_schema"),
resultSet.getString("from_table"),
resultSet.getString("target_schema"),
resultSet.getString("target_table")
);
schemaKeys.put(constraintName, key);
}
((KeyImpl) key).addKeyColumn(resultSet.getString("from_column"), resultSet.getString("target_column"));
}
}
return new ArrayList<>(schemaKeys.values());
} else if (dbType == DatabaseType.POSTGRES) {
String databaseName = ((PGPoolingDataSource) dataSource).getDatabaseName();
List<Key> schemaKeys = new ArrayList<>();
String queryKeys = "SELECT\n"
+ "conname AS constraint_name,\n"
+ "conrelid::regclass AS from_table, \n"
+ "confrelid::regclass AS target_table\n"
+ "FROM pg_catalog.pg_constraint\n"
+ "WHERE contype = 'f'\n"
+ "AND ((conrelid::regclass || '' LIKE '" + schemaName + ".%')\n"
+ "OR (confrelid::regclass || '' LIKE '" + schemaName + ".%'))";
try (Connection connection = dataSource.getConnection();
Statement statement = connection.createStatement();
ResultSet resultSet = statement.executeQuery(queryKeys)) {
log.debug("Executing query {}", queryKeys);
while (resultSet.next()) {
String constraintName = resultSet.getString("constraint_name");
String[] fromTableFullNameSplit = resultSet.getString("from_table").split(Pattern.quote("."));
String fromSchema = fromTableFullNameSplit[0];
String fromTable = fromTableFullNameSplit[1];
String[] targetTableFullNameSplit = resultSet.getString("target_table").split(Pattern.quote("."));
String targetSchema = targetTableFullNameSplit[0];
String targetTable = targetTableFullNameSplit[1];
Key key = new KeyImpl(dbWrapper, tapSchema, fromSchema, fromTable, targetSchema, targetTable);
schemaKeys.add(key);
// conkey conrelid
String queryFromKC = "SELECT\n"
+ "c.column_name AS key_column\n"
+ "FROM information_schema.columns c\n"
+ "JOIN pg_catalog.pg_constraint r ON c.ordinal_position = ANY(r.conkey)\n"
+ "AND (c.table_schema || '.' || c.table_name) = (r.conrelid::regclass || '')\n"
+ "WHERE r.conname = '" + constraintName + "' AND r.contype = 'f'\n"
+ "AND c.table_schema = '" + fromSchema + "'\n"
+ "AND table_catalog = '" + databaseName + "'";
// as above, but with confkey and confrelid and different c.table_schema where condition
String queryTargetKC = "SELECT\n"
+ "c.column_name AS key_column\n"
+ "FROM information_schema.columns c\n"
+ "JOIN pg_catalog.pg_constraint r ON c.ordinal_position = ANY(r.confkey)\n"
+ "AND (c.table_schema || '.' || c.table_name) = (r.confrelid::regclass || '')\n"
+ "WHERE r.conname = '" + constraintName + "' AND r.contype = 'f'\n"
+ "AND c.table_schema = '" + targetSchema + "'\n"
+ "AND table_catalog = '" + databaseName + "'";
try (Statement statFromKC = connection.createStatement();
Statement statTargetKC = connection.createStatement()) {
try (ResultSet rsFromKC = statFromKC.executeQuery(queryFromKC);
ResultSet rsTargetKC = statTargetKC.executeQuery(queryTargetKC)) {
log.debug("Executing query {}", queryFromKC);
log.debug("Executing query {}", queryTargetKC);
while (rsFromKC.next()) {
if (rsTargetKC.next()) {
((KeyImpl) key).addKeyColumn(
rsFromKC.getString("key_column"),
rsTargetKC.getString("key_column")
);
}
}
}
}
}
}
return schemaKeys;
} else {
throw new UnsupportedOperationException("Database type " + dbType + " not supported");
}
}
/**
* Retrieves saved {@code Key}s from the database and add them into the
* specified {@code TapSchema}.
*/
protected static void fillSavedKeys(DBWrapper dbWrapper, TapSchema tapSchema) throws SQLException {
log.debug("fillSavedKeys");
// We can decide to work only on from tables or target tables, because
// the same key is contained on both.
// Schemas and tables have to be already added to the TAP_SCHEMA.
List<Key> allVisibleKeys = new ArrayList<>();
// Reset to null all generated keyId.
for (Key key : ((TapSchemaImpl) tapSchema).getAllKeys()) {
key.initProperty(Key.ID_KEY, null);
// Meanwhile we add all the visible keys to this list for
// further checks
if (key.isVisible()) {
allVisibleKeys.add(key);
}
}
SelectQueryBuilder keysSelect = new SelectQueryBuilder(dbWrapper.getTapSchemaDatabaseType(), tapSchema, TapSchema.KEYS_TABLE) {
@Override
protected TapSchemaEntity getEntity(ResultSet rs) throws SQLException {
throw new UnsupportedOperationException();
}
};
String queryKeys = keysSelect.getQuery();
SelectQueryBuilder keyColumnsSelect = new SelectQueryBuilder(dbWrapper.getTapSchemaDatabaseType(), tapSchema, TapSchema.KEY_COLUMNS_TABLE) {
@Override
protected TapSchemaEntity getEntity(ResultSet rs) throws SQLException {
throw new UnsupportedOperationException();
}
};
String queryKeyColumns = String.format("%s WHERE %s = ?",
keyColumnsSelect.getQuery(),
TSMUtil.escapeName(KeyColumn.KEY_ID_KEY, dbWrapper.getTapSchemaDatabaseType()));
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
boolean supportKeyID = EntityPropertyInfo.getEntityPropertyInfo(TapSchema.KEYS_TABLE, Key.KEY_ID_KEY).acceptVersion(tapSchema.getVersion());
boolean supportKeyColumnID = EntityPropertyInfo.getEntityPropertyInfo(TapSchema.KEY_COLUMNS_TABLE, KeyColumn.KEY_COLUMN_ID_KEY).acceptVersion(tapSchema.getVersion());
try (Connection conn = dbWrapper.getTapSchemaConnection()) {
log.debug("Executing query {}", queryKeys);
// ResultSet type and concurrency are necessary for PostgreSQL
try (Statement statementKeys = conn.createStatement(ResultSet.TYPE_SCROLL_SENSITIVE, ResultSet.CONCUR_UPDATABLE);
ResultSet rsKeys = statementKeys.executeQuery(queryKeys)) {
while (rsKeys.next()) {
// Searching the keys.
String fromTableCompleteNameSplit[] = rsKeys.getString(Key.FROM_TABLE_KEY).split(Pattern.quote("."));
String fromSchemaName = fromTableCompleteNameSplit[0];
String fromTableName = fromTableCompleteNameSplit[1];
Schema fromSchema = tapSchema.getChild(fromSchemaName);
if (fromSchema == null) {
throw new InconsistentTapSchemaException("Saved TAP_SCHEMA contains a key that is referred to a schema that wasn't added to that TAP_SCHEMA.");
}
Table fromTable = fromSchema.getChild(fromTableName);
if (fromTable == null) {
throw new InconsistentTapSchemaException("Saved TAP_SCHEMA contains a key that is referred to a table that wasn't added to that TAP_SCHEMA.");
}
String keyId = rsKeys.getString(Key.ID_KEY);
// ResultSet type and concurrency are necessary for PostgreSQL
try (PreparedStatement statementKeyColumns = conn.prepareStatement(queryKeyColumns, ResultSet.TYPE_SCROLL_SENSITIVE, ResultSet.CONCUR_UPDATABLE)) {
statementKeyColumns.setString(1, keyId);
log.debug("Executing query {} [key_id={}]", queryKeyColumns, keyId);
try (ResultSet rsKeyColumns = statementKeyColumns.executeQuery()) {
for (Key fromKey : fromTable.getAllFromKeys()) {
boolean columnsFound = false;
for (KeyColumn keyColumn : fromKey.getKeyColumns()) {
columnsFound = false;
rsKeyColumns.beforeFirst();
while (rsKeyColumns.next()) {
String fromColumn = rsKeyColumns.getString(KeyColumn.FROM_COLUMN_KEY);
String targetColumn = rsKeyColumns.getString(KeyColumn.TARGET_COLUMN_KEY);
if (keyColumn.getFromColumn().equals(fromColumn)
&& keyColumn.getTargetColumn().equals(targetColumn)) {
columnsFound = true;
break;
}
}
if (!columnsFound) {
break;
}
}
if (columnsFound) {
// all columns found --> key found!
// Updating key
String keyDescription = rsKeys.getString(Key.DESCRIPTION_KEY);
String keyUtype = rsKeys.getString(Key.UTYPE_KEY);
fromKey.initProperty(Key.ID_KEY, keyId);
fromKey.initProperty(Key.DESCRIPTION_KEY, keyDescription);
fromKey.initProperty(Key.UTYPE_KEY, keyUtype);
if (supportKeyID) {
fromKey.initProperty(Key.KEY_ID_KEY, TSMUtil.getObject(rsKeys, Key.KEY_ID_KEY, Long.class));
}
((KeyImpl) fromKey).setVisible(true);
// Updating key columns
for (KeyColumn keyColumn : fromKey.getKeyColumns()) {
rsKeyColumns.beforeFirst();
while (rsKeyColumns.next()) {
String fromColumn = rsKeyColumns.getString(KeyColumn.FROM_COLUMN_KEY);
String targetColumn = rsKeyColumns.getString(KeyColumn.TARGET_COLUMN_KEY);
if (keyColumn.getFromColumn().equals(fromColumn)
&& keyColumn.getTargetColumn().equals(targetColumn)) {
keyColumn.initProperty(KeyColumn.KEY_ID_KEY, keyId);
if (supportKeyColumnID) {
keyColumn.initProperty(KeyColumn.KEY_COLUMN_ID_KEY, TSMUtil.getObject(rsKeyColumns, KeyColumn.KEY_COLUMN_ID_KEY, Long.class));
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
}
break;
}
}
}
break;
}
}
}
}
}
// Check if the saved TAP_SCHEMA contains keys that aren't loaded (fictitious keys).
List<Key> fictitiousKeys = new ArrayList<>();
rsKeys.beforeFirst();
while (rsKeys.next()) {
String keyId = rsKeys.getString(Key.ID_KEY);
boolean keyIdFound = false;
for (Key key : allVisibleKeys) {
if (keyId.equals(key.getId())) {
keyIdFound = true;
break;
}
}
if (!keyIdFound) {
String fromTableCompleteName = rsKeys.getString(Key.FROM_TABLE_KEY);
String targetTableCompleteName = rsKeys.getString(Key.TARGET_TABLE_KEY);
KeyImpl key = new KeyImpl(dbWrapper, tapSchema, fromTableCompleteName, targetTableCompleteName);
key.initProperty(Key.ID_KEY, keyId);
if (supportKeyID) {
key.initProperty(Key.KEY_ID_KEY, TSMUtil.getObject(rsKeys, Key.KEY_ID_KEY, Long.class));
}
key.setVisible(true);
fictitiousKeys.add(key);
tapSchema.getChild(key.getFromSchemaName()).getChild(key.getFromTableSimpleName()).addFromKey(key);
tapSchema.getChild(key.getTargetSchemaName()).getChild(key.getTargetTableSimpleName()).addTargetKey(key);
}
}
// filling fictitious keys columns
for (Key key : fictitiousKeys) {
try (PreparedStatement statementKeyColumns = conn.prepareStatement(queryKeyColumns)) {
String keyId = key.getId();
statementKeyColumns.setString(1, keyId);
log.debug("Executing query {} [key_id={}]", queryKeyColumns, keyId);
try (ResultSet rsKeyColumns = statementKeyColumns.executeQuery()) {
while (rsKeyColumns.next()) {
String fromColumn = rsKeyColumns.getString(KeyColumn.FROM_COLUMN_KEY);
String targetColumn = rsKeyColumns.getString(KeyColumn.TARGET_COLUMN_KEY);
KeyColumn keyColumn = ((KeyImpl) key).addKeyColumn(fromColumn, targetColumn);
if (supportKeyColumnID) {
keyColumn.initProperty(KeyColumn.KEY_COLUMN_ID_KEY, TSMUtil.getObject(rsKeyColumns, KeyColumn.KEY_COLUMN_ID_KEY, Long.class));
}
}
}
}
// adding fictitious key to key set
((TapSchemaImpl) tapSchema).getAllKeys().add(key);
}
if (!fictitiousKeys.isEmpty()) {
log.debug("{} fictitious keys found", fictitiousKeys.size());
for (Key key : fictitiousKeys) {
log.debug(" {}", key);
}
}
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
// Check if there are remaining keys with keyId = null (valid keys
// that weren't saved into the TAP_SCHEMA).
int keyId = ((TapSchemaImpl) tapSchema).getMaxKeyId() + 1;
for (Key key : allVisibleKeys) {
if (key.getId() == null) {
key.setId(keyId + "");
keyId++;
}
}
}
}
}
/**
* Save a new {@code Key} into the TAP_SCHEMA schema.
*/
protected static void insertNewKey(DatabaseType dbType, Connection connection, TapSchema tapSchema, Key key) throws SQLException {
log.debug("insertNewKey");
InsertQueryBuilder insertQueryBuilder = new InsertQueryBuilder(dbType, tapSchema, key, TapSchema.KEYS_TABLE);
insertQueryBuilder.executeQuery(connection);
for (KeyColumn keyColumn : key.getKeyColumns()) {
insertQueryBuilder = new InsertQueryBuilder(dbType, tapSchema, keyColumn, TapSchema.KEY_COLUMNS_TABLE);
insertQueryBuilder.executeQuery(connection);
}
}
/**
* Updates an existing {@code Key}.
*/
protected static void updateKey(DatabaseType dbType, Connection connection, TapSchema tapSchema, Key key) throws SQLException {
log.debug("updateKey");
if (key.getId() == null) {
throw new IllegalStateException("Unable to update key: key_id is null");
}
boolean keyIdChanged = key.isChanged(Key.ID_KEY);
if (keyIdChanged) {
// Deleting key columns to avoid problem with foreign key constraint failures
String tapSchemaNameEscaped = TSMUtil.escapeName(tapSchema.getName(), dbType);
String keyColumnsNameEscaped = TSMUtil.escapeName("key_columns", dbType);
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
String query = String.format("DELETE FROM %s.%s WHERE key_id = ?", tapSchemaNameEscaped, keyColumnsNameEscaped);
try (PreparedStatement statement = connection.prepareStatement(query)) {
String originalKey = key.getOriginalValue(Key.ID_KEY, String.class);
statement.setString(1, originalKey);
log.debug("Executing query {} [key_id={}]", query, originalKey);
statement.executeUpdate();
}
}
// Updating keys
UpdateQueryBuilder updateQueryBuilder = new UpdateQueryBuilder(dbType, tapSchema, key, TapSchema.KEYS_TABLE, "key_id = ?");
String query = updateQueryBuilder.getQuery();
try (PreparedStatement statement = connection.prepareStatement(query)) {
int i = updateQueryBuilder.addStatementValues(statement);
String keyId = key.getId();
statement.setString(i, keyId);
log.debug("Executing query {} [key_id={}]", query, keyId);
statement.executeUpdate();
}
if (keyIdChanged) {
// Re-insert deleted key columns
for (KeyColumn keyColumn : key.getKeyColumns()) {
InsertQueryBuilder insertQueryBuilder = new InsertQueryBuilder(dbType, tapSchema, keyColumn, TapSchema.KEY_COLUMNS_TABLE);
insertQueryBuilder.executeQuery(connection);
}
} else {
// Update key columns
for (KeyColumn keyColumn : key.getKeyColumns()) {
if (keyColumn.isChanged()) {
updateQueryBuilder = new UpdateQueryBuilder(dbType, tapSchema, keyColumn, TapSchema.KEY_COLUMNS_TABLE, "key_id = ?");
query = updateQueryBuilder.getQuery();
try (PreparedStatement statement = connection.prepareStatement(query)) {
int i = updateQueryBuilder.addStatementValues(statement);
String keyId = key.getId();
statement.setString(i, keyId);
log.debug("Executing query {} [key_id={}]", query, keyId);
statement.executeUpdate();
}
}
}
}
}
}