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

Class FlightSql.CommandGetExportedKeys

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

 Represents a request to retrieve a description of the foreign key columns that reference the given table's
 primary key columns (the foreign keys exported by a table) of a table on a Flight SQL enabled backend.
 Used in the command member of FlightDescriptor for the following RPC calls:
  - GetSchema: return the Arrow schema of the query.
  - GetFlightInfo: execute the catalog metadata request.

 The returned Arrow schema will be:
 <
  pk_catalog_name: utf8,
  pk_db_schema_name: utf8,
  pk_table_name: utf8 not null,
  pk_column_name: utf8 not null,
  fk_catalog_name: utf8,
  fk_db_schema_name: utf8,
  fk_table_name: utf8 not null,
  fk_column_name: utf8 not null,
  key_sequence: int32 not null,
  fk_key_name: utf8,
  pk_key_name: utf8,
  update_rule: uint8 not null,
  delete_rule: uint8 not null
 >
 The returned data should be ordered by fk_catalog_name, fk_db_schema_name, fk_table_name, fk_key_name, then key_sequence.
 update_rule and delete_rule returns a byte that is equivalent to actions declared on UpdateDeleteRules enum.
Protobuf type arrow.flight.protocol.sql.CommandGetExportedKeys
See Also:

  • Field Details

  • 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

    • hasCatalog

      public boolean hasCatalog()
      
 Specifies the catalog to search for the foreign key table.
 An empty string retrieves those without a catalog.
 If omitted the catalog name should not be used to narrow the search.
      optional string catalog = 1;
      Specified by:
      hasCatalog in interface FlightSql.CommandGetExportedKeysOrBuilder
      Returns:
      Whether the catalog field is set.

    • getCatalog

      public String getCatalog()
      
 Specifies the catalog to search for the foreign key table.
 An empty string retrieves those without a catalog.
 If omitted the catalog name should not be used to narrow the search.
      optional string catalog = 1;
      Specified by:
      getCatalog in interface FlightSql.CommandGetExportedKeysOrBuilder
      Returns:
      The catalog.

    • getCatalogBytes

      public com.google.protobuf.ByteString getCatalogBytes()
      
 Specifies the catalog to search for the foreign key table.
 An empty string retrieves those without a catalog.
 If omitted the catalog name should not be used to narrow the search.
      optional string catalog = 1;
      Specified by:
      getCatalogBytes in interface FlightSql.CommandGetExportedKeysOrBuilder
      Returns:
      The bytes for catalog.

    • hasDbSchema

      public boolean hasDbSchema()
      
 Specifies the schema to search for the foreign key table.
 An empty string retrieves those without a schema.
 If omitted the schema name should not be used to narrow the search.
      optional string db_schema = 2;
      Specified by:
      hasDbSchema in interface FlightSql.CommandGetExportedKeysOrBuilder
      Returns:
      Whether the dbSchema field is set.

    • getDbSchema

      public String getDbSchema()
      
 Specifies the schema to search for the foreign key table.
 An empty string retrieves those without a schema.
 If omitted the schema name should not be used to narrow the search.
      optional string db_schema = 2;
      Specified by:
      getDbSchema in interface FlightSql.CommandGetExportedKeysOrBuilder
      Returns:
      The dbSchema.

    • getDbSchemaBytes

      public com.google.protobuf.ByteString getDbSchemaBytes()
      
 Specifies the schema to search for the foreign key table.
 An empty string retrieves those without a schema.
 If omitted the schema name should not be used to narrow the search.
      optional string db_schema = 2;
      Specified by:
      getDbSchemaBytes in interface FlightSql.CommandGetExportedKeysOrBuilder
      Returns:
      The bytes for dbSchema.

    • getTable

      public String getTable()
       Specifies the foreign key table to get the foreign keys for.
      string table = 3;
      Specified by:
      getTable in interface FlightSql.CommandGetExportedKeysOrBuilder
      Returns:
      The table.

    • getTableBytes

      public com.google.protobuf.ByteString getTableBytes()
       Specifies the foreign key table to get the foreign keys for.
      string table = 3;
      Specified by:
      getTableBytes in interface FlightSql.CommandGetExportedKeysOrBuilder
      Returns:
      The bytes for table.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static FlightSql.CommandGetExportedKeys 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.CommandGetExportedKeys parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static FlightSql.CommandGetExportedKeys.Builder newBuilder()

    • newBuilder

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

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static FlightSql.CommandGetExportedKeys getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<FlightSql.CommandGetExportedKeys> 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 FlightSql.CommandGetExportedKeys getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder