Package io.substrait.proto

Class WriteRel

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.substrait.proto.WriteRel
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, WriteRelOrBuilder, Serializable
public final class WriteRel extends com.google.protobuf.GeneratedMessageV3 implements WriteRelOrBuilder
 The operator that modifies the content of a database (operates on 1 table at a time, but record-selection/source can be
 based on joining of multiple tables).
Protobuf type substrait.WriteRel
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    WriteRel.Builder
    The operator that modifies the content of a database (operates on 1 table at a time, but record-selection/source can be based on joining of multiple tables).
    static enum 
    WriteRel.CreateMode
    Protobuf enum substrait.WriteRel.CreateMode
    static enum 
    WriteRel.OutputMode
    Protobuf enum substrait.WriteRel.OutputMode
    static enum 
    WriteRel.WriteOp
    Protobuf enum substrait.WriteRel.WriteOp
    static enum 
    WriteRel.WriteTypeCase
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ADVANCED_EXTENSION_FIELD_NUMBER
     
    static final int
    COMMON_FIELD_NUMBER
     
    static final int
    CREATE_MODE_FIELD_NUMBER
     
    static final int
    EXTENSION_TABLE_FIELD_NUMBER
     
    static final int
    INPUT_FIELD_NUMBER
     
    static final int
    NAMED_TABLE_FIELD_NUMBER
     
    static final int
    OP_FIELD_NUMBER
     
    static final int
    OUTPUT_FIELD_NUMBER
     
    static final int
    TABLE_SCHEMA_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    AdvancedExtension
    getAdvancedExtension()
    .substrait.extensions.AdvancedExtension advanced_extension = 9;
    AdvancedExtensionOrBuilder
    getAdvancedExtensionOrBuilder()
    .substrait.extensions.AdvancedExtension advanced_extension = 9;
    RelCommon
    getCommon()
    .substrait.RelCommon common = 7;
    RelCommonOrBuilder
    getCommonOrBuilder()
    .substrait.RelCommon common = 7;
    WriteRel.CreateMode
    getCreateMode()
    Used with CTAS to determine what to do if the table already exists
    int
    getCreateModeValue()
    Used with CTAS to determine what to do if the table already exists
    static WriteRel
    getDefaultInstance()
     
    WriteRel
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    ExtensionObject
    getExtensionTable()
    .substrait.ExtensionObject extension_table = 2;
    ExtensionObjectOrBuilder
    getExtensionTableOrBuilder()
    .substrait.ExtensionObject extension_table = 2;
    Rel
    getInput()
    The relation that determines the records to add/remove/modify the schema must match with table_schema.
    RelOrBuilder
    getInputOrBuilder()
    The relation that determines the records to add/remove/modify the schema must match with table_schema.
    NamedObjectWrite
    getNamedTable()
    .substrait.NamedObjectWrite named_table = 1;
    NamedObjectWriteOrBuilder
    getNamedTableOrBuilder()
    .substrait.NamedObjectWrite named_table = 1;
    WriteRel.WriteOp
    getOp()
    The type of operation to perform
    int
    getOpValue()
    The type of operation to perform
    WriteRel.OutputMode
    getOutput()
    Output mode determines what is the output of executing this rel
    int
    getOutputValue()
    Output mode determines what is the output of executing this rel
    com.google.protobuf.Parser<WriteRel>
    getParserForType()
     
    int
    getSerializedSize()
     
    NamedStruct
    getTableSchema()
    The schema of the table (must align with Rel input (e.g., number of leaf fields must match))
    NamedStructOrBuilder
    getTableSchemaOrBuilder()
    The schema of the table (must align with Rel input (e.g., number of leaf fields must match))
    WriteRel.WriteTypeCase
    getWriteTypeCase()
     
    boolean
    hasAdvancedExtension()
    .substrait.extensions.AdvancedExtension advanced_extension = 9;
    boolean
    hasCommon()
    .substrait.RelCommon common = 7;
    boolean
    hasExtensionTable()
    .substrait.ExtensionObject extension_table = 2;
    int
    hashCode()
     
    boolean
    hasInput()
    The relation that determines the records to add/remove/modify the schema must match with table_schema.
    boolean
    hasNamedTable()
    .substrait.NamedObjectWrite named_table = 1;
    boolean
    hasTableSchema()
    The schema of the table (must align with Rel input (e.g., number of leaf fields must match))
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static WriteRel.Builder
    newBuilder()
     
    static WriteRel.Builder
    newBuilder(WriteRel prototype)
     
    WriteRel.Builder
    newBuilderForType()
     
    protected WriteRel.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static WriteRel
    parseDelimitedFrom(InputStream input)
     
    static WriteRel
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WriteRel
    parseFrom(byte[] data)
     
    static WriteRel
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WriteRel
    parseFrom(com.google.protobuf.ByteString data)
     
    static WriteRel
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WriteRel
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static WriteRel
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WriteRel
    parseFrom(InputStream input)
     
    static WriteRel
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WriteRel
    parseFrom(ByteBuffer data)
     
    static WriteRel
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<WriteRel>
    parser()
     
    WriteRel.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • NAMED_TABLE_FIELD_NUMBER

      public static final int NAMED_TABLE_FIELD_NUMBER
      See Also:

    • EXTENSION_TABLE_FIELD_NUMBER

      public static final int EXTENSION_TABLE_FIELD_NUMBER
      See Also:

    • TABLE_SCHEMA_FIELD_NUMBER

      public static final int TABLE_SCHEMA_FIELD_NUMBER
      See Also:

    • OP_FIELD_NUMBER

      public static final int OP_FIELD_NUMBER
      See Also:

    • INPUT_FIELD_NUMBER

      public static final int INPUT_FIELD_NUMBER
      See Also:

    • CREATE_MODE_FIELD_NUMBER

      public static final int CREATE_MODE_FIELD_NUMBER
      See Also:

    • OUTPUT_FIELD_NUMBER

      public static final int OUTPUT_FIELD_NUMBER
      See Also:

    • COMMON_FIELD_NUMBER

      public static final int COMMON_FIELD_NUMBER
      See Also:

    • ADVANCED_EXTENSION_FIELD_NUMBER

      public static final int ADVANCED_EXTENSION_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getWriteTypeCase

      public WriteRel.WriteTypeCase getWriteTypeCase()
      Specified by:
      getWriteTypeCase in interface WriteRelOrBuilder

    • hasNamedTable

      public boolean hasNamedTable()
      .substrait.NamedObjectWrite named_table = 1;
      Specified by:
      hasNamedTable in interface WriteRelOrBuilder
      Returns:
      Whether the namedTable field is set.

    • getNamedTable

      public NamedObjectWrite getNamedTable()
      .substrait.NamedObjectWrite named_table = 1;
      Specified by:
      getNamedTable in interface WriteRelOrBuilder
      Returns:
      The namedTable.

    • getNamedTableOrBuilder

      public NamedObjectWriteOrBuilder getNamedTableOrBuilder()
      .substrait.NamedObjectWrite named_table = 1;
      Specified by:
      getNamedTableOrBuilder in interface WriteRelOrBuilder

    • hasExtensionTable

      public boolean hasExtensionTable()
      .substrait.ExtensionObject extension_table = 2;
      Specified by:
      hasExtensionTable in interface WriteRelOrBuilder
      Returns:
      Whether the extensionTable field is set.

    • getExtensionTable

      public ExtensionObject getExtensionTable()
      .substrait.ExtensionObject extension_table = 2;
      Specified by:
      getExtensionTable in interface WriteRelOrBuilder
      Returns:
      The extensionTable.

    • getExtensionTableOrBuilder

      public ExtensionObjectOrBuilder getExtensionTableOrBuilder()
      .substrait.ExtensionObject extension_table = 2;
      Specified by:
      getExtensionTableOrBuilder in interface WriteRelOrBuilder

    • hasTableSchema

      public boolean hasTableSchema()
       The schema of the table (must align with Rel input (e.g., number of leaf fields must match))
      .substrait.NamedStruct table_schema = 3;
      Specified by:
      hasTableSchema in interface WriteRelOrBuilder
      Returns:
      Whether the tableSchema field is set.

    • getTableSchema

      public NamedStruct getTableSchema()
       The schema of the table (must align with Rel input (e.g., number of leaf fields must match))
      .substrait.NamedStruct table_schema = 3;
      Specified by:
      getTableSchema in interface WriteRelOrBuilder
      Returns:
      The tableSchema.

    • getTableSchemaOrBuilder

      public NamedStructOrBuilder getTableSchemaOrBuilder()
       The schema of the table (must align with Rel input (e.g., number of leaf fields must match))
      .substrait.NamedStruct table_schema = 3;
      Specified by:
      getTableSchemaOrBuilder in interface WriteRelOrBuilder

    • getOpValue

      public int getOpValue()
       The type of operation to perform
      .substrait.WriteRel.WriteOp op = 4;
      Specified by:
      getOpValue in interface WriteRelOrBuilder
      Returns:
      The enum numeric value on the wire for op.

    • getOp

      public WriteRel.WriteOp getOp()
       The type of operation to perform
      .substrait.WriteRel.WriteOp op = 4;
      Specified by:
      getOp in interface WriteRelOrBuilder
      Returns:
      The op.

    • hasInput

      public boolean hasInput()
       The relation that determines the records to add/remove/modify
 the schema must match with table_schema. Default values must be explicitly stated
 in a ProjectRel at the top of the input. The match must also
 occur in case of DELETE to ensure multi-engine plans are unequivocal.
      .substrait.Rel input = 5;
      Specified by:
      hasInput in interface WriteRelOrBuilder
      Returns:
      Whether the input field is set.

    • getInput

      public Rel getInput()
       The relation that determines the records to add/remove/modify
 the schema must match with table_schema. Default values must be explicitly stated
 in a ProjectRel at the top of the input. The match must also
 occur in case of DELETE to ensure multi-engine plans are unequivocal.
      .substrait.Rel input = 5;
      Specified by:
      getInput in interface WriteRelOrBuilder
      Returns:
      The input.

    • getInputOrBuilder

      public RelOrBuilder getInputOrBuilder()
       The relation that determines the records to add/remove/modify
 the schema must match with table_schema. Default values must be explicitly stated
 in a ProjectRel at the top of the input. The match must also
 occur in case of DELETE to ensure multi-engine plans are unequivocal.
      .substrait.Rel input = 5;
      Specified by:
      getInputOrBuilder in interface WriteRelOrBuilder

    • getCreateModeValue

      public int getCreateModeValue()
       Used with CTAS to determine what to do if the table already exists
      .substrait.WriteRel.CreateMode create_mode = 8;
      Specified by:
      getCreateModeValue in interface WriteRelOrBuilder
      Returns:
      The enum numeric value on the wire for createMode.

    • getCreateMode

      public WriteRel.CreateMode getCreateMode()
       Used with CTAS to determine what to do if the table already exists
      .substrait.WriteRel.CreateMode create_mode = 8;
      Specified by:
      getCreateMode in interface WriteRelOrBuilder
      Returns:
      The createMode.

    • getOutputValue

      public int getOutputValue()
       Output mode determines what is the output of executing this rel
      .substrait.WriteRel.OutputMode output = 6;
      Specified by:
      getOutputValue in interface WriteRelOrBuilder
      Returns:
      The enum numeric value on the wire for output.

    • getOutput

      public WriteRel.OutputMode getOutput()
       Output mode determines what is the output of executing this rel
      .substrait.WriteRel.OutputMode output = 6;
      Specified by:
      getOutput in interface WriteRelOrBuilder
      Returns:
      The output.

    • hasCommon

      public boolean hasCommon()
      .substrait.RelCommon common = 7;
      Specified by:
      hasCommon in interface WriteRelOrBuilder
      Returns:
      Whether the common field is set.

    • getCommon

      public RelCommon getCommon()
      .substrait.RelCommon common = 7;
      Specified by:
      getCommon in interface WriteRelOrBuilder
      Returns:
      The common.

    • getCommonOrBuilder

      public RelCommonOrBuilder getCommonOrBuilder()
      .substrait.RelCommon common = 7;
      Specified by:
      getCommonOrBuilder in interface WriteRelOrBuilder

    • hasAdvancedExtension

      public boolean hasAdvancedExtension()
      .substrait.extensions.AdvancedExtension advanced_extension = 9;
      Specified by:
      hasAdvancedExtension in interface WriteRelOrBuilder
      Returns:
      Whether the advancedExtension field is set.

    • getAdvancedExtension

      public AdvancedExtension getAdvancedExtension()
      .substrait.extensions.AdvancedExtension advanced_extension = 9;
      Specified by:
      getAdvancedExtension in interface WriteRelOrBuilder
      Returns:
      The advancedExtension.

    • getAdvancedExtensionOrBuilder

      public AdvancedExtensionOrBuilder getAdvancedExtensionOrBuilder()
      .substrait.extensions.AdvancedExtension advanced_extension = 9;
      Specified by:
      getAdvancedExtensionOrBuilder in interface WriteRelOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static WriteRel parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WriteRel parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WriteRel parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WriteRel parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WriteRel parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WriteRel parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WriteRel parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static WriteRel parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static WriteRel parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static WriteRel parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static WriteRel parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static WriteRel parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public WriteRel.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static WriteRel.Builder newBuilder()

    • newBuilder

      public static WriteRel.Builder newBuilder(WriteRel prototype)

    • toBuilder

      public WriteRel.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected WriteRel.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static WriteRel getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<WriteRel> parser()

    • getParserForType

      public com.google.protobuf.Parser<WriteRel> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public WriteRel getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder