io.trino.spi.connector.TableProcedureExecutionMode 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;

public final class TableProcedureExecutionMode
{
    private final boolean readsData;
    private final boolean supportsFilter;

    private TableProcedureExecutionMode(boolean readsData, boolean supportsFilter)
    {
        if (!readsData) {
            if (supportsFilter) {
                throw new IllegalArgumentException("filtering not supported if table data is not processed");
            }
        }
        this.readsData = readsData;
        this.supportsFilter = supportsFilter;
    }

    public boolean isReadsData()
    {
        return readsData;
    }

    public boolean supportsFilter()
    {
        return supportsFilter;
    }

    /**
     * Table procedure that does not read any table data and only executes on the coordinator.
     * Such procedures are useful for custom DDL-type operations.
     */
    public static TableProcedureExecutionMode coordinatorOnly()
    {
        return new TableProcedureExecutionMode(false, false);
    }

    public static TableProcedureExecutionMode distributedWithFilteringAndRepartitioning()
    {
        return new TableProcedureExecutionMode(true, true);
    }
}