[GitHub] [drill] paul-rogers commented on a change in pull request #1940: DRILL-7406: Update Calcite to 1.21.0

[GitBox <gi...@apache.org>]

paul-rogers commented on a change in pull request #1940: DRILL-7406: Update Calcite to 1.21.0
URL: https://github.com/apache/drill/pull/1940#discussion_r361893329
 
 

 ##########
 File path: exec/java-exec/src/main/java/org/apache/drill/exec/planner/sql/conversion/DrillCalciteCatalogReader.java
 ##########
 @@ -0,0 +1,213 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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 org.apache.drill.exec.planner.sql.conversion;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Properties;
+import java.util.function.BooleanSupplier;
+import java.util.function.Supplier;
+
+import org.apache.calcite.adapter.java.JavaTypeFactory;
+import org.apache.calcite.config.CalciteConnectionConfigImpl;
+import org.apache.calcite.config.CalciteConnectionProperty;
+import org.apache.calcite.jdbc.CalciteSchema;
+import org.apache.calcite.jdbc.DynamicSchema;
+import org.apache.calcite.prepare.CalciteCatalogReader;
+import org.apache.calcite.prepare.Prepare;
+import org.apache.calcite.schema.SchemaPlus;
+import org.apache.calcite.sql.validate.SqlValidatorUtil;
+import org.apache.calcite.util.Util;
+import org.apache.drill.common.config.DrillConfig;
+import org.apache.drill.common.exceptions.UserException;
+import org.apache.drill.exec.metastore.MetadataProviderManager;
+import org.apache.drill.exec.planner.logical.DrillTable;
+import org.apache.drill.exec.planner.sql.SchemaUtilites;
+import org.apache.drill.exec.rpc.user.UserSession;
+import org.apache.drill.exec.store.dfs.FileSelection;
+import org.apache.drill.shaded.guava.com.google.common.cache.CacheBuilder;
+import org.apache.drill.shaded.guava.com.google.common.cache.CacheLoader;
+import org.apache.drill.shaded.guava.com.google.common.cache.LoadingCache;
+import org.apache.drill.shaded.guava.com.google.common.collect.ImmutableList;
+
+/**
+ * Extension of {@link CalciteCatalogReader} to add ability to check for temporary tables first
+ * if schema is not indicated near table name during query parsing
+ * or indicated workspace is default temporary workspace.
+ */
+class DrillCalciteCatalogReader extends CalciteCatalogReader {
+
+  private final DrillConfig drillConfig;
+  private final UserSession session;
+  private final String temporarySchema;
+  private boolean allowTemporaryTables;
+  private final BooleanSupplier useRootSchema;
+  private final Supplier<SchemaPlus> defaultSchemaSupplier;
+
+  private final LoadingCache<DrillTableKey, MetadataProviderManager> tableCache;
+
+  DrillCalciteCatalogReader(SchemaPlus rootSchema,
+                            boolean caseSensitive,
+                            List<String> defaultSchema,
+                            JavaTypeFactory typeFactory,
+                            DrillConfig drillConfig,
+                            UserSession session,
+                            String temporarySchema,
+                            BooleanSupplier useRootSchema,
+                            Supplier<SchemaPlus> defaultSchemaSupplier) {
+    super(DynamicSchema.from(rootSchema), defaultSchema,
+        typeFactory, getConnectionConfig(caseSensitive));
+    this.drillConfig = drillConfig;
+    this.session = session;
+    this.allowTemporaryTables = true;
+    this.tableCache =
+        CacheBuilder.newBuilder()
+          .build(new CacheLoader<DrillTableKey, MetadataProviderManager>() {
+            @Override
+            public MetadataProviderManager load(DrillTableKey key) {
+              return key.getMetadataProviderManager();
+            }
+          });
+    this.temporarySchema = temporarySchema;
+    this.useRootSchema = useRootSchema;
+    this.defaultSchemaSupplier = defaultSchemaSupplier;
+  }
+
+  /**
+   * Disallow temporary tables presence in sql statement (ex: in view definitions)
+   */
+  void disallowTemporaryTables() {
+    this.allowTemporaryTables = false;
+  }
+
+  List<String> getTemporaryNames(List<String> names) {
+    if (mightBeTemporaryTable(names, session.getDefaultSchemaPath(), drillConfig)) {
+      String tableName = FileSelection.removeLeadingSlash(names.get(names.size() - 1));
+      String temporaryTableName = session.resolveTemporaryTableName(tableName);
+      if (temporaryTableName != null) {
+        List<String> temporaryNames = new ArrayList<>(SchemaUtilites.getSchemaPathAsList(temporarySchema));
+        temporaryNames.add(temporaryTableName);
+        return temporaryNames;
+      }
+    }
+    return null;
+  }
+
+  /**
+   * If schema is not indicated (only one element in the list) or schema is default temporary workspace,
+   * we need to check among session temporary tables in default temporary workspace first.
+   * If temporary table is found and temporary tables usage is allowed, its table instance will be returned,
+   * otherwise search will be conducted in original workspace.
+   *
+   * @param names list of schema and table names, table name is always the last element
+   * @return table instance, null otherwise
+   * @throws UserException if temporary tables usage is disallowed
+   */
+  @Override
+  public Prepare.PreparingTable getTable(List<String> names) {
+    checkIfWeCanProceedForTemporaryTable(names);
+    Prepare.PreparingTable table = super.getTable(names);
+    DrillTable drillTable;
+    if (table != null && (drillTable = table.unwrap(DrillTable.class)) != null) {
+      drillTable.setOptions(session.getOptions());
+      drillTable.setTableMetadataProviderManager(tableCache.getUnchecked(DrillTableKey.of(names, drillTable)));
+    }
+    return table;
+  }
+
+  private void checkIfWeCanProceedForTemporaryTable(List<String> names) {
+    String originalTableName;
+    if (!allowTemporaryTables &&
+        (originalTableName = session.getOriginalTableNameFromTemporaryTable(names.get(names.size() - 1))) != null) {
+      throw UserException
+          .validationError()
+          .message("Temporary tables usage is disallowed. Used temporary table name: [%s].", originalTableName)
+          .build(SqlConverter.logger);
+    }
+  }
+
+  @Override
+  public List<List<String>> getSchemaPaths() {
+    if (useRootSchema.getAsBoolean()) {
+      return ImmutableList.of(ImmutableList.of());
+    }
+    return super.getSchemaPaths();
+  }
+
+  /**
+   * Checks if the schema provided is a valid schema:
+   * <li>schema is not indicated (only one element in the names list)<li/>
+   *
+   * @param names list of schema and table names, table name is always the last element
+   * @throws UserException if the schema is not valid.
+   */
+  void isValidSchema(List<String> names) throws UserException {
+    List<String> schemaPath = Util.skipLast(names);
+
+    for (List<String> currentSchema : getSchemaPaths()) {
+      List<String> fullSchemaPath = new ArrayList<>(currentSchema);
+      fullSchemaPath.addAll(schemaPath);
+      CalciteSchema schema = SqlValidatorUtil.getSchema(getRootSchema(),
+          fullSchemaPath, nameMatcher());
+
+      if (schema != null) {
+       return;
+      }
+    }
+    SchemaUtilites.throwSchemaNotFoundException(defaultSchemaSupplier.get(), schemaPath);
+  }
+
+  /**
+   * We should check if passed table is temporary or not if:
+   * <li>schema is not indicated (only one element in the names list)<li/>
+   * <li>current schema or indicated schema is default temporary workspace<li/>
+   *
+   * Examples (where dfs.tmp is default temporary workspace):
+   * <li>select * from t<li/>
+   * <li>select * from dfs.tmp.t<li/>
+   * <li>use dfs; select * from tmp.t<li/>
+   *
+   * @param names             list of schema and table names, table name is always the last element
+   * @param defaultSchemaPath current schema path set using USE command
+   * @param drillConfig       drill config
+   * @return true if check for temporary table should be done, false otherwise
+   */
+  private boolean mightBeTemporaryTable(List<String> names, String defaultSchemaPath, DrillConfig drillConfig) {
 
 Review comment:
   `needsTempTableCheck` as name? The present name suggests that this does the check.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services