Class FlightSql.CommandGetImportedKeys

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
org.apache.arrow.flight.sql.impl.FlightSql.CommandGetImportedKeys
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, FlightSql.CommandGetImportedKeysOrBuilder
Enclosing class:
FlightSql

public static final class FlightSql.CommandGetImportedKeys extends com.google.protobuf.GeneratedMessage implements FlightSql.CommandGetImportedKeysOrBuilder

Represents a request to retrieve the foreign keys 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 pk_catalog_name, pk_db_schema_name, pk_table_name, pk_key_name, then key_sequence.
update_rule and delete_rule returns a byte that is equivalent to actions:
- 0 = CASCADE
- 1 = RESTRICT
- 2 = SET NULL
- 3 = NO ACTION
- 4 = SET DEFAULT
Protobuf type arrow.flight.protocol.sql.CommandGetImportedKeys
See Also:
  • Field Details

  • 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
    • hasCatalog

      public boolean hasCatalog()
      
      Specifies the catalog to search for the primary 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.CommandGetImportedKeysOrBuilder
      Returns:
      Whether the catalog field is set.
    • getCatalog

      public String getCatalog()
      
      Specifies the catalog to search for the primary 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.CommandGetImportedKeysOrBuilder
      Returns:
      The catalog.
    • getCatalogBytes

      public com.google.protobuf.ByteString getCatalogBytes()
      
      Specifies the catalog to search for the primary 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.CommandGetImportedKeysOrBuilder
      Returns:
      The bytes for catalog.
    • hasDbSchema

      public boolean hasDbSchema()
      
      Specifies the schema to search for the primary 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.CommandGetImportedKeysOrBuilder
      Returns:
      Whether the dbSchema field is set.
    • getDbSchema

      public String getDbSchema()
      
      Specifies the schema to search for the primary 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.CommandGetImportedKeysOrBuilder
      Returns:
      The dbSchema.
    • getDbSchemaBytes

      public com.google.protobuf.ByteString getDbSchemaBytes()
      
      Specifies the schema to search for the primary 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.CommandGetImportedKeysOrBuilder
      Returns:
      The bytes for dbSchema.
    • getTable

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

      public com.google.protobuf.ByteString getTableBytes()
      Specifies the primary key table to get the foreign keys for.
      
      string table = 3;
      Specified by:
      getTableBytes in interface FlightSql.CommandGetImportedKeysOrBuilder
      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.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.CommandGetImportedKeys parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

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

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

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

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

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

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

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

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

      public static FlightSql.CommandGetImportedKeys.Builder newBuilder()
    • newBuilder

    • toBuilder

      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

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

      public static FlightSql.CommandGetImportedKeys getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<FlightSql.CommandGetImportedKeys> parser()
    • getParserForType

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