Module org.apache.arrow.flight.core
Package org.apache.arrow.flight.sql.impl

Class FlightSql.ActionCreatePreparedStatementResult

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
org.apache.arrow.flight.sql.impl.FlightSql.ActionCreatePreparedStatementResult
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, FlightSql.ActionCreatePreparedStatementResultOrBuilder
Enclosing class:
FlightSql
public static final class FlightSql.ActionCreatePreparedStatementResult extends com.google.protobuf.GeneratedMessage implements FlightSql.ActionCreatePreparedStatementResultOrBuilder

 Wrap the result of a "CreatePreparedStatement" or "CreatePreparedSubstraitPlan" action.

 The resultant PreparedStatement can be closed either:
 - Manually, through the "ClosePreparedStatement" action;
 - Automatically, by a server timeout.

 The result should be wrapped in a google.protobuf.Any message.
Protobuf type arrow.flight.protocol.sql.ActionCreatePreparedStatementResult
See Also:

  • Field Details

    • PREPARED_STATEMENT_HANDLE_FIELD_NUMBER

      public static final int PREPARED_STATEMENT_HANDLE_FIELD_NUMBER
      See Also:

    • DATASET_SCHEMA_FIELD_NUMBER

      public static final int DATASET_SCHEMA_FIELD_NUMBER
      See Also:

    • PARAMETER_SCHEMA_FIELD_NUMBER

      public static final int PARAMETER_SCHEMA_FIELD_NUMBER
      See Also:

    • IS_UPDATE_FIELD_NUMBER

      public static final int IS_UPDATE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • getPreparedStatementHandle

      public com.google.protobuf.ByteString getPreparedStatementHandle()
       Opaque handle for the prepared statement on the server.
      bytes prepared_statement_handle = 1;
      Specified by:
      getPreparedStatementHandle in interface FlightSql.ActionCreatePreparedStatementResultOrBuilder
      Returns:
      The preparedStatementHandle.

    • getDatasetSchema

      public com.google.protobuf.ByteString getDatasetSchema()
       If a result set generating query was provided, dataset_schema contains the
 schema of the result set.  It should be an IPC-encapsulated Schema, as described in Schema.fbs.
 For some queries, the schema of the results may depend on the schema of the parameters.  The server
 should provide its best guess as to the schema at this point.  Clients must not assume that this
 schema, if provided, will be accurate.
      bytes dataset_schema = 2;
      Specified by:
      getDatasetSchema in interface FlightSql.ActionCreatePreparedStatementResultOrBuilder
      Returns:
      The datasetSchema.

    • getParameterSchema

      public com.google.protobuf.ByteString getParameterSchema()
       If the query provided contained parameters, parameter_schema contains the
 schema of the expected parameters.  It should be an IPC-encapsulated Schema, as described in Schema.fbs.
      bytes parameter_schema = 3;
      Specified by:
      getParameterSchema in interface FlightSql.ActionCreatePreparedStatementResultOrBuilder
      Returns:
      The parameterSchema.

    • hasIsUpdate

      public boolean hasIsUpdate()
       When set to true, the query should be executed with CommandPreparedStatementUpdate,
 when set to false, the query should be executed with CommandPreparedStatementQuery.
 If not set, the client can choose how to execute the query.
      optional bool is_update = 4;
      Specified by:
      hasIsUpdate in interface FlightSql.ActionCreatePreparedStatementResultOrBuilder
      Returns:
      Whether the isUpdate field is set.

    • getIsUpdate

      public boolean getIsUpdate()
       When set to true, the query should be executed with CommandPreparedStatementUpdate,
 when set to false, the query should be executed with CommandPreparedStatementQuery.
 If not set, the client can choose how to execute the query.
      optional bool is_update = 4;
      Specified by:
      getIsUpdate in interface FlightSql.ActionCreatePreparedStatementResultOrBuilder
      Returns:
      The isUpdate.

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 FlightSql.ActionCreatePreparedStatementResult parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static FlightSql.ActionCreatePreparedStatementResult parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static FlightSql.ActionCreatePreparedStatementResult parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static FlightSql.ActionCreatePreparedStatementResult.Builder newBuilder()

    • newBuilder

      public static FlightSql.ActionCreatePreparedStatementResult.Builder newBuilder(FlightSql.ActionCreatePreparedStatementResult prototype)

    • toBuilder

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

    • newBuilderForType

      protected FlightSql.ActionCreatePreparedStatementResult.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static FlightSql.ActionCreatePreparedStatementResult getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<FlightSql.ActionCreatePreparedStatementResult> 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.GeneratedMessage

    • getDefaultInstanceForType

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