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

Interface FlightSql.ActionCreatePreparedStatementResultOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
FlightSql.ActionCreatePreparedStatementResult, FlightSql.ActionCreatePreparedStatementResult.Builder
Enclosing class:
FlightSql
public static interface FlightSql.ActionCreatePreparedStatementResultOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.ByteString
    getDatasetSchema()
    If a result set generating query was provided, dataset_schema contains the schema of the result set.
    boolean
    getIsUpdate()
    When set to true, the query should be executed with CommandPreparedStatementUpdate, when set to false, the query should be executed with CommandPreparedStatementQuery.
    com.google.protobuf.ByteString
    getParameterSchema()
    If the query provided contained parameters, parameter_schema contains the schema of the expected parameters.
    com.google.protobuf.ByteString
    getPreparedStatementHandle()
    Opaque handle for the prepared statement on the server.
    boolean
    hasIsUpdate()
    When set to true, the query should be executed with CommandPreparedStatementUpdate, when set to false, the query should be executed with CommandPreparedStatementQuery.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getPreparedStatementHandle

      com.google.protobuf.ByteString getPreparedStatementHandle()
       Opaque handle for the prepared statement on the server.
      bytes prepared_statement_handle = 1;
      Returns:
      The preparedStatementHandle.

    • getDatasetSchema

      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;
      Returns:
      The datasetSchema.

    • getParameterSchema

      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;
      Returns:
      The parameterSchema.

    • hasIsUpdate

      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;
      Returns:
      Whether the isUpdate field is set.

    • getIsUpdate

      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;
      Returns:
      The isUpdate.