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

Class FlightSql.CommandGetCrossReference

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

 Represents a request to retrieve a description of the foreign key columns in the given foreign key table that
 reference the primary key or the columns representing a unique constraint of the parent table (could be the same
 or a different 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.CommandGetCrossReference
See Also:

  • Field Details

    • PK_CATALOG_FIELD_NUMBER

      public static final int PK_CATALOG_FIELD_NUMBER
      See Also:

    • PK_DB_SCHEMA_FIELD_NUMBER

      public static final int PK_DB_SCHEMA_FIELD_NUMBER
      See Also:

    • PK_TABLE_FIELD_NUMBER

      public static final int PK_TABLE_FIELD_NUMBER
      See Also:

    • FK_CATALOG_FIELD_NUMBER

      public static final int FK_CATALOG_FIELD_NUMBER
      See Also:

    • FK_DB_SCHEMA_FIELD_NUMBER

      public static final int FK_DB_SCHEMA_FIELD_NUMBER
      See Also:

    • FK_TABLE_FIELD_NUMBER

      public static final int FK_TABLE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • hasPkCatalog

      public boolean hasPkCatalog()
       *
 The catalog name where the parent table is.
 An empty string retrieves those without a catalog.
 If omitted the catalog name should not be used to narrow the search.
      optional string pk_catalog = 1;
      Specified by:
      hasPkCatalog in interface FlightSql.CommandGetCrossReferenceOrBuilder
      Returns:
      Whether the pkCatalog field is set.

    • getPkCatalog

      public String getPkCatalog()
       *
 The catalog name where the parent table is.
 An empty string retrieves those without a catalog.
 If omitted the catalog name should not be used to narrow the search.
      optional string pk_catalog = 1;
      Specified by:
      getPkCatalog in interface FlightSql.CommandGetCrossReferenceOrBuilder
      Returns:
      The pkCatalog.

    • getPkCatalogBytes

      public com.google.protobuf.ByteString getPkCatalogBytes()
       *
 The catalog name where the parent table is.
 An empty string retrieves those without a catalog.
 If omitted the catalog name should not be used to narrow the search.
      optional string pk_catalog = 1;
      Specified by:
      getPkCatalogBytes in interface FlightSql.CommandGetCrossReferenceOrBuilder
      Returns:
      The bytes for pkCatalog.

    • hasPkDbSchema

      public boolean hasPkDbSchema()
       *
 The Schema name where the parent table is.
 An empty string retrieves those without a schema.
 If omitted the schema name should not be used to narrow the search.
      optional string pk_db_schema = 2;
      Specified by:
      hasPkDbSchema in interface FlightSql.CommandGetCrossReferenceOrBuilder
      Returns:
      Whether the pkDbSchema field is set.

    • getPkDbSchema

      public String getPkDbSchema()
       *
 The Schema name where the parent table is.
 An empty string retrieves those without a schema.
 If omitted the schema name should not be used to narrow the search.
      optional string pk_db_schema = 2;
      Specified by:
      getPkDbSchema in interface FlightSql.CommandGetCrossReferenceOrBuilder
      Returns:
      The pkDbSchema.

    • getPkDbSchemaBytes

      public com.google.protobuf.ByteString getPkDbSchemaBytes()
       *
 The Schema name where the parent table is.
 An empty string retrieves those without a schema.
 If omitted the schema name should not be used to narrow the search.
      optional string pk_db_schema = 2;
      Specified by:
      getPkDbSchemaBytes in interface FlightSql.CommandGetCrossReferenceOrBuilder
      Returns:
      The bytes for pkDbSchema.

    • getPkTable

      public String getPkTable()
       *
 The parent table name. It cannot be null.
      string pk_table = 3;
      Specified by:
      getPkTable in interface FlightSql.CommandGetCrossReferenceOrBuilder
      Returns:
      The pkTable.

    • getPkTableBytes

      public com.google.protobuf.ByteString getPkTableBytes()
       *
 The parent table name. It cannot be null.
      string pk_table = 3;
      Specified by:
      getPkTableBytes in interface FlightSql.CommandGetCrossReferenceOrBuilder
      Returns:
      The bytes for pkTable.

    • hasFkCatalog

      public boolean hasFkCatalog()
       *
 The catalog name where the foreign table is.
 An empty string retrieves those without a catalog.
 If omitted the catalog name should not be used to narrow the search.
      optional string fk_catalog = 4;
      Specified by:
      hasFkCatalog in interface FlightSql.CommandGetCrossReferenceOrBuilder
      Returns:
      Whether the fkCatalog field is set.

    • getFkCatalog

      public String getFkCatalog()
       *
 The catalog name where the foreign table is.
 An empty string retrieves those without a catalog.
 If omitted the catalog name should not be used to narrow the search.
      optional string fk_catalog = 4;
      Specified by:
      getFkCatalog in interface FlightSql.CommandGetCrossReferenceOrBuilder
      Returns:
      The fkCatalog.

    • getFkCatalogBytes

      public com.google.protobuf.ByteString getFkCatalogBytes()
       *
 The catalog name where the foreign table is.
 An empty string retrieves those without a catalog.
 If omitted the catalog name should not be used to narrow the search.
      optional string fk_catalog = 4;
      Specified by:
      getFkCatalogBytes in interface FlightSql.CommandGetCrossReferenceOrBuilder
      Returns:
      The bytes for fkCatalog.

    • hasFkDbSchema

      public boolean hasFkDbSchema()
       *
 The schema name where the foreign table is.
 An empty string retrieves those without a schema.
 If omitted the schema name should not be used to narrow the search.
      optional string fk_db_schema = 5;
      Specified by:
      hasFkDbSchema in interface FlightSql.CommandGetCrossReferenceOrBuilder
      Returns:
      Whether the fkDbSchema field is set.

    • getFkDbSchema

      public String getFkDbSchema()
       *
 The schema name where the foreign table is.
 An empty string retrieves those without a schema.
 If omitted the schema name should not be used to narrow the search.
      optional string fk_db_schema = 5;
      Specified by:
      getFkDbSchema in interface FlightSql.CommandGetCrossReferenceOrBuilder
      Returns:
      The fkDbSchema.

    • getFkDbSchemaBytes

      public com.google.protobuf.ByteString getFkDbSchemaBytes()
       *
 The schema name where the foreign table is.
 An empty string retrieves those without a schema.
 If omitted the schema name should not be used to narrow the search.
      optional string fk_db_schema = 5;
      Specified by:
      getFkDbSchemaBytes in interface FlightSql.CommandGetCrossReferenceOrBuilder
      Returns:
      The bytes for fkDbSchema.

    • getFkTable

      public String getFkTable()
       *
 The foreign table name. It cannot be null.
      string fk_table = 6;
      Specified by:
      getFkTable in interface FlightSql.CommandGetCrossReferenceOrBuilder
      Returns:
      The fkTable.

    • getFkTableBytes

      public com.google.protobuf.ByteString getFkTableBytes()
       *
 The foreign table name. It cannot be null.
      string fk_table = 6;
      Specified by:
      getFkTableBytes in interface FlightSql.CommandGetCrossReferenceOrBuilder
      Returns:
      The bytes for fkTable.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static FlightSql.CommandGetCrossReference.Builder newBuilder()

    • newBuilder

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

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static FlightSql.CommandGetCrossReference getDefaultInstance()

    • parser

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

    • getParserForType

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