Add a new config option clp.metadata-filter-provider-type

Author: anlowee

presto-clp/src/main/java/com/facebook/presto/plugin/clp/ClpConfig.java

@@ -24,6 +24,7 @@ public class ClpConfig
 
     private boolean polymorphicTypeEnabled = true;
 
+    private MetadataFilterProviderType metadataFilterProviderType = MetadataFilterProviderType.MYSQL;
     private MetadataProviderType metadataProviderType = MetadataProviderType.MYSQL;
     private String metadataDbUrl;
     private String metadataDbName;
@@ -48,6 +49,18 @@ public ClpConfig setPolymorphicTypeEnabled(boolean polymorphicTypeEnabled)
         return this;
     }
 
+    public MetadataFilterProviderType getMetadataFilterProviderType()
+    {
+        return metadataFilterProviderType;
+    }
+
+    @Config("clp.metadata-filter-provider-type")
+    public ClpConfig setMetadataFilterProviderType(MetadataFilterProviderType metadataFilterProviderType)
+    {
+        this.metadataFilterProviderType = metadataFilterProviderType;
+        return this;
+    }
+
     public MetadataProviderType getMetadataProviderType()
     {
         return metadataProviderType;
@@ -174,6 +187,11 @@ public ClpConfig setSplitProviderType(SplitProviderType splitProviderType)
         return this;
     }
 
+    public enum MetadataFilterProviderType
+    {
+        MYSQL
+    }
+
     public enum MetadataProviderType
     {
         MYSQL

presto-clp/src/main/java/com/facebook/presto/plugin/clp/ClpModule.java

@@ -25,6 +25,7 @@
 import com.google.inject.Scopes;
 
 import static com.facebook.airlift.configuration.ConfigBinder.configBinder;
+import static com.facebook.presto.plugin.clp.ClpConfig.MetadataFilterProviderType;
 import static com.facebook.presto.plugin.clp.ClpConfig.MetadataProviderType;
 import static com.facebook.presto.plugin.clp.ClpConfig.SplitProviderType;
 import static com.facebook.presto.plugin.clp.ClpErrorCode.CLP_UNSUPPORTED_METADATA_SOURCE;
@@ -43,9 +44,13 @@ protected void setup(Binder binder)
         configBinder(binder).bindConfig(ClpConfig.class);
 
         ClpConfig config = buildConfigObject(ClpConfig.class);
+
+        if (MetadataFilterProviderType.MYSQL == config.getMetadataFilterProviderType()) {
+            binder.bind(ClpMetadataFilterProvider.class).to(ClpMySqlMetadataFilterProvider.class).in(Scopes.SINGLETON);
+        }
+
         if (config.getMetadataProviderType() == MetadataProviderType.MYSQL) {
             binder.bind(ClpMetadataProvider.class).to(ClpMySqlMetadataProvider.class).in(Scopes.SINGLETON);
-            binder.bind(ClpMetadataFilterProvider.class).to(ClpMySqlMetadataFilterProvider.class).in(Scopes.SINGLETON);
         }
         else {
             throw new PrestoException(CLP_UNSUPPORTED_METADATA_SOURCE, "Unsupported metadata provider type: " + config.getMetadataProviderType());

presto-clp/src/main/java/com/facebook/presto/plugin/clp/metadata/filter/ClpMetadataProviderSpecificOptionsDeserializer.java renamed to presto-clp/src/main/java/com/facebook/presto/plugin/clp/metadata/filter/ClpCustomMetadataFilterOptionsDeserializer.java

@@ -21,29 +21,29 @@
 
 import java.io.IOException;
 
-import static com.facebook.presto.plugin.clp.metadata.filter.ClpMetadataFilterConfig.MetadataProviderSpecificOptions;
+import static com.facebook.presto.plugin.clp.metadata.filter.ClpMetadataFilterConfig.CustomMetadataFilterOptions;
 
 /**
- * Uses the given implementation of {@link MetadataProviderSpecificOptions} to deserialize the
- * {@code "metadataProviderSpecific"} field in the filter. The implementation is originally chosen
+ * Uses the given implementation of {@link CustomMetadataFilterOptions} to deserialize the
+ * {@code "customOptions"} field in the filter. The implementation is originally chosen
  * by the {@code clp.metadata-provider-type} config option.
  */
-public class ClpMetadataProviderSpecificOptionsDeserializer
-        extends JsonDeserializer<MetadataProviderSpecificOptions>
+public class ClpCustomMetadataFilterOptionsDeserializer
+        extends JsonDeserializer<CustomMetadataFilterOptions>
 {
-    private final Class<? extends MetadataProviderSpecificOptions> actualMetadataProviderSpecificOptionsClass;
+    private final Class<? extends CustomMetadataFilterOptions> actualCustomMetadataFilterOptionsClass;
 
-    public ClpMetadataProviderSpecificOptionsDeserializer(Class<? extends MetadataProviderSpecificOptions> actualMetadataProviderSpecificOptionsClass)
+    public ClpCustomMetadataFilterOptionsDeserializer(Class<? extends CustomMetadataFilterOptions> actualCustomMetadataFilterOptionsClass)
     {
-        this.actualMetadataProviderSpecificOptionsClass = actualMetadataProviderSpecificOptionsClass;
+        this.actualCustomMetadataFilterOptionsClass = actualCustomMetadataFilterOptionsClass;
     }
 
     @Override
-    public MetadataProviderSpecificOptions deserialize(JsonParser p, DeserializationContext ctxt) throws IOException
+    public CustomMetadataFilterOptions deserialize(JsonParser p, DeserializationContext ctxt) throws IOException
     {
         ObjectNode node = p.getCodec().readTree(p);
         ObjectMapper mapper = (ObjectMapper) p.getCodec();
 
-        return mapper.treeToValue(node, actualMetadataProviderSpecificOptionsClass);
+        return mapper.treeToValue(node, actualCustomMetadataFilterOptionsClass);
     }
 }

presto-clp/src/main/java/com/facebook/presto/plugin/clp/metadata/filter/ClpMetadataFilterConfig.java

@@ -22,7 +22,7 @@
  * <ul>
  *   <li><b>{@code columnName}</b>: the data column's name.</li>
  *
- *   <li><b>{@code metadataProviderSpecific}</b>: the metadata provider specific sub-object.</li>
+ *   <li><b>{@code customOptions}</b>: the metadata provider specific sub-object.</li>
  *
  *   <li><b>{@code required}</b> (optional, defaults to {@code false}): indicates whether the
  *   filter must be present in the pushed-down expression for metadata filtering. If a required
@@ -34,12 +34,12 @@ public class ClpMetadataFilterConfig
     @JsonProperty("columnName")
     public String columnName;
 
-    @JsonProperty("metadataProviderSpecific")
-    public MetadataProviderSpecificOptions metadataProviderSpecific;
+    @JsonProperty("customOptions")
+    public CustomMetadataFilterOptions customOptions;
 
     @JsonProperty("required")
     public boolean required;
 
-    public interface MetadataProviderSpecificOptions
+    public interface CustomMetadataFilterOptions
     {}
 }

presto-clp/src/main/java/com/facebook/presto/plugin/clp/metadata/filter/ClpMetadataFilterProvider.java

@@ -31,7 +31,7 @@
 
 import static com.facebook.presto.plugin.clp.ClpErrorCode.CLP_MANDATORY_METADATA_FILTER_NOT_VALID;
 import static com.facebook.presto.plugin.clp.ClpErrorCode.CLP_METADATA_FILTER_CONFIG_NOT_FOUND;
-import static com.facebook.presto.plugin.clp.metadata.filter.ClpMetadataFilterConfig.MetadataProviderSpecificOptions;
+import static com.facebook.presto.plugin.clp.metadata.filter.ClpMetadataFilterConfig.CustomMetadataFilterOptions;
 import static com.google.common.collect.ImmutableSet.toImmutableSet;
 import static java.util.Objects.requireNonNull;
 
@@ -46,7 +46,7 @@
  * to all tables within that schema).
  * <p></p>
  * Different metadata providers can customize filter configurations through the
- * {@code metadataProviderSpecific} field within each {@link ClpMetadataFilterConfig}.
+ * {@code "customOptions"} field within each {@link ClpMetadataFilterConfig}.
  */
 public abstract class ClpMetadataFilterProvider
 {
@@ -63,8 +63,8 @@ public ClpMetadataFilterProvider(ClpConfig config)
         ObjectMapper mapper = new ObjectMapper();
         SimpleModule module = new SimpleModule();
         module.addDeserializer(
-                MetadataProviderSpecificOptions.class,
-                new ClpMetadataProviderSpecificOptionsDeserializer(getMetadataProviderSpecificOptionsClass()));
+                CustomMetadataFilterOptions.class,
+                new ClpCustomMetadataFilterOptionsDeserializer(getMetadataProviderSpecificOptionsClass()));
         mapper.registerModule(module);
         try {
             filterMap = mapper.readValue(
@@ -126,13 +126,13 @@ public Set<String> getColumnNames(String scope)
     }
 
     /**
-     * Returns the {@link MetadataProviderSpecificOptions} class implemented by the user. To respect our
+     * Returns the {@link CustomMetadataFilterOptions} class implemented by the user. To respect our
      * code style, we recommend implementing a {@code protected static class} as an inner class
      * in the user-implemented {@link ClpMetadataFilterProvider} class.
      *
-     * @return the user-implemented {@link MetadataProviderSpecificOptions} class.
+     * @return the user-implemented {@link CustomMetadataFilterOptions} class.
      */
-    protected abstract Class<? extends MetadataProviderSpecificOptions> getMetadataProviderSpecificOptionsClass();
+    protected abstract Class<? extends CustomMetadataFilterOptions> getMetadataProviderSpecificOptionsClass();
 
     private Set<String> getRequiredColumnNames(String scope)
     {

presto-clp/src/main/java/com/facebook/presto/plugin/clp/metadata/filter/ClpMySqlMetadataFilterProvider.java

@@ -23,7 +23,7 @@
 import java.util.Map;
 import java.util.Objects;
 
-import static com.facebook.presto.plugin.clp.metadata.filter.ClpMetadataFilterConfig.MetadataProviderSpecificOptions;
+import static com.facebook.presto.plugin.clp.metadata.filter.ClpMetadataFilterConfig.CustomMetadataFilterOptions;
 import static com.google.common.collect.ImmutableMap.toImmutableMap;
 import static java.lang.String.format;
 
@@ -42,7 +42,7 @@ public ClpMySqlMetadataFilterProvider(ClpConfig config)
 
     /**
      * This method performs regex-based replacements according to the {@code "rangeMapping"} field
-     * in {@link ClpMySqlMetadataProviderSpecificOptions} to convert numeric filter expressions. For
+     * in {@link ClpMySqlCustomMetadataFilterOptions} to convert numeric filter expressions. For
      * example:
      * <ul>
      *   <li>{@code "msg.timestamp" >= 1234} → {@code end_timestamp >= 1234}</li>
@@ -60,7 +60,7 @@ public String remapMetadataFilterPushDown(String scope, String pushDownExpressio
     {
         String[] splitScope = scope.split("\\.");
 
-        Map<String, ClpMySqlMetadataProviderSpecificOptions.RangeMapping> mappings = new HashMap<>(getAllMappingsFromFilters(filterMap.get(splitScope[0])));
+        Map<String, ClpMySqlCustomMetadataFilterOptions.RangeMapping> mappings = new HashMap<>(getAllMappingsFromFilters(filterMap.get(splitScope[0])));
 
         if (1 < splitScope.length) {
             mappings.putAll(getAllMappingsFromFilters(filterMap.get(splitScope[0] + "." + splitScope[1])));
@@ -71,9 +71,9 @@ public String remapMetadataFilterPushDown(String scope, String pushDownExpressio
         }
 
         String remappedSql = pushDownExpression;
-        for (Map.Entry<String, ClpMySqlMetadataProviderSpecificOptions.RangeMapping> entry : mappings.entrySet()) {
+        for (Map.Entry<String, ClpMySqlCustomMetadataFilterOptions.RangeMapping> entry : mappings.entrySet()) {
             String key = entry.getKey();
-            ClpMySqlMetadataProviderSpecificOptions.RangeMapping value = entry.getValue();
+            ClpMySqlCustomMetadataFilterOptions.RangeMapping value = entry.getValue();
             remappedSql = remappedSql.replaceAll(
                     format("\"(%s)\"\\s(>=?)\\s(-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?)", key),
                     format("%s $2 $3", value.upperBound));
@@ -88,21 +88,21 @@ public String remapMetadataFilterPushDown(String scope, String pushDownExpressio
     }
 
     @Override
-    protected Class<? extends MetadataProviderSpecificOptions> getMetadataProviderSpecificOptionsClass()
+    protected Class<? extends CustomMetadataFilterOptions> getMetadataProviderSpecificOptionsClass()
     {
-        return ClpMySqlMetadataProviderSpecificOptions.class;
+        return ClpMySqlCustomMetadataFilterOptions.class;
     }
 
-    private Map<String, ClpMySqlMetadataProviderSpecificOptions.RangeMapping> getAllMappingsFromFilters(List<ClpMetadataFilterConfig> filters)
+    private Map<String, ClpMySqlCustomMetadataFilterOptions.RangeMapping> getAllMappingsFromFilters(List<ClpMetadataFilterConfig> filters)
     {
         return null != filters
                 ? filters.stream()
                 .filter(filter ->
-                        filter.metadataProviderSpecific instanceof ClpMySqlMetadataProviderSpecificOptions &&
-                                ((ClpMySqlMetadataProviderSpecificOptions) filter.metadataProviderSpecific).rangeMapping != null)
+                        filter.customOptions instanceof ClpMySqlCustomMetadataFilterOptions &&
+                                ((ClpMySqlCustomMetadataFilterOptions) filter.customOptions).rangeMapping != null)
                 .collect(toImmutableMap(
                         filter -> filter.columnName,
-                        filter -> ((ClpMySqlMetadataProviderSpecificOptions) filter.metadataProviderSpecific).rangeMapping))
+                        filter -> ((ClpMySqlCustomMetadataFilterOptions) filter.customOptions).rangeMapping))
                 : ImmutableMap.of();
     }
 
@@ -120,8 +120,8 @@ private Map<String, ClpMySqlMetadataProviderSpecificOptions.RangeMapping> getAll
      *   </li>
      * </ul>
      */
-    protected static class ClpMySqlMetadataProviderSpecificOptions
-            implements MetadataProviderSpecificOptions
+    protected static class ClpMySqlCustomMetadataFilterOptions
+            implements CustomMetadataFilterOptions
     {
         @JsonProperty("rangeMapping")
         public RangeMapping rangeMapping;

presto-clp/src/test/resources/test-mysql-metadata-filter.json

@@ -12,7 +12,7 @@
   "clp.default.table_1": [
       {
         "columnName": "msg.timestamp",
-        "metadataProviderSpecific": {
+        "customOptions": {
           "rangeMapping": {
             "lowerBound": "begin_timestamp",
             "upperBound": "end_timestamp"