SqlCommand

final class SqlCommand extends GeneratedMessage with SqlCommandOrBuilder

A SQL Command is used to trigger the eager evaluation of SQL commands in Spark.

When the SQL provide as part of the message is a command it will be immediately evaluated
and the result will be collected and returned as part of a LocalRelation. If the result is
not a command, the operation will simply return a SQL Relation. This allows the client to be
almost oblivious to the server-side behavior.

Protobuf type spark.connect.SqlCommand

Linear Supertypes

SqlCommandOrBuilder, GeneratedMessage, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

SqlCommand
SqlCommandOrBuilder
GeneratedMessage
Serializable
AbstractMessage
Message
MessageOrBuilder
AbstractMessageLite
MessageLite
MessageLiteOrBuilder
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(obj: AnyRef): Boolean
Definition Classes
SqlCommand → AbstractMessage → Message → AnyRef → Any
Annotations
@Override()
def findInitializationErrors(): List[String]
Definition Classes
AbstractMessage → MessageOrBuilder
def getAllFields(): Map[FieldDescriptor, AnyRef]
Definition Classes
GeneratedMessage → MessageOrBuilder
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
def getDefaultInstanceForType(): SqlCommand
Definition Classes
SqlCommand → MessageOrBuilder → MessageLiteOrBuilder
Annotations
@Override()
def getDescriptorForType(): Descriptor
Definition Classes
GeneratedMessage → MessageOrBuilder
def getField(field: FieldDescriptor): AnyRef
Definition Classes
GeneratedMessage → MessageOrBuilder
def getInitializationErrorString(): String
Definition Classes
AbstractMessage → MessageOrBuilder
def getInput(): Relation
```
(Optional) The relation that this SQL command will be built on.
```
```
(Optional) The relation that this SQL command will be built on.
```
.spark.connect.Relation input = 6;
returns
The input.
Definition Classes
SqlCommand → SqlCommandOrBuilder
Annotations
@Override()
def getInputOrBuilder(): RelationOrBuilder
```
(Optional) The relation that this SQL command will be built on.
```
```
(Optional) The relation that this SQL command will be built on.
```
.spark.connect.Relation input = 6;
Definition Classes
SqlCommand → SqlCommandOrBuilder
Annotations
@Override()
def getOneofFieldDescriptor(oneof: OneofDescriptor): FieldDescriptor
Definition Classes
GeneratedMessage → AbstractMessage → MessageOrBuilder
def getParserForType(): Parser[SqlCommand]
Definition Classes
SqlCommand → GeneratedMessage → Message → MessageLite
Annotations
@Override()
def getRepeatedField(field: FieldDescriptor, index: Int): AnyRef
Definition Classes
GeneratedMessage → MessageOrBuilder
def getRepeatedFieldCount(field: FieldDescriptor): Int
Definition Classes
GeneratedMessage → MessageOrBuilder
def getSerializedSize(): Int
Definition Classes
SqlCommand → GeneratedMessage → AbstractMessage → MessageLite
Annotations
@Override()
def getUnknownFields(): UnknownFieldSet
Definition Classes
GeneratedMessage → MessageOrBuilder
def hasField(field: FieldDescriptor): Boolean
Definition Classes
GeneratedMessage → MessageOrBuilder
def hasInput(): Boolean
```
(Optional) The relation that this SQL command will be built on.
```
```
(Optional) The relation that this SQL command will be built on.
```
.spark.connect.Relation input = 6;
returns
Whether the input field is set.
Definition Classes
SqlCommand → SqlCommandOrBuilder
Annotations
@Override()
def hasOneof(oneof: OneofDescriptor): Boolean
Definition Classes
GeneratedMessage → AbstractMessage → MessageOrBuilder
def hashCode(): Int
Definition Classes
SqlCommand → AbstractMessage → Message → AnyRef → Any
Annotations
@Override()
def internalGetFieldAccessorTable(): FieldAccessorTable
Attributes
protected[proto]
Definition Classes
SqlCommand → GeneratedMessage
Annotations
@Override()
def internalGetMapFieldReflection(number: Int): MapFieldReflectionAccessor
Attributes
protected[proto]
Definition Classes
SqlCommand → GeneratedMessage
Annotations
@SuppressWarnings() @Override()
final def isInitialized(): Boolean
Definition Classes
SqlCommand → GeneratedMessage → AbstractMessage → MessageLiteOrBuilder
Annotations
@Override()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def newBuilderForType(parent: BuilderParent): Builder
Attributes
protected[proto]
Definition Classes
SqlCommand → AbstractMessage
Annotations
@Override()
def newBuilderForType(): Builder
Definition Classes
SqlCommand → Message → MessageLite
Annotations
@Override()
def newInstance(unused: UnusedPrivateParameter): AnyRef
Attributes
protected[protobuf]
Definition Classes
GeneratedMessage
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
def parseUnknownField(input: CodedInputStream, unknownFields: Builder, extensionRegistry: ExtensionRegistryLite, tag: Int): Boolean
Attributes
protected[protobuf]
Definition Classes
GeneratedMessage
Annotations
@throws(classOf[java.io.IOException])
def parseUnknownFieldProto3(input: CodedInputStream, unknownFields: Builder, extensionRegistry: ExtensionRegistryLite, tag: Int): Boolean
Attributes
protected[protobuf]
Definition Classes
GeneratedMessage
Annotations
@throws(classOf[java.io.IOException])
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toBuilder(): Builder
Definition Classes
SqlCommand → Message → MessageLite
Annotations
@Override()
def toByteArray(): Array[Byte]
Definition Classes
AbstractMessageLite → MessageLite
def toByteString(): ByteString
Definition Classes
AbstractMessageLite → MessageLite
final def toString(): String
Definition Classes
AbstractMessage → Message → AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
def writeDelimitedTo(output: OutputStream): Unit
Definition Classes
AbstractMessageLite → MessageLite
Annotations
@throws(classOf[java.io.IOException])
def writeReplace(): AnyRef
Attributes
protected[protobuf]
Definition Classes
GeneratedMessage
Annotations
@throws(classOf[java.io.ObjectStreamException])
def writeTo(output: CodedOutputStream): Unit
Definition Classes
SqlCommand → GeneratedMessage → AbstractMessage → MessageLite
Annotations
@Override()
def writeTo(output: OutputStream): Unit
Definition Classes
AbstractMessageLite → MessageLite
Annotations
@throws(classOf[java.io.IOException])

Deprecated Value Members

def containsArgs(key: String): Boolean
```
(Optional) A map of parameter names to literal expressions.
```
```
(Optional) A map of parameter names to literal expressions.
```
map<string, .spark.connect.Expression.Literal> args = 2 [deprecated = true];
Definition Classes
SqlCommand → SqlCommandOrBuilder
Annotations
@Override() @Deprecated
Deprecated
def containsNamedArguments(key: String): Boolean
```
(Optional) A map of parameter names to expressions.
It cannot coexist with `pos_arguments`.
```
```
(Optional) A map of parameter names to expressions.
It cannot coexist with `pos_arguments`.
```
map<string, .spark.connect.Expression> named_arguments = 4 [deprecated = true];
Definition Classes
SqlCommand → SqlCommandOrBuilder
Annotations
@Override() @Deprecated
Deprecated
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated
(Since version 9)
def getArgs(): Map[String, Literal]
Use #getArgsMap() instead.
Use #getArgsMap() instead.
Definition Classes
SqlCommand → SqlCommandOrBuilder
Annotations
@Override() @Deprecated
Deprecated
def getArgsCount(): Int
```
(Optional) A map of parameter names to literal expressions.
```
```
(Optional) A map of parameter names to literal expressions.
```
map<string, .spark.connect.Expression.Literal> args = 2 [deprecated = true];
Definition Classes
SqlCommand → SqlCommandOrBuilder
Annotations
@Deprecated
Deprecated
def getArgsMap(): Map[String, Literal]
```
(Optional) A map of parameter names to literal expressions.
```
```
(Optional) A map of parameter names to literal expressions.
```
map<string, .spark.connect.Expression.Literal> args = 2 [deprecated = true];
Definition Classes
SqlCommand → SqlCommandOrBuilder
Annotations
@Override() @Deprecated
Deprecated
def getArgsOrDefault(key: String, defaultValue: Literal): Literal
```
(Optional) A map of parameter names to literal expressions.
```
```
(Optional) A map of parameter names to literal expressions.
```
map<string, .spark.connect.Expression.Literal> args = 2 [deprecated = true];
Definition Classes
SqlCommand → SqlCommandOrBuilder
Annotations
@Override() @Deprecated
Deprecated
def getArgsOrThrow(key: String): Literal
```
(Optional) A map of parameter names to literal expressions.
```
```
(Optional) A map of parameter names to literal expressions.
```
map<string, .spark.connect.Expression.Literal> args = 2 [deprecated = true];
Definition Classes
SqlCommand → SqlCommandOrBuilder
Annotations
@Override() @Deprecated
Deprecated
def getNamedArguments(): Map[String, Expression]
Use #getNamedArgumentsMap() instead.
Use #getNamedArgumentsMap() instead.
Definition Classes
SqlCommand → SqlCommandOrBuilder
Annotations
@Override() @Deprecated
Deprecated
def getNamedArgumentsCount(): Int
```
(Optional) A map of parameter names to expressions.
It cannot coexist with `pos_arguments`.
```
```
(Optional) A map of parameter names to expressions.
It cannot coexist with `pos_arguments`.
```
map<string, .spark.connect.Expression> named_arguments = 4 [deprecated = true];
Definition Classes
SqlCommand → SqlCommandOrBuilder
Annotations
@Deprecated
Deprecated
def getNamedArgumentsMap(): Map[String, Expression]
```
(Optional) A map of parameter names to expressions.
It cannot coexist with `pos_arguments`.
```
```
(Optional) A map of parameter names to expressions.
It cannot coexist with `pos_arguments`.
```
map<string, .spark.connect.Expression> named_arguments = 4 [deprecated = true];
Definition Classes
SqlCommand → SqlCommandOrBuilder
Annotations
@Override() @Deprecated
Deprecated
def getNamedArgumentsOrDefault(key: String, defaultValue: Expression): Expression
```
(Optional) A map of parameter names to expressions.
It cannot coexist with `pos_arguments`.
```
```
(Optional) A map of parameter names to expressions.
It cannot coexist with `pos_arguments`.
```
map<string, .spark.connect.Expression> named_arguments = 4 [deprecated = true];
Definition Classes
SqlCommand → SqlCommandOrBuilder
Annotations
@Override() @Deprecated
Deprecated
def getNamedArgumentsOrThrow(key: String): Expression
```
(Optional) A map of parameter names to expressions.
It cannot coexist with `pos_arguments`.
```
```
(Optional) A map of parameter names to expressions.
It cannot coexist with `pos_arguments`.
```
map<string, .spark.connect.Expression> named_arguments = 4 [deprecated = true];
Definition Classes
SqlCommand → SqlCommandOrBuilder
Annotations
@Override() @Deprecated
Deprecated
def getPosArgs(index: Int): Literal
```
(Optional) A sequence of literal expressions for positional parameters in the SQL query text.
```
```
(Optional) A sequence of literal expressions for positional parameters in the SQL query text.
```
repeated .spark.connect.Expression.Literal pos_args = 3 [deprecated = true];
Definition Classes
SqlCommand → SqlCommandOrBuilder
Annotations
@Override() @Deprecated
Deprecated
def getPosArgsCount(): Int
```
(Optional) A sequence of literal expressions for positional parameters in the SQL query text.
```
```
(Optional) A sequence of literal expressions for positional parameters in the SQL query text.
```
repeated .spark.connect.Expression.Literal pos_args = 3 [deprecated = true];
Definition Classes
SqlCommand → SqlCommandOrBuilder
Annotations
@Override() @Deprecated
Deprecated
def getPosArgsList(): List[Literal]
```
(Optional) A sequence of literal expressions for positional parameters in the SQL query text.
```
```
(Optional) A sequence of literal expressions for positional parameters in the SQL query text.
```
repeated .spark.connect.Expression.Literal pos_args = 3 [deprecated = true];
Definition Classes
SqlCommand → SqlCommandOrBuilder
Annotations
@Override() @Deprecated
Deprecated
def getPosArgsOrBuilder(index: Int): LiteralOrBuilder
```
(Optional) A sequence of literal expressions for positional parameters in the SQL query text.
```
```
(Optional) A sequence of literal expressions for positional parameters in the SQL query text.
```
repeated .spark.connect.Expression.Literal pos_args = 3 [deprecated = true];
Definition Classes
SqlCommand → SqlCommandOrBuilder
Annotations
@Override() @Deprecated
Deprecated
def getPosArgsOrBuilderList(): List[_ <: LiteralOrBuilder]
```
(Optional) A sequence of literal expressions for positional parameters in the SQL query text.
```
```
(Optional) A sequence of literal expressions for positional parameters in the SQL query text.
```
repeated .spark.connect.Expression.Literal pos_args = 3 [deprecated = true];
Definition Classes
SqlCommand → SqlCommandOrBuilder
Annotations
@Override() @Deprecated
Deprecated

def getPosArguments(index: Int): Expression

(Optional) A sequence of expressions for positional parameters in the SQL query text.
It cannot coexist with `named_arguments`.

(Optional) A sequence of expressions for positional parameters in the SQL query text.
It cannot coexist with `named_arguments`.