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

Class FlightSql.CommandGetCrossReference.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<FlightSql.CommandGetCrossReference.Builder>
org.apache.arrow.flight.sql.impl.FlightSql.CommandGetCrossReference.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, FlightSql.CommandGetCrossReferenceOrBuilder
Enclosing class:
FlightSql.CommandGetCrossReference
public static final class FlightSql.CommandGetCrossReference.Builder extends com.google.protobuf.GeneratedMessage.Builder<FlightSql.CommandGetCrossReference.Builder> 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

  • 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.Builder<FlightSql.CommandGetCrossReference.Builder>

    • clear

      public FlightSql.CommandGetCrossReference.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<FlightSql.CommandGetCrossReference.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<FlightSql.CommandGetCrossReference.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public FlightSql.CommandGetCrossReference.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FlightSql.CommandGetCrossReference.Builder>

    • mergeFrom

      public FlightSql.CommandGetCrossReference.Builder mergeFrom(FlightSql.CommandGetCrossReference other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<FlightSql.CommandGetCrossReference.Builder>

    • mergeFrom

      public FlightSql.CommandGetCrossReference.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FlightSql.CommandGetCrossReference.Builder>
      Throws:
      IOException

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

    • setPkCatalog

      public FlightSql.CommandGetCrossReference.Builder setPkCatalog(String value)
       *
 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;
      Parameters:
      value - The pkCatalog to set.
      Returns:
      This builder for chaining.

    • clearPkCatalog

      public FlightSql.CommandGetCrossReference.Builder clearPkCatalog()
       *
 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;
      Returns:
      This builder for chaining.

    • setPkCatalogBytes

      public FlightSql.CommandGetCrossReference.Builder setPkCatalogBytes(com.google.protobuf.ByteString value)
       *
 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;
      Parameters:
      value - The bytes for pkCatalog to set.
      Returns:
      This builder for chaining.

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

    • setPkDbSchema

      public FlightSql.CommandGetCrossReference.Builder setPkDbSchema(String value)
       *
 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;
      Parameters:
      value - The pkDbSchema to set.
      Returns:
      This builder for chaining.

    • clearPkDbSchema

      public FlightSql.CommandGetCrossReference.Builder clearPkDbSchema()
       *
 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;
      Returns:
      This builder for chaining.

    • setPkDbSchemaBytes

      public FlightSql.CommandGetCrossReference.Builder setPkDbSchemaBytes(com.google.protobuf.ByteString value)
       *
 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;
      Parameters:
      value - The bytes for pkDbSchema to set.
      Returns:
      This builder for chaining.

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

    • setPkTable

      public FlightSql.CommandGetCrossReference.Builder setPkTable(String value)
       *
 The parent table name. It cannot be null.
      string pk_table = 3;
      Parameters:
      value - The pkTable to set.
      Returns:
      This builder for chaining.

    • clearPkTable

      public FlightSql.CommandGetCrossReference.Builder clearPkTable()
       *
 The parent table name. It cannot be null.
      string pk_table = 3;
      Returns:
      This builder for chaining.

    • setPkTableBytes

      public FlightSql.CommandGetCrossReference.Builder setPkTableBytes(com.google.protobuf.ByteString value)
       *
 The parent table name. It cannot be null.
      string pk_table = 3;
      Parameters:
      value - The bytes for pkTable to set.
      Returns:
      This builder for chaining.

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

    • setFkCatalog

      public FlightSql.CommandGetCrossReference.Builder setFkCatalog(String value)
       *
 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;
      Parameters:
      value - The fkCatalog to set.
      Returns:
      This builder for chaining.

    • clearFkCatalog

      public FlightSql.CommandGetCrossReference.Builder clearFkCatalog()
       *
 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;
      Returns:
      This builder for chaining.

    • setFkCatalogBytes

      public FlightSql.CommandGetCrossReference.Builder setFkCatalogBytes(com.google.protobuf.ByteString value)
       *
 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;
      Parameters:
      value - The bytes for fkCatalog to set.
      Returns:
      This builder for chaining.

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

    • setFkDbSchema

      public FlightSql.CommandGetCrossReference.Builder setFkDbSchema(String value)
       *
 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;
      Parameters:
      value - The fkDbSchema to set.
      Returns:
      This builder for chaining.

    • clearFkDbSchema

      public FlightSql.CommandGetCrossReference.Builder clearFkDbSchema()
       *
 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;
      Returns:
      This builder for chaining.

    • setFkDbSchemaBytes

      public FlightSql.CommandGetCrossReference.Builder setFkDbSchemaBytes(com.google.protobuf.ByteString value)
       *
 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;
      Parameters:
      value - The bytes for fkDbSchema to set.
      Returns:
      This builder for chaining.

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

    • setFkTable

      public FlightSql.CommandGetCrossReference.Builder setFkTable(String value)
       *
 The foreign table name. It cannot be null.
      string fk_table = 6;
      Parameters:
      value - The fkTable to set.
      Returns:
      This builder for chaining.

    • clearFkTable

      public FlightSql.CommandGetCrossReference.Builder clearFkTable()
       *
 The foreign table name. It cannot be null.
      string fk_table = 6;
      Returns:
      This builder for chaining.

    • setFkTableBytes

      public FlightSql.CommandGetCrossReference.Builder setFkTableBytes(com.google.protobuf.ByteString value)
       *
 The foreign table name. It cannot be null.
      string fk_table = 6;
      Parameters:
      value - The bytes for fkTable to set.
      Returns:
      This builder for chaining.