public static final class FlightSql.CommandGetTables.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetTables.Builder> 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| Modifier and Type | Method and Description |
|---|---|
FlightSql.CommandGetTables.Builder |
addAllTableTypes(Iterable<String> values)
Specifies a filter of table types which must match.
|
FlightSql.CommandGetTables.Builder |
addTableTypes(String value)
Specifies a filter of table types which must match.
|
FlightSql.CommandGetTables.Builder |
addTableTypesBytes(com.google.protobuf.ByteString value)
Specifies a filter of table types which must match.
|
FlightSql.CommandGetTables |
build() |
FlightSql.CommandGetTables |
buildPartial() |
FlightSql.CommandGetTables.Builder |
clear() |
FlightSql.CommandGetTables.Builder |
clearCatalog()
Specifies the Catalog to search for the tables.
|
FlightSql.CommandGetTables.Builder |
clearDbSchemaFilterPattern()
Specifies a filter pattern for schemas to search for.
|
FlightSql.CommandGetTables.Builder |
clearIncludeSchema()
Specifies if the Arrow schema should be returned for found tables.
|
FlightSql.CommandGetTables.Builder |
clearTableNameFilterPattern()
Specifies a filter pattern for tables to search for.
|
FlightSql.CommandGetTables.Builder |
clearTableTypes()
Specifies a filter of table types which must match.
|
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.
|
FlightSql.CommandGetTables |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
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.
|
com.google.protobuf.ProtocolStringList |
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.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
FlightSql.CommandGetTables.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
FlightSql.CommandGetTables.Builder |
mergeFrom(FlightSql.CommandGetTables other) |
FlightSql.CommandGetTables.Builder |
mergeFrom(com.google.protobuf.Message other) |
FlightSql.CommandGetTables.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
FlightSql.CommandGetTables.Builder |
setCatalog(String value)
Specifies the Catalog to search for the tables.
|
FlightSql.CommandGetTables.Builder |
setCatalogBytes(com.google.protobuf.ByteString value)
Specifies the Catalog to search for the tables.
|
FlightSql.CommandGetTables.Builder |
setDbSchemaFilterPattern(String value)
Specifies a filter pattern for schemas to search for.
|
FlightSql.CommandGetTables.Builder |
setDbSchemaFilterPatternBytes(com.google.protobuf.ByteString value)
Specifies a filter pattern for schemas to search for.
|
FlightSql.CommandGetTables.Builder |
setIncludeSchema(boolean value)
Specifies if the Arrow schema should be returned for found tables.
|
FlightSql.CommandGetTables.Builder |
setTableNameFilterPattern(String value)
Specifies a filter pattern for tables to search for.
|
FlightSql.CommandGetTables.Builder |
setTableNameFilterPatternBytes(com.google.protobuf.ByteString value)
Specifies a filter pattern for tables to search for.
|
FlightSql.CommandGetTables.Builder |
setTableTypes(int index,
String value)
Specifies a filter of table types which must match.
|
FlightSql.CommandGetTables.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetTables.Builder>public FlightSql.CommandGetTables.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetTables.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetTables.Builder>public FlightSql.CommandGetTables getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic FlightSql.CommandGetTables build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic FlightSql.CommandGetTables buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic FlightSql.CommandGetTables.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<FlightSql.CommandGetTables.Builder>public FlightSql.CommandGetTables.Builder mergeFrom(FlightSql.CommandGetTables other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetTables.Builder>public FlightSql.CommandGetTables.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<FlightSql.CommandGetTables.Builder>IOExceptionpublic 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;hasCatalog in interface FlightSql.CommandGetTablesOrBuilderpublic 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;getCatalog in interface FlightSql.CommandGetTablesOrBuilderpublic 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;getCatalogBytes in interface FlightSql.CommandGetTablesOrBuilderpublic FlightSql.CommandGetTables.Builder setCatalog(String value)
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;value - The catalog to set.public FlightSql.CommandGetTables.Builder clearCatalog()
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;public FlightSql.CommandGetTables.Builder setCatalogBytes(com.google.protobuf.ByteString value)
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;value - The bytes for catalog to set.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;hasDbSchemaFilterPattern in interface FlightSql.CommandGetTablesOrBuilderpublic 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;getDbSchemaFilterPattern in interface FlightSql.CommandGetTablesOrBuilderpublic 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;getDbSchemaFilterPatternBytes in interface FlightSql.CommandGetTablesOrBuilderpublic FlightSql.CommandGetTables.Builder setDbSchemaFilterPattern(String value)
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;value - The dbSchemaFilterPattern to set.public FlightSql.CommandGetTables.Builder clearDbSchemaFilterPattern()
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;public FlightSql.CommandGetTables.Builder setDbSchemaFilterPatternBytes(com.google.protobuf.ByteString value)
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;value - The bytes for dbSchemaFilterPattern to set.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;hasTableNameFilterPattern in interface FlightSql.CommandGetTablesOrBuilderpublic 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;getTableNameFilterPattern in interface FlightSql.CommandGetTablesOrBuilderpublic 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;getTableNameFilterPatternBytes in interface FlightSql.CommandGetTablesOrBuilderpublic FlightSql.CommandGetTables.Builder setTableNameFilterPattern(String value)
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;value - The tableNameFilterPattern to set.public FlightSql.CommandGetTables.Builder clearTableNameFilterPattern()
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;public FlightSql.CommandGetTables.Builder setTableNameFilterPatternBytes(com.google.protobuf.ByteString value)
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;value - The bytes for tableNameFilterPattern to set.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;getTableTypesList in interface FlightSql.CommandGetTablesOrBuilderpublic 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;getTableTypesCount in interface FlightSql.CommandGetTablesOrBuilderpublic 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;getTableTypes in interface FlightSql.CommandGetTablesOrBuilderindex - The index of the element to return.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;getTableTypesBytes in interface FlightSql.CommandGetTablesOrBuilderindex - The index of the value to return.public FlightSql.CommandGetTables.Builder setTableTypes(int index, String value)
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;index - The index to set the value at.value - The tableTypes to set.public FlightSql.CommandGetTables.Builder addTableTypes(String value)
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;value - The tableTypes to add.public FlightSql.CommandGetTables.Builder addAllTableTypes(Iterable<String> values)
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;values - The tableTypes to add.public FlightSql.CommandGetTables.Builder clearTableTypes()
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;public FlightSql.CommandGetTables.Builder addTableTypesBytes(com.google.protobuf.ByteString value)
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;value - The bytes of the tableTypes to add.public boolean getIncludeSchema()
Specifies if the Arrow schema should be returned for found tables.
bool include_schema = 5;getIncludeSchema in interface FlightSql.CommandGetTablesOrBuilderpublic FlightSql.CommandGetTables.Builder setIncludeSchema(boolean value)
Specifies if the Arrow schema should be returned for found tables.
bool include_schema = 5;value - The includeSchema to set.public FlightSql.CommandGetTables.Builder clearIncludeSchema()
Specifies if the Arrow schema should be returned for found tables.
bool include_schema = 5;public final FlightSql.CommandGetTables.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetTables.Builder>public final FlightSql.CommandGetTables.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetTables.Builder>Copyright © 2023 The Apache Software Foundation. All rights reserved.