View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.shardingsphere.infra.database.postgresql.metadata.data.loader;
19  
20  import com.google.common.collect.LinkedHashMultimap;
21  import com.google.common.collect.Multimap;
22  import org.apache.shardingsphere.infra.database.core.metadata.data.loader.DialectMetaDataLoader;
23  import org.apache.shardingsphere.infra.database.core.metadata.data.loader.MetaDataLoaderMaterial;
24  import org.apache.shardingsphere.infra.database.core.metadata.data.loader.type.SchemaMetaDataLoader;
25  import org.apache.shardingsphere.infra.database.core.metadata.data.model.ColumnMetaData;
26  import org.apache.shardingsphere.infra.database.core.metadata.data.model.ConstraintMetaData;
27  import org.apache.shardingsphere.infra.database.core.metadata.data.model.IndexMetaData;
28  import org.apache.shardingsphere.infra.database.core.metadata.data.model.SchemaMetaData;
29  import org.apache.shardingsphere.infra.database.core.metadata.data.model.TableMetaData;
30  import org.apache.shardingsphere.infra.database.core.metadata.database.datatype.DataTypeLoader;
31  import org.apache.shardingsphere.infra.database.core.type.DatabaseType;
32  import org.apache.shardingsphere.infra.spi.type.typed.TypedSPILoader;
33  
34  import java.sql.Connection;
35  import java.sql.PreparedStatement;
36  import java.sql.ResultSet;
37  import java.sql.SQLException;
38  import java.util.Collection;
39  import java.util.HashSet;
40  import java.util.LinkedHashMap;
41  import java.util.LinkedList;
42  import java.util.Map;
43  import java.util.Optional;
44  import java.util.Set;
45  import java.util.stream.Collectors;
46  
47  /**
48   * Meta data loader for PostgreSQL.
49   */
50  public final class PostgreSQLMetaDataLoader implements DialectMetaDataLoader {
51      
52      private static final String BASIC_TABLE_META_DATA_SQL = "SELECT table_name, column_name, ordinal_position, data_type, udt_name, column_default, table_schema, is_nullable"
53              + " FROM information_schema.columns WHERE table_schema IN (%s)";
54      
55      private static final String TABLE_META_DATA_SQL_WITHOUT_TABLES = BASIC_TABLE_META_DATA_SQL + " ORDER BY ordinal_position";
56      
57      private static final String TABLE_META_DATA_SQL_WITH_TABLES = BASIC_TABLE_META_DATA_SQL + " AND table_name IN (%s) ORDER BY ordinal_position";
58      
59      private static final String FOREIGN_KEY_META_DATA_SQL = "SELECT tc.table_schema,tc.table_name,tc.constraint_name,pgo.relname refer_table_name "
60              + "FROM information_schema.table_constraints tc "
61              + "JOIN pg_constraint pgc ON tc.constraint_name = pgc.conname AND contype='f' "
62              + "JOIN pg_class pgo ON pgc.confrelid = pgo.oid WHERE tc.constraint_type = 'FOREIGN KEY' AND tc.table_schema IN (%s)";
63      
64      private static final String PRIMARY_KEY_META_DATA_SQL = "SELECT tc.table_name, kc.column_name, kc.table_schema FROM information_schema.table_constraints tc"
65              + " JOIN information_schema.key_column_usage kc ON kc.table_schema = tc.table_schema AND kc.table_name = tc.table_name AND kc.constraint_name = tc.constraint_name"
66              + " WHERE tc.constraint_type = 'PRIMARY KEY' AND kc.ordinal_position IS NOT NULL AND kc.table_schema IN (%s)";
67      
68      private static final String BASIC_INDEX_META_DATA_SQL = "SELECT tablename, indexname, schemaname FROM pg_indexes WHERE schemaname IN (%s)";
69      
70      private static final String ADVANCE_INDEX_META_DATA_SQL =
71              "SELECT idx.relname as index_name, insp.nspname as index_schema, tbl.relname as table_name, att.attname AS column_name, pgi.indisunique as is_unique"
72                      + " FROM pg_index pgi JOIN pg_class idx ON idx.oid = pgi.indexrelid JOIN pg_namespace insp ON insp.oid = idx.relnamespace JOIN pg_class tbl ON tbl.oid = pgi.indrelid"
73                      + " JOIN pg_namespace tnsp ON tnsp.oid = tbl.relnamespace JOIN pg_attribute att ON att.attrelid = tbl.oid AND att.attnum = ANY(pgi.indkey) WHERE tnsp.nspname IN (%s)";
74      
75      private static final String LOAD_ALL_ROLE_TABLE_GRANTS_SQL = "SELECT table_name FROM information_schema.role_table_grants";
76      
77      private static final String LOAD_FILTERED_ROLE_TABLE_GRANTS_SQL = LOAD_ALL_ROLE_TABLE_GRANTS_SQL + " WHERE table_name IN (%s)";
78      
79      @Override
80      public Collection<SchemaMetaData> load(final MetaDataLoaderMaterial material) throws SQLException {
81          try (Connection connection = material.getDataSource().getConnection()) {
82              Collection<String> schemaNames = SchemaMetaDataLoader.loadSchemaNames(connection, TypedSPILoader.getService(DatabaseType.class, "PostgreSQL"));
83              Map<String, Multimap<String, IndexMetaData>> schemaIndexMetaDataMap = loadIndexMetaDataMap(connection, schemaNames);
84              Map<String, Multimap<String, ColumnMetaData>> schemaColumnMetaDataMap = loadColumnMetaDataMap(connection, material.getActualTableNames(), schemaNames);
85              Map<String, Multimap<String, ConstraintMetaData>> schemaConstraintMetaDataMap = loadConstraintMetaDataMap(connection, schemaNames);
86              Collection<SchemaMetaData> result = new LinkedList<>();
87              for (String each : schemaNames) {
88                  Multimap<String, IndexMetaData> tableIndexMetaDataMap = schemaIndexMetaDataMap.getOrDefault(each, LinkedHashMultimap.create());
89                  Multimap<String, ColumnMetaData> tableColumnMetaDataMap = schemaColumnMetaDataMap.getOrDefault(each, LinkedHashMultimap.create());
90                  Multimap<String, ConstraintMetaData> tableConstraintMetaDataMap = schemaConstraintMetaDataMap.getOrDefault(each, LinkedHashMultimap.create());
91                  result.add(new SchemaMetaData(each, createTableMetaDataList(tableIndexMetaDataMap, tableColumnMetaDataMap, tableConstraintMetaDataMap)));
92              }
93              return result;
94          }
95      }
96      
97      private Map<String, Multimap<String, IndexMetaData>> loadIndexMetaDataMap(final Connection connection, final Collection<String> schemaNames) throws SQLException {
98          Map<String, Multimap<String, IndexMetaData>> result = new LinkedHashMap<>();
99          try (PreparedStatement preparedStatement = connection.prepareStatement(getIndexMetaDataSQL(schemaNames)); ResultSet resultSet = preparedStatement.executeQuery()) {
100             while (resultSet.next()) {
101                 String schemaName = resultSet.getString("schemaname");
102                 String tableName = resultSet.getString("tablename");
103                 String indexName = resultSet.getString("indexname");
104                 Multimap<String, IndexMetaData> indexMetaDataMap = result.computeIfAbsent(schemaName, key -> LinkedHashMultimap.create());
105                 indexMetaDataMap.put(tableName, new IndexMetaData(indexName));
106             }
107         }
108         try (PreparedStatement preparedStatement = connection.prepareStatement(getAdvanceIndexMetaDataSQL(schemaNames)); ResultSet resultSet = preparedStatement.executeQuery()) {
109             while (resultSet.next()) {
110                 String schemaName = resultSet.getString("index_schema");
111                 String tableName = resultSet.getString("table_name");
112                 String columnName = resultSet.getString("column_name");
113                 String indexName = resultSet.getString("index_name");
114                 boolean isUnique = resultSet.getBoolean("is_unique");
115                 Collection<IndexMetaData> indexMetaDatas = result.getOrDefault(schemaName, LinkedHashMultimap.create()).get(tableName);
116                 if (indexMetaDatas.isEmpty()) {
117                     continue;
118                 }
119                 Optional<IndexMetaData> indexMetaData = indexMetaDatas.stream().filter(each -> each.getName().equals(indexName)).findFirst();
120                 if (indexMetaData.isPresent()) {
121                     indexMetaData.get().setUnique(isUnique);
122                     indexMetaData.get().getColumns().add(columnName);
123                 }
124             }
125         }
126         return result;
127     }
128     
129     private String getIndexMetaDataSQL(final Collection<String> schemaNames) {
130         return String.format(BASIC_INDEX_META_DATA_SQL, schemaNames.stream().map(each -> String.format("'%s'", each)).collect(Collectors.joining(",")));
131     }
132     
133     private String getAdvanceIndexMetaDataSQL(final Collection<String> schemaNames) {
134         return String.format(ADVANCE_INDEX_META_DATA_SQL, schemaNames.stream().map(each -> String.format("'%s'", each)).collect(Collectors.joining(",")));
135     }
136     
137     private Map<String, Multimap<String, ColumnMetaData>> loadColumnMetaDataMap(final Connection connection, final Collection<String> tables,
138                                                                                 final Collection<String> schemaNames) throws SQLException {
139         Map<String, Multimap<String, ColumnMetaData>> result = new LinkedHashMap<>();
140         Collection<String> roleTableGrants = loadRoleTableGrants(connection, tables);
141         try (PreparedStatement preparedStatement = connection.prepareStatement(getColumnMetaDataSQL(schemaNames, tables)); ResultSet resultSet = preparedStatement.executeQuery()) {
142             Map<String, Integer> dataTypes = new DataTypeLoader().load(connection.getMetaData(), getType());
143             Collection<String> primaryKeys = loadPrimaryKeys(connection, schemaNames);
144             while (resultSet.next()) {
145                 String tableName = resultSet.getString("table_name");
146                 if (!roleTableGrants.contains(tableName)) {
147                     continue;
148                 }
149                 String schemaName = resultSet.getString("table_schema");
150                 Multimap<String, ColumnMetaData> columnMetaDataMap = result.computeIfAbsent(schemaName, key -> LinkedHashMultimap.create());
151                 columnMetaDataMap.put(tableName, loadColumnMetaData(dataTypes, primaryKeys, resultSet));
152             }
153         }
154         return result;
155     }
156     
157     private Collection<String> loadRoleTableGrants(final Connection connection, final Collection<String> tables) throws SQLException {
158         Collection<String> result = new HashSet<>(tables.size(), 1F);
159         try (PreparedStatement preparedStatement = connection.prepareStatement(getLoadRoleTableGrantsSQL(tables)); ResultSet resultSet = preparedStatement.executeQuery()) {
160             while (resultSet.next()) {
161                 result.add(resultSet.getString("table_name"));
162             }
163         }
164         return result;
165     }
166     
167     private String getLoadRoleTableGrantsSQL(final Collection<String> tables) {
168         return tables.isEmpty() ? LOAD_ALL_ROLE_TABLE_GRANTS_SQL
169                 : String.format(LOAD_FILTERED_ROLE_TABLE_GRANTS_SQL, tables.stream().map(each -> String.format("'%s'", each)).collect(Collectors.joining(",")));
170     }
171     
172     private String getColumnMetaDataSQL(final Collection<String> schemaNames, final Collection<String> tables) {
173         String schemaNameParam = schemaNames.stream().map(each -> String.format("'%s'", each)).collect(Collectors.joining(","));
174         return tables.isEmpty() ? String.format(TABLE_META_DATA_SQL_WITHOUT_TABLES, schemaNameParam)
175                 : String.format(TABLE_META_DATA_SQL_WITH_TABLES, schemaNameParam, tables.stream().map(each -> String.format("'%s'", each)).collect(Collectors.joining(",")));
176     }
177     
178     private Set<String> loadPrimaryKeys(final Connection connection, final Collection<String> schemaNames) throws SQLException {
179         Set<String> result = new HashSet<>();
180         try (PreparedStatement preparedStatement = connection.prepareStatement(getPrimaryKeyMetaDataSQL(schemaNames)); ResultSet resultSet = preparedStatement.executeQuery()) {
181             while (resultSet.next()) {
182                 String schemaName = resultSet.getString("table_schema");
183                 String tableName = resultSet.getString("table_name");
184                 String columnName = resultSet.getString("column_name");
185                 result.add(schemaName + "," + tableName + "," + columnName);
186             }
187         }
188         return result;
189     }
190     
191     private String getPrimaryKeyMetaDataSQL(final Collection<String> schemaNames) {
192         return String.format(PRIMARY_KEY_META_DATA_SQL, schemaNames.stream().map(each -> String.format("'%s'", each)).collect(Collectors.joining(",")));
193     }
194     
195     private ColumnMetaData loadColumnMetaData(final Map<String, Integer> dataTypeMap, final Collection<String> primaryKeys, final ResultSet resultSet) throws SQLException {
196         String schemaName = resultSet.getString("table_schema");
197         String tableName = resultSet.getString("table_name");
198         String columnName = resultSet.getString("column_name");
199         String dataType = resultSet.getString("udt_name");
200         boolean isPrimaryKey = primaryKeys.contains(schemaName + "," + tableName + "," + columnName);
201         String columnDefault = resultSet.getString("column_default");
202         boolean generated = null != columnDefault && columnDefault.startsWith("nextval(");
203         // TODO user defined collation which deterministic is false
204         boolean caseSensitive = true;
205         boolean isNullable = "YES".equals(resultSet.getString("is_nullable"));
206         return new ColumnMetaData(columnName, dataTypeMap.get(dataType), isPrimaryKey, generated, caseSensitive, true, false, isNullable);
207     }
208     
209     private Map<String, Multimap<String, ConstraintMetaData>> loadConstraintMetaDataMap(final Connection connection, final Collection<String> schemaNames) throws SQLException {
210         Map<String, Multimap<String, ConstraintMetaData>> result = new LinkedHashMap<>();
211         try (PreparedStatement preparedStatement = connection.prepareStatement(getConstraintKeyMetaDataSQL(schemaNames)); ResultSet resultSet = preparedStatement.executeQuery()) {
212             while (resultSet.next()) {
213                 String schemaName = resultSet.getString("table_schema");
214                 Multimap<String, ConstraintMetaData> constraintMetaData = result.computeIfAbsent(schemaName, key -> LinkedHashMultimap.create());
215                 String tableName = resultSet.getString("table_name");
216                 String constraintName = resultSet.getString("constraint_name");
217                 String referencedTableName = resultSet.getString("refer_table_name");
218                 constraintMetaData.put(tableName, new ConstraintMetaData(constraintName, referencedTableName));
219             }
220         }
221         return result;
222     }
223     
224     private String getConstraintKeyMetaDataSQL(final Collection<String> schemaNames) {
225         return String.format(FOREIGN_KEY_META_DATA_SQL, schemaNames.stream().map(each -> String.format("'%s'", each)).collect(Collectors.joining(",")));
226     }
227     
228     private Collection<TableMetaData> createTableMetaDataList(final Multimap<String, IndexMetaData> tableIndexMetaDataMap, final Multimap<String, ColumnMetaData> tableColumnMetaDataMap,
229                                                               final Multimap<String, ConstraintMetaData> tableConstraintMetaDataMap) {
230         Collection<TableMetaData> result = new LinkedList<>();
231         for (String each : tableColumnMetaDataMap.keySet()) {
232             Collection<ColumnMetaData> columnMetaDataList = tableColumnMetaDataMap.get(each);
233             Collection<IndexMetaData> indexMetaDataList = tableIndexMetaDataMap.get(each);
234             Collection<ConstraintMetaData> constraintMetaDataList = tableConstraintMetaDataMap.get(each);
235             result.add(new TableMetaData(each, columnMetaDataList, indexMetaDataList, constraintMetaDataList));
236         }
237         return result;
238     }
239     
240     @Override
241     public String getDatabaseType() {
242         return "PostgreSQL";
243     }
244 }