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

Class FlightSql.CommandGetTables

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

 Represents a request to retrieve the list of tables, and optionally their schemas, 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:
 <
  catalog_name: utf8,
  db_schema_name: utf8,
  table_name: utf8 not null,
  table_type: utf8 not null,
  [optional] table_schema: bytes not null (schema of the table as described in Schema.fbs::Schema,
                                           it is serialized as an IPC message.)
 >
 Fields on table_schema may contain the following metadata:
  - ARROW:FLIGHT:SQL:CATALOG_NAME      - Table's catalog name
  - ARROW:FLIGHT:SQL:DB_SCHEMA_NAME    - Database schema name
  - ARROW:FLIGHT:SQL:TABLE_NAME        - Table name
  - ARROW:FLIGHT:SQL:TYPE_NAME         - The data source-specific name for the data type of the column.
  - ARROW:FLIGHT:SQL:PRECISION         - Column precision/size
  - ARROW:FLIGHT:SQL:SCALE             - Column scale/decimal digits if applicable
  - ARROW:FLIGHT:SQL:IS_AUTO_INCREMENT - "1" indicates if the column is auto incremented, "0" otherwise.
  - ARROW:FLIGHT:SQL:IS_CASE_SENSITIVE - "1" indicates if the column is case-sensitive, "0" otherwise.
  - ARROW:FLIGHT:SQL:IS_READ_ONLY      - "1" indicates if the column is read only, "0" otherwise.
  - ARROW:FLIGHT:SQL:IS_SEARCHABLE     - "1" indicates if the column is searchable via WHERE clause, "0" otherwise.
 The returned data should be ordered by catalog_name, db_schema_name, table_name, then table_type, followed by table_schema if requested.
Protobuf type arrow.flight.protocol.sql.CommandGetTables
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:

    • TABLE_NAME_FILTER_PATTERN_FIELD_NUMBER

      public static final int TABLE_NAME_FILTER_PATTERN_FIELD_NUMBER
      See Also:

    • TABLE_TYPES_FIELD_NUMBER

      public static final int TABLE_TYPES_FIELD_NUMBER
      See Also:

    • INCLUDE_SCHEMA_FIELD_NUMBER

      public static final int INCLUDE_SCHEMA_FIELD_NUMBER
      See Also:

  • 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 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.CommandGetTablesOrBuilder
      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.CommandGetTablesOrBuilder
      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.CommandGetTablesOrBuilder
      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, all schemas matching other filters are searched.
 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.CommandGetTablesOrBuilder
      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, all schemas matching other filters are searched.
 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.CommandGetTablesOrBuilder
      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, all schemas matching other filters are searched.
 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.CommandGetTablesOrBuilder
      Returns:
      The bytes for dbSchemaFilterPattern.

    • hasTableNameFilterPattern

      public boolean hasTableNameFilterPattern()
      
 Specifies a filter pattern for tables to search for.
 When no table_name_filter_pattern is provided, all tables matching other filters are searched.
 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 table_name_filter_pattern = 3;
      Specified by:
      hasTableNameFilterPattern in interface FlightSql.CommandGetTablesOrBuilder
      Returns:
      Whether the tableNameFilterPattern field is set.

    • getTableNameFilterPattern

      public String getTableNameFilterPattern()
      
 Specifies a filter pattern for tables to search for.
 When no table_name_filter_pattern is provided, all tables matching other filters are searched.
 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 table_name_filter_pattern = 3;
      Specified by:
      getTableNameFilterPattern in interface FlightSql.CommandGetTablesOrBuilder
      Returns:
      The tableNameFilterPattern.

    • getTableNameFilterPatternBytes

      public com.google.protobuf.ByteString getTableNameFilterPatternBytes()
      
 Specifies a filter pattern for tables to search for.
 When no table_name_filter_pattern is provided, all tables matching other filters are searched.
 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 table_name_filter_pattern = 3;
      Specified by:
      getTableNameFilterPatternBytes in interface FlightSql.CommandGetTablesOrBuilder
      Returns:
      The bytes for tableNameFilterPattern.

    • getTableTypesList

      public com.google.protobuf.ProtocolStringList getTableTypesList()
      
 Specifies a filter of table types which must match.
 The table types depend on vendor/implementation. It is usually used to separate tables from views or system tables.
 TABLE, VIEW, and SYSTEM TABLE are commonly supported.
      repeated string table_types = 4;
      Specified by:
      getTableTypesList in interface FlightSql.CommandGetTablesOrBuilder
      Returns:
      A list containing the tableTypes.

    • getTableTypesCount

      public int getTableTypesCount()
      
 Specifies a filter of table types which must match.
 The table types depend on vendor/implementation. It is usually used to separate tables from views or system tables.
 TABLE, VIEW, and SYSTEM TABLE are commonly supported.
      repeated string table_types = 4;
      Specified by:
      getTableTypesCount in interface FlightSql.CommandGetTablesOrBuilder
      Returns:
      The count of tableTypes.

    • getTableTypes

      public String getTableTypes(int index)
      
 Specifies a filter of table types which must match.
 The table types depend on vendor/implementation. It is usually used to separate tables from views or system tables.
 TABLE, VIEW, and SYSTEM TABLE are commonly supported.
      repeated string table_types = 4;
      Specified by:
      getTableTypes in interface FlightSql.CommandGetTablesOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The tableTypes at the given index.

    • getTableTypesBytes

      public com.google.protobuf.ByteString getTableTypesBytes(int index)
      
 Specifies a filter of table types which must match.
 The table types depend on vendor/implementation. It is usually used to separate tables from views or system tables.
 TABLE, VIEW, and SYSTEM TABLE are commonly supported.
      repeated string table_types = 4;
      Specified by:
      getTableTypesBytes in interface FlightSql.CommandGetTablesOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the tableTypes at the given index.

    • getIncludeSchema

      public boolean getIncludeSchema()
       Specifies if the Arrow schema should be returned for found tables.
      bool include_schema = 5;
      Specified by:
      getIncludeSchema in interface FlightSql.CommandGetTablesOrBuilder
      Returns:
      The includeSchema.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static FlightSql.CommandGetTables.Builder newBuilder()

    • newBuilder

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

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static FlightSql.CommandGetTables getDefaultInstance()

    • parser

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

    • getParserForType

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