|
| 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 | +package org.apache.calcite.util; |
| 18 | + |
| 19 | +import org.apache.calcite.config.CalciteConnectionConfig; |
| 20 | +import org.apache.calcite.jdbc.CalciteConnection; |
| 21 | +import org.apache.calcite.plan.RelOptPlanner; |
| 22 | +import org.apache.calcite.plan.hep.HepPlanner; |
| 23 | +import org.apache.calcite.plan.visualizer.RuleMatchVisualizer; |
| 24 | +import org.apache.calcite.runtime.Hook; |
| 25 | + |
| 26 | +import java.io.File; |
| 27 | +import java.sql.Connection; |
| 28 | +import java.sql.SQLException; |
| 29 | +import java.util.HashMap; |
| 30 | +import java.util.Locale; |
| 31 | +import java.util.Map; |
| 32 | +import java.util.concurrent.atomic.AtomicInteger; |
| 33 | +import java.util.function.Consumer; |
| 34 | + |
| 35 | +/** |
| 36 | + * Utility class to enable RuleMatchVisualizer for Calcite connections. |
| 37 | + * |
| 38 | + * <p>This class provides hooks to automatically attach a RuleMatchVisualizer |
| 39 | + * to planners when a connection specifies the ruleVisualizerDir property. |
| 40 | + * |
| 41 | + * <p>Usage in JDBC URL: |
| 42 | + * <blockquote><pre> |
| 43 | + * jdbc:calcite:ruleVisualizerDir=/tmp/calcite-viz |
| 44 | + * </pre></blockquote> |
| 45 | + * |
| 46 | + * <p>Or programmatically: |
| 47 | + * <blockquote><pre> |
| 48 | + * RuleMatchVisualizerHook.enable("/tmp/calcite-viz"); |
| 49 | + * </pre></blockquote> |
| 50 | + */ |
| 51 | +public class RuleMatchVisualizerHook { |
| 52 | + |
| 53 | + private static final Map<RelOptPlanner, RuleMatchVisualizer> VISUALIZERS = new HashMap<>(); |
| 54 | + private static final AtomicInteger QUERY_COUNTER = new AtomicInteger(0); |
| 55 | + private static String visualizerDir = null; |
| 56 | + private static Hook.Closeable hookCloseable = null; |
| 57 | + |
| 58 | + /** Private constructor to prevent instantiation. */ |
| 59 | + private RuleMatchVisualizerHook() {} |
| 60 | + |
| 61 | + /** |
| 62 | + * Enables the visualizer for all subsequent queries with the specified output directory. |
| 63 | + * |
| 64 | + * @param outputDir Directory where visualization files will be created |
| 65 | + */ |
| 66 | + public static synchronized void enable(String outputDir) { |
| 67 | + if (hookCloseable != null) { |
| 68 | + hookCloseable.close(); |
| 69 | + } |
| 70 | + |
| 71 | + visualizerDir = outputDir; |
| 72 | + |
| 73 | + // Ensure the output directory exists |
| 74 | + File dir = new File(outputDir); |
| 75 | + if (!dir.exists()) { |
| 76 | + dir.mkdirs(); |
| 77 | + } |
| 78 | + |
| 79 | + // Install the hook |
| 80 | + hookCloseable = Hook.PLANNER.addThread((Consumer<RelOptPlanner>) planner -> { |
| 81 | + attachVisualizer(planner, outputDir); |
| 82 | + }); |
| 83 | + } |
| 84 | + |
| 85 | + /** |
| 86 | + * Enables the visualizer using the connection's configuration. |
| 87 | + * This method checks if the connection has the ruleVisualizerDir property set. |
| 88 | + * |
| 89 | + * @param connection The Calcite connection |
| 90 | + * @throws SQLException if there's an error accessing the connection |
| 91 | + */ |
| 92 | + public static synchronized void enableFromConnection(Connection connection) |
| 93 | + throws SQLException { |
| 94 | + if (connection instanceof CalciteConnection) { |
| 95 | + CalciteConnection calciteConn = (CalciteConnection) connection; |
| 96 | + CalciteConnectionConfig config = calciteConn.config(); |
| 97 | + String vizDir = config.ruleVisualizerDir(); |
| 98 | + |
| 99 | + if (vizDir != null && !vizDir.isEmpty()) { |
| 100 | + enable(vizDir); |
| 101 | + } |
| 102 | + } |
| 103 | + } |
| 104 | + |
| 105 | + /** |
| 106 | + * Disables the visualizer. |
| 107 | + */ |
| 108 | + public static synchronized void disable() { |
| 109 | + if (hookCloseable != null) { |
| 110 | + hookCloseable.close(); |
| 111 | + hookCloseable = null; |
| 112 | + } |
| 113 | + visualizerDir = null; |
| 114 | + |
| 115 | + // Write any pending visualizations |
| 116 | + for (RuleMatchVisualizer viz : VISUALIZERS.values()) { |
| 117 | + viz.writeToFile(); |
| 118 | + } |
| 119 | + VISUALIZERS.clear(); |
| 120 | + } |
| 121 | + |
| 122 | + /** |
| 123 | + * Attaches a visualizer to the given planner. |
| 124 | + */ |
| 125 | + private static void attachVisualizer(RelOptPlanner planner, String outputDir) { |
| 126 | + if (planner == null || outputDir == null) { |
| 127 | + return; |
| 128 | + } |
| 129 | + |
| 130 | + // Check if we've already attached a visualizer to this planner |
| 131 | + if (VISUALIZERS.containsKey(planner)) { |
| 132 | + return; |
| 133 | + } |
| 134 | + |
| 135 | + int queryNum = QUERY_COUNTER.incrementAndGet(); |
| 136 | + String suffix = String.format(Locale.ROOT, "query_%d", queryNum); |
| 137 | + |
| 138 | + // Create and attach the visualizer |
| 139 | + RuleMatchVisualizer visualizer = new RuleMatchVisualizer(outputDir, suffix); |
| 140 | + visualizer.attachTo(planner); |
| 141 | + VISUALIZERS.put(planner, visualizer); |
| 142 | + |
| 143 | + // For HepPlanner, we need to manually write the output |
| 144 | + if (planner instanceof HepPlanner) { |
| 145 | + // Add a hook to write the visualization after the planner finishes |
| 146 | + Hook.PLAN_BEFORE_IMPLEMENTATION.addThread(relRoot -> { |
| 147 | + RuleMatchVisualizer viz = VISUALIZERS.get(planner); |
| 148 | + if (viz != null) { |
| 149 | + viz.writeToFile(); |
| 150 | + VISUALIZERS.remove(planner); |
| 151 | + } |
| 152 | + }); |
| 153 | + } |
| 154 | + // VolcanoPlanner automatically calls writeToFile() when done |
| 155 | + |
| 156 | + System.out.println("RuleMatchVisualizer enabled: Output will be written to " |
| 157 | + + outputDir + File.separator + suffix + "*"); |
| 158 | + } |
| 159 | + |
| 160 | + /** |
| 161 | + * Checks the system property and enables visualization if set. |
| 162 | + * This can be called at application startup. |
| 163 | + */ |
| 164 | + public static void checkSystemProperty() { |
| 165 | + String vizDir = System.getProperty("calcite.visualizer.dir"); |
| 166 | + if (vizDir != null && !vizDir.isEmpty()) { |
| 167 | + enable(vizDir); |
| 168 | + } |
| 169 | + } |
| 170 | +} |
0 commit comments