org.apache.phoenix.jdbc.PhoenixMonitoredConnection Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of phoenix-server-hbase-2.6

Phoenix HBase Server Side JAR

The newest version!

/*
 * 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.phoenix.jdbc;

import org.apache.phoenix.monitoring.MetricType;

import java.sql.Connection;
import java.util.Map;

/**
 * This interface is for phoenix connections that provide metrics to PhoenixRuntime
 */
public interface PhoenixMonitoredConnection extends Connection {
    /**
     * @return map of Table Name String to a Map of Metric Type to current value for mutations
     */
    Map> getMutationMetrics();

    /**
     * @return map of Table Name String to a Map of Metric Type to current value for reads
     */
    Map> getReadMetrics();

    /**
     * @return true if request metrics are enabled false otherwise
     */
    boolean isRequestLevelMetricsEnabled();

    /**
     * Clears the local metrics values by setting them back to 0.  Useful for multistatement connections and extracting
     * metrics for individual DML.
     */
    void clearMetrics();

}