org.apache.spark.sql.connector

Interface ExternalCommandRunner

@Unstable
public interface ExternalCommandRunner

An interface to execute an arbitrary string command inside an external execution engine rather than Spark. This could be useful when user wants to execute some commands out of Spark. For example, executing custom DDL/DML command for JDBC, creating index for ElasticSearch, creating cores for Solr and so on.

This interface will be instantiated when end users call `SparkSession#executeCommand`.

Since:

3.0.0

Method Summary

Modifier and Type	Method and Description
String[]	executeCommand(String command, CaseInsensitiveStringMap options) Execute the given command.

Method Detail

executeCommand

String[] executeCommand(String command,
                        CaseInsensitiveStringMap options)

Execute the given command.

Parameters:

command - The command string provided by users.

options - The user-specified case-insensitive options.

Returns:

The output of the command.