org.apache.flink.table.client.cli

Class CliClient

java.lang.Object

org.apache.flink.table.client.cli.CliClient

All Implemented Interfaces:

AutoCloseable

public class CliClient
extends Object
implements AutoCloseable

SQL CLI client.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.function.Supplier<org.jline.terminal.Terminal>	DEFAULT_TERMINAL_FACTORY

Constructor Summary

Constructors

Constructor and Description
CliClient(java.util.function.Supplier<org.jline.terminal.Terminal> terminalFactory, String sessionId, Executor executor, Path historyFilePath) Creates a CLI instance with a prepared terminal.
CliClient(java.util.function.Supplier<org.jline.terminal.Terminal> terminalFactory, String sessionId, Executor executor, Path historyFilePath, org.jline.reader.MaskingCallback inputTransformer) Creates a CLI instance with a custom terminal.

Method Summary

Modifier and Type	Method and Description
void	callExplain(ExplainOperation operation)
void	clearTerminal()
void	close() Closes the CLI instance.
void	executeInInteractiveMode() Opens the interactive CLI shell.
boolean	executeInitialization(String content)
void	executeInNonInteractiveMode(String content)
Executor	getExecutor()
int	getHeight()
String	getSessionId()
org.jline.terminal.Terminal	getTerminal()
int	getWidth()
boolean	isPlainTerminal()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TERMINAL_FACTORY

public static final java.util.function.Supplier<org.jline.terminal.Terminal> DEFAULT_TERMINAL_FACTORY

Constructor Detail

CliClient

@VisibleForTesting
public CliClient(java.util.function.Supplier<org.jline.terminal.Terminal> terminalFactory,
                                    String sessionId,
                                    Executor executor,
                                    Path historyFilePath,
                                    @Nullable
                                    org.jline.reader.MaskingCallback inputTransformer)

Creates a CLI instance with a custom terminal. Make sure to close the CLI instance afterwards using close().

CliClient

public CliClient(java.util.function.Supplier<org.jline.terminal.Terminal> terminalFactory,
                 String sessionId,
                 Executor executor,
                 Path historyFilePath)

Creates a CLI instance with a prepared terminal. Make sure to close the CLI instance afterwards using close().

Method Detail

getTerminal

public org.jline.terminal.Terminal getTerminal()

getSessionId

public String getSessionId()

clearTerminal

public void clearTerminal()

isPlainTerminal

public boolean isPlainTerminal()

getWidth

public int getWidth()

getHeight

public int getHeight()

getExecutor

public Executor getExecutor()

close

public void close()

Closes the CLI instance.

Specified by:

close in interface AutoCloseable

executeInInteractiveMode

public void executeInInteractiveMode()

Opens the interactive CLI shell.

executeInNonInteractiveMode

public void executeInNonInteractiveMode(String content)

executeInitialization

public boolean executeInitialization(String content)

callExplain

public void callExplain(ExplainOperation operation)