/*
 * 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.spark.sql.sources.v2.writer;

import org.apache.spark.annotation.Experimental;
import org.apache.spark.annotation.InterfaceStability;
import org.apache.spark.sql.Row;
import org.apache.spark.sql.catalyst.InternalRow;

/**
 * A mix-in interface for {@link DataSourceV2Writer}. Data source writers can implement this
 * interface to write {@link InternalRow} directly and avoid the row conversion at Spark side.
 * This is an experimental and unstable interface, as {@link InternalRow} is not public and may get
 * changed in the future Spark versions.
 */

@InterfaceStability.Evolving
@Experimental
@InterfaceStability.Unstable
public interface SupportsWriteInternalRow extends DataSourceV2Writer {

  @Override
  default DataWriterFactory<Row> createWriterFactory() {
    throw new IllegalStateException(
      "createWriterFactory should not be called with SupportsWriteInternalRow.");
  }

  DataWriterFactory<InternalRow> createInternalRowWriterFactory();
}
