Package org.apache.flink.table.api

Class PlanReference

java.lang.Object

org.apache.flink.table.api.PlanReference

Direct Known Subclasses:

PlanReference.ContentPlanReference, PlanReference.FilePlanReference, PlanReference.ResourcePlanReference

@Experimental
public abstract class PlanReference
extends Object

Unresolved pointer to a persisted plan.

A plan represents a static, executable entity that has been compiled from a Table & SQL API pipeline definition.

You can load the content of this reference into a CompiledPlan using TableEnvironment.loadPlan(PlanReference), or you can directly load and execute it with TableEnvironment.executePlan(PlanReference).

See Also:

CompiledPlan

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PlanReference.ContentPlanReference	Plan reference to a string containing the serialized persisted plan in JSON.
static class	PlanReference.FilePlanReference	Plan reference to a file in the local filesystem.
static class	PlanReference.ResourcePlanReference	Plan reference to a file in the provided ClassLoader.

Method Summary

Modifier and Type	Method	Description
static PlanReference	fromFile(File file)	Create a reference starting from a file path.
static PlanReference	fromFile(String path)
static PlanReference	fromFile(Path path)
static PlanReference	fromJsonString(String jsonString)	Create a reference starting from a JSON string.
static PlanReference	fromResource(ClassLoader classLoader, String resourcePath)	Create a reference from a file in the classpath.
static PlanReference	fromResource(String resourcePath)	Create a reference from a file in the classpath, using Thread.currentThread().getContextClassLoader() as ClassLoader.

Methods inherited from class java.lang.Object

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

Method Detail

fromFile

public static PlanReference fromFile(String path)

See Also:

fromFile(File)

fromFile

public static PlanReference fromFile(Path path)

See Also:

fromFile(File)

fromFile

public static PlanReference fromFile(File file)

Create a reference starting from a file path.

fromJsonString

public static PlanReference fromJsonString(String jsonString)

Create a reference starting from a JSON string.

fromResource

public static PlanReference fromResource(String resourcePath)

Create a reference from a file in the classpath, using Thread.currentThread().getContextClassLoader() as ClassLoader.

fromResource

public static PlanReference fromResource(ClassLoader classLoader,
                                         String resourcePath)

Create a reference from a file in the classpath.