org.apache.arrow.flight.sql.impl

Interface FlightSql.CommandGetTablesOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

FlightSql.CommandGetTables, FlightSql.CommandGetTables.Builder

Enclosing class:

FlightSql

public static interface FlightSql.CommandGetTablesOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getCatalog() Specifies the Catalog to search for the tables.
com.google.protobuf.ByteString	getCatalogBytes() Specifies the Catalog to search for the tables.
String	getDbSchemaFilterPattern() Specifies a filter pattern for schemas to search for.
com.google.protobuf.ByteString	getDbSchemaFilterPatternBytes() Specifies a filter pattern for schemas to search for.
boolean	getIncludeSchema() Specifies if the Arrow schema should be returned for found tables.
String	getTableNameFilterPattern() Specifies a filter pattern for tables to search for.
com.google.protobuf.ByteString	getTableNameFilterPatternBytes() Specifies a filter pattern for tables to search for.
String	getTableTypes(int index) Specifies a filter of table types which must match.
com.google.protobuf.ByteString	getTableTypesBytes(int index) Specifies a filter of table types which must match.
int	getTableTypesCount() Specifies a filter of table types which must match.
List<String>	getTableTypesList() Specifies a filter of table types which must match.
boolean	hasCatalog() Specifies the Catalog to search for the tables.
boolean	hasDbSchemaFilterPattern() Specifies a filter pattern for schemas to search for.
boolean	hasTableNameFilterPattern() Specifies a filter pattern for tables to search for.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasCatalog

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;

Returns:

Whether the catalog field is set.

getCatalog

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;

Returns:

The catalog.

getCatalogBytes

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;

Returns:

The bytes for catalog.

hasDbSchemaFilterPattern

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;

Returns:

Whether the dbSchemaFilterPattern field is set.

getDbSchemaFilterPattern

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;

Returns:

The dbSchemaFilterPattern.

getDbSchemaFilterPatternBytes

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;

Returns:

The bytes for dbSchemaFilterPattern.

hasTableNameFilterPattern

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;

Returns:

Whether the tableNameFilterPattern field is set.

getTableNameFilterPattern

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;

Returns:

The tableNameFilterPattern.

getTableNameFilterPatternBytes

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;

Returns:

The bytes for tableNameFilterPattern.

getTableTypesList

List<String> 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;

Returns:

A list containing the tableTypes.

getTableTypesCount

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;

Returns:

The count of tableTypes.

getTableTypes

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;

Parameters:

index - The index of the element to return.

Returns:

The tableTypes at the given index.

getTableTypesBytes

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;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the tableTypes at the given index.

getIncludeSchema

boolean getIncludeSchema()

 Specifies if the Arrow schema should be returned for found tables.
 

bool include_schema = 5;

Returns:

The includeSchema.