org.apache.flink.client

Class LocalExecutor

java.lang.Object

org.apache.flink.api.common.PlanExecutor

org.apache.flink.client.LocalExecutor

public class LocalExecutor
extends PlanExecutor

A PlanExecutor that runs Flink programs on a local embedded Flink runtime instance.

By simply calling the executePlan(org.apache.flink.api.common.Plan) method, this executor still start up and shut down again immediately after the program finished.

To use this executor to execute many dataflow programs that constitute one job together, then this executor needs to be explicitly started, to keep running across several executions.

Constructor Summary

Constructors

Constructor and Description
LocalExecutor()
LocalExecutor(Configuration conf)

Method Summary

Modifier and Type	Method and Description
void	endSession(JobID jobID) Ends the job session, identified by the given JobID.
static JobExecutionResult	execute(Plan plan) Executes the given dataflow plan.
static JobExecutionResult	execute(Program pa, String... args) Executes the given program.
JobExecutionResult	executePlan(Plan plan) Executes the given program on a local runtime and waits for the job to finish.
String	getOptimizerPlanAsJSON(Plan plan) Creates a JSON representation of the given dataflow's execution plan.
static String	getPlanAsJSON(Plan plan) Creates a JSON representation of the given dataflow plan.
int	getTaskManagerNumSlots()
boolean	isDefaultOverwriteFiles()
boolean	isRunning() Checks if this executor is currently running.
static String	optimizerPlanAsJSON(Plan plan) Creates a JSON representation of the given dataflow's execution plan.
void	setDefaultOverwriteFiles(boolean defaultOverwriteFiles)
void	setTaskManagerNumSlots(int taskManagerNumSlots)
void	start() Starts the program executor.
void	stop() Shuts down the plan executor and releases all local resources.

Methods inherited from class org.apache.flink.api.common.PlanExecutor

createLocalExecutor, createRemoteExecutor, isPrintingStatusDuringExecution, setPrintStatusDuringExecution

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LocalExecutor

public LocalExecutor()

LocalExecutor

public LocalExecutor(Configuration conf)

Method Detail

isDefaultOverwriteFiles

public boolean isDefaultOverwriteFiles()

setDefaultOverwriteFiles

public void setDefaultOverwriteFiles(boolean defaultOverwriteFiles)

setTaskManagerNumSlots

public void setTaskManagerNumSlots(int taskManagerNumSlots)

getTaskManagerNumSlots

public int getTaskManagerNumSlots()

start

public void start()
           throws Exception

Description copied from class: PlanExecutor

Starts the program executor. After the executor has been started, it will keep running until PlanExecutor.stop() is called.

Specified by:

start in class PlanExecutor

Throws:

Exception - Thrown, if the executor startup failed.

stop

public void stop()
          throws Exception

Description copied from class: PlanExecutor

Shuts down the plan executor and releases all local resources.

This method also ends all sessions created by this executor. Remote job executions may complete, but the session is not kept alive after that.

Specified by:

stop in class PlanExecutor

Throws:

Exception - Thrown, if the proper shutdown failed.

isRunning

public boolean isRunning()

Description copied from class: PlanExecutor

Checks if this executor is currently running.

Specified by:

isRunning in class PlanExecutor

Returns:

True is the executor is running, false otherwise.

executePlan

public JobExecutionResult executePlan(Plan plan)
                               throws Exception

Executes the given program on a local runtime and waits for the job to finish.

If the executor has not been started before, this starts the executor and shuts it down after the job finished. If the job runs in session mode, the executor is kept alive until no more references to the executor exist.

Specified by:

executePlan in class PlanExecutor

Parameters:

plan - The plan of the program to execute.

Returns:

The net runtime of the program, in milliseconds.

Throws:

Exception - Thrown, if either the startup of the local execution context, or the execution caused an exception.

getOptimizerPlanAsJSON

public String getOptimizerPlanAsJSON(Plan plan)
                              throws Exception

Creates a JSON representation of the given dataflow's execution plan.

Specified by:

getOptimizerPlanAsJSON in class PlanExecutor

Parameters:

plan - The dataflow plan.

Returns:

The dataflow's execution plan, as a JSON string.

Throws:

Exception - Thrown, if the optimization process that creates the execution plan failed.

endSession

public void endSession(JobID jobID)
                throws Exception

Description copied from class: PlanExecutor

Ends the job session, identified by the given JobID. Jobs can be kept around as sessions, if a session timeout is specified. Keeping Jobs as sessions allows users to incrementally add new operations to their dataflow, that refer to previous intermediate results of the dataflow.

Specified by:

endSession in class PlanExecutor

Parameters:

jobID - The JobID identifying the job session.

Throws:

Exception - Thrown, if the message to finish the session cannot be delivered.

execute

public static JobExecutionResult execute(Program pa,
                                         String... args)
                                  throws Exception

Executes the given program.

Parameters:

pa - The program.

args - The parameters.

Returns:

The execution result of the program.

Throws:

Exception - Thrown, if either the startup of the local execution context, or the execution caused an exception.

execute

public static JobExecutionResult execute(Plan plan)
                                  throws Exception

Executes the given dataflow plan.

Parameters:

plan - The dataflow plan.

Returns:

The execution result.

Throws:

Exception - Thrown, if either the startup of the local execution context, or the execution caused an exception.

optimizerPlanAsJSON

public static String optimizerPlanAsJSON(Plan plan)
                                  throws Exception

Creates a JSON representation of the given dataflow's execution plan.

Parameters:

plan - The dataflow plan.

Returns:

The dataflow's execution plan, as a JSON string.

Throws:

Exception - Thrown, if the optimization process that creates the execution plan failed.

getPlanAsJSON

public static String getPlanAsJSON(Plan plan)

Creates a JSON representation of the given dataflow plan.

Parameters:

plan - The dataflow plan.

Returns:

The dataflow plan (prior to optimization) as a JSON string.