io.trino.spi.connector.ConnectorSplit Maven / Gradle / Ivy
/*
* 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 com.fasterxml.jackson.annotation.JsonIgnore;
import io.trino.spi.HostAddress;
import io.trino.spi.SplitWeight;
import java.util.List;
import java.util.Map;
public interface ConnectorSplit
{
/**
* Returns true when this ConnectorSplit can be scheduled on any node.
*
* When true, the addresses returned by {@link #getAddresses()} may be used as hints by the scheduler
* during splits assignment.
* When false, the split will always be scheduled on one of the addresses returned by {@link #getAddresses()}.
*/
default boolean isRemotelyAccessible()
{
return true;
}
default List getAddresses()
{
if (!isRemotelyAccessible()) {
throw new IllegalStateException("getAddresses must be implemented when for splits with isRemotelyAccessible=false");
}
return List.of();
}
@JsonIgnore // ConnectorSplit is json-serializable, but we don't want to repeat information in that field
default Map getSplitInfo()
{
return Map.of();
}
default SplitWeight getSplitWeight()
{
return SplitWeight.standard();
}
default long getRetainedSizeInBytes()
{
throw new UnsupportedOperationException("This connector does not provide memory accounting capabilities for ConnectorSplit");
}
}