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

Class FlightSql.CommandGetDbSchemas

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

 Represents a request to retrieve the list of database schemas on a Flight SQL enabled backend.
 The definition of a database schema depends on vendor/implementation. It is usually a collection of tables.
 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:
 <
 catalog_name: utf8,
 db_schema_name: utf8 not null
 >
 The returned data should be ordered by catalog_name, then db_schema_name.
Protobuf type arrow.flight.protocol.sql.CommandGetDbSchemas
See Also:

  • Field Details

    • CATALOG_FIELD_NUMBER

      public static final int CATALOG_FIELD_NUMBER
      See Also:

    • DB_SCHEMA_FILTER_PATTERN_FIELD_NUMBER

      public static final int DB_SCHEMA_FILTER_PATTERN_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

    • hasCatalog

      public boolean hasCatalog()
      
 Specifies the Catalog to search for the tables.
 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.CommandGetDbSchemasOrBuilder
      Returns:
      Whether the catalog field is set.

    • getCatalog

      public String getCatalog()
      
 Specifies the Catalog to search for the tables.
 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.CommandGetDbSchemasOrBuilder
      Returns:
      The catalog.

    • getCatalogBytes

      public com.google.protobuf.ByteString getCatalogBytes()
      
 Specifies the Catalog to search for the tables.
 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.CommandGetDbSchemasOrBuilder
      Returns:
      The bytes for catalog.

    • hasDbSchemaFilterPattern

      public boolean hasDbSchemaFilterPattern()
      
 Specifies a filter pattern for schemas to search for.
 When no db_schema_filter_pattern is provided, the pattern will not be used to narrow the search.
 In the pattern string, two special characters can be used to denote matching rules:
 - "%" means to match any substring with 0 or more characters.
 - "_" means to match any one character.
      optional string db_schema_filter_pattern = 2;
      Specified by:
      hasDbSchemaFilterPattern in interface FlightSql.CommandGetDbSchemasOrBuilder
      Returns:
      Whether the dbSchemaFilterPattern field is set.

    • getDbSchemaFilterPattern

      public String getDbSchemaFilterPattern()
      
 Specifies a filter pattern for schemas to search for.
 When no db_schema_filter_pattern is provided, the pattern will not be used to narrow the search.
 In the pattern string, two special characters can be used to denote matching rules:
 - "%" means to match any substring with 0 or more characters.
 - "_" means to match any one character.
      optional string db_schema_filter_pattern = 2;
      Specified by:
      getDbSchemaFilterPattern in interface FlightSql.CommandGetDbSchemasOrBuilder
      Returns:
      The dbSchemaFilterPattern.

    • getDbSchemaFilterPatternBytes

      public com.google.protobuf.ByteString getDbSchemaFilterPatternBytes()
      
 Specifies a filter pattern for schemas to search for.
 When no db_schema_filter_pattern is provided, the pattern will not be used to narrow the search.
 In the pattern string, two special characters can be used to denote matching rules:
 - "%" means to match any substring with 0 or more characters.
 - "_" means to match any one character.
      optional string db_schema_filter_pattern = 2;
      Specified by:
      getDbSchemaFilterPatternBytes in interface FlightSql.CommandGetDbSchemasOrBuilder
      Returns:
      The bytes for dbSchemaFilterPattern.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static FlightSql.CommandGetDbSchemas.Builder newBuilder()

    • newBuilder

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

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static FlightSql.CommandGetDbSchemas getDefaultInstance()

    • parser

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

    • getParserForType

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