Packages

final class SqlCommand extends GeneratedMessageV3 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, GeneratedMessageV3, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SqlCommand
  2. SqlCommandOrBuilder
  3. GeneratedMessageV3
  4. Serializable
  5. AbstractMessage
  6. Message
  7. MessageOrBuilder
  8. AbstractMessageLite
  9. MessageLite
  10. MessageLiteOrBuilder
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. 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;

    Definition Classes
    SqlCommand → SqlCommandOrBuilder
    Annotations
    @Override()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(obj: AnyRef): Boolean
    Definition Classes
    SqlCommand → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  11. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  12. 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;

    Definition Classes
    SqlCommand → SqlCommandOrBuilder
  13. 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;

    Definition Classes
    SqlCommand → SqlCommandOrBuilder
    Annotations
    @Override()
  14. 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;

    Definition Classes
    SqlCommand → SqlCommandOrBuilder
    Annotations
    @Override()
  15. 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;

    Definition Classes
    SqlCommand → SqlCommandOrBuilder
    Annotations
    @Override()
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def getDefaultInstanceForType(): SqlCommand
    Definition Classes
    SqlCommand → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  18. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  19. def getField(field: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  20. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  21. def getOneofFieldDescriptor(oneof: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  22. def getParserForType(): Parser[SqlCommand]
    Definition Classes
    SqlCommand → GeneratedMessageV3 → Message → MessageLite
    Annotations
    @Override()
  23. 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;

    Definition Classes
    SqlCommand → SqlCommandOrBuilder
    Annotations
    @Override()
  24. 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;

    Definition Classes
    SqlCommand → SqlCommandOrBuilder
    Annotations
    @Override()
  25. 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;

    Definition Classes
    SqlCommand → SqlCommandOrBuilder
    Annotations
    @Override()
  26. 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;

    Definition Classes
    SqlCommand → SqlCommandOrBuilder
    Annotations
    @Override()
  27. 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;

    Definition Classes
    SqlCommand → SqlCommandOrBuilder
    Annotations
    @Override()
  28. def getRepeatedField(field: FieldDescriptor, index: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  29. def getRepeatedFieldCount(field: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  30. def getSerializedSize(): Int
    Definition Classes
    SqlCommand → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  31. def getSql(): String

    (Required) SQL Query.


    (Required) SQL Query.

    string sql = 1;

    returns

    The sql.

    Definition Classes
    SqlCommand → SqlCommandOrBuilder
    Annotations
    @Override()
  32. def getSqlBytes(): ByteString

    (Required) SQL Query.


    (Required) SQL Query.

    string sql = 1;

    returns

    The bytes for sql.

    Definition Classes
    SqlCommand → SqlCommandOrBuilder
    Annotations
    @Override()
  33. def getUnknownFields(): UnknownFieldSet
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  34. def hasField(field: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  35. def hasOneof(oneof: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  36. def hashCode(): Int
    Definition Classes
    SqlCommand → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  37. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[proto]
    Definition Classes
    SqlCommand → GeneratedMessageV3
    Annotations
    @Override()
  38. def internalGetMapField(number: Int): MapField
    Attributes
    protected[proto]
    Definition Classes
    SqlCommand → GeneratedMessageV3
    Annotations
    @SuppressWarnings() @Override()
  39. final def isInitialized(): Boolean
    Definition Classes
    SqlCommand → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  40. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  41. def makeExtensionsImmutable(): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  42. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  43. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[proto]
    Definition Classes
    SqlCommand → GeneratedMessageV3
    Annotations
    @Override()
  44. def newBuilderForType(): Builder
    Definition Classes
    SqlCommand → Message → MessageLite
    Annotations
    @Override()
  45. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3 → AbstractMessage
  46. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[proto]
    Definition Classes
    SqlCommand → GeneratedMessageV3
    Annotations
    @Override() @SuppressWarnings()
  47. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  48. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  49. def parseUnknownField(input: CodedInputStream, unknownFields: Builder, extensionRegistry: ExtensionRegistryLite, tag: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  50. def parseUnknownFieldProto3(input: CodedInputStream, unknownFields: Builder, extensionRegistry: ExtensionRegistryLite, tag: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  51. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  52. def toBuilder(): Builder
    Definition Classes
    SqlCommand → Message → MessageLite
    Annotations
    @Override()
  53. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  54. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  55. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  56. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  57. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  58. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  59. def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])
  60. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.ObjectStreamException])
  61. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    SqlCommand → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  62. def writeTo(output: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])

Deprecated Value Members

  1. def getArgs(): Map[String, Literal]

    Use #getArgsMap() instead.

    Use #getArgsMap() instead.

    Definition Classes
    SqlCommand → SqlCommandOrBuilder
    Annotations
    @Override() @Deprecated
    Deprecated
  2. def mergeFromAndMakeImmutableInternal(input: CodedInputStream, extensionRegistry: ExtensionRegistryLite): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[com.google.protobuf.InvalidProtocolBufferException]) @Deprecated
    Deprecated

Inherited from SqlCommandOrBuilder

Inherited from GeneratedMessageV3

Inherited from Serializable

Inherited from AbstractMessage

Inherited from Message

Inherited from MessageOrBuilder

Inherited from AbstractMessageLite[MessageType, BuilderType]

Inherited from MessageLite

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped