/*
 * 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.iotdb.db.qp.physical.crud;

import org.apache.iotdb.db.exception.query.QueryProcessException;
import org.apache.iotdb.db.query.udf.core.context.UDFContext;

import java.util.List;

/**
 * UDF execution plan.
 *
 * <p>The life cycle of an executor:
 *
 * <p>constructUdfExecutors -> initializeUdfExecutor -> finalizeUDFExecutors
 */
public interface UDFPlan {

  /**
   * Build the execution plan of the executors. This method will not create any UDF instances, nor
   * will it execute user-defined logic.
   */
  void constructUdfExecutors(List<UDFContext> udfContexts);

  /** Allocate computing resources, create UDF instances, and call UDF initialization methods. */
  void initializeUdfExecutors(long queryId, float collectorMemoryBudgetInMb)
      throws QueryProcessException;

  /** Call UDF finalization methods and release computing resources. */
  void finalizeUDFExecutors(long queryId);
}