io.trino.spi.connector.JoinStatistics Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of trino-spi Show documentation

Trino - Service Provider Interface (SPI)

There is a newer version: 458

/*
 * Licensed 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 io.trino.spi.connector;

import java.util.List;
import java.util.Map;
import java.util.Optional;

/**
 * Represents estimated statistics for join node and left and right table
 * passed to {@link ConnectorMetadata#applyJoin(ConnectorSession, JoinType, ConnectorTableHandle, ConnectorTableHandle, List, Map, Map, JoinStatistics)}
 */
public interface JoinStatistics
{
    /**
     * Estimated statistics for left join table.
     */
    Optional getLeftStatistics();

    /**
     * Estimated statistics for right join table.
     */
    Optional getRightStatistics();

    /**
     * Estimated statistics for join result.
     */
    Optional getJoinStatistics();
}