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
Modifier and Type | Class and Description |
---|---|
static class |
FlightSql.CommandGetTables.Builder
Represents a request to retrieve the list of tables, and optionally their schemas, on a Flight SQL enabled backend.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
Modifier and Type | Field and Description |
---|---|
static int |
CATALOG_FIELD_NUMBER |
static int |
DB_SCHEMA_FILTER_PATTERN_FIELD_NUMBER |
static int |
INCLUDE_SCHEMA_FIELD_NUMBER |
static int |
TABLE_NAME_FILTER_PATTERN_FIELD_NUMBER |
static int |
TABLE_TYPES_FIELD_NUMBER |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
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.
|
static FlightSql.CommandGetTables |
getDefaultInstance() |
FlightSql.CommandGetTables |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
boolean |
getIncludeSchema()
Specifies if the Arrow schema should be returned for found tables.
|
com.google.protobuf.Parser<FlightSql.CommandGetTables> |
getParserForType() |
int |
getSerializedSize() |
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.
|
int |
hashCode() |
boolean |
hasTableNameFilterPattern()
Specifies a filter pattern for tables to search for.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static FlightSql.CommandGetTables.Builder |
newBuilder() |
static FlightSql.CommandGetTables.Builder |
newBuilder(FlightSql.CommandGetTables prototype) |
FlightSql.CommandGetTables.Builder |
newBuilderForType() |
protected FlightSql.CommandGetTables.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static FlightSql.CommandGetTables |
parseDelimitedFrom(InputStream input) |
static FlightSql.CommandGetTables |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static FlightSql.CommandGetTables |
parseFrom(byte[] data) |
static FlightSql.CommandGetTables |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static FlightSql.CommandGetTables |
parseFrom(ByteBuffer data) |
static FlightSql.CommandGetTables |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static FlightSql.CommandGetTables |
parseFrom(com.google.protobuf.ByteString data) |
static FlightSql.CommandGetTables |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static FlightSql.CommandGetTables |
parseFrom(com.google.protobuf.CodedInputStream input) |
static FlightSql.CommandGetTables |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static FlightSql.CommandGetTables |
parseFrom(InputStream input) |
static FlightSql.CommandGetTables |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<FlightSql.CommandGetTables> |
parser() |
FlightSql.CommandGetTables.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int CATALOG_FIELD_NUMBER
public static final int DB_SCHEMA_FILTER_PATTERN_FIELD_NUMBER
public static final int TABLE_NAME_FILTER_PATTERN_FIELD_NUMBER
public static final int TABLE_TYPES_FIELD_NUMBER
public static final int INCLUDE_SCHEMA_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
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;
hasCatalog
in interface FlightSql.CommandGetTablesOrBuilder
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;
getCatalog
in interface FlightSql.CommandGetTablesOrBuilder
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;
getCatalogBytes
in interface FlightSql.CommandGetTablesOrBuilder
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.CommandGetTablesOrBuilder
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;
getDbSchemaFilterPattern
in interface FlightSql.CommandGetTablesOrBuilder
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;
getDbSchemaFilterPatternBytes
in interface FlightSql.CommandGetTablesOrBuilder
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.CommandGetTablesOrBuilder
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;
getTableNameFilterPattern
in interface FlightSql.CommandGetTablesOrBuilder
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;
getTableNameFilterPatternBytes
in interface FlightSql.CommandGetTablesOrBuilder
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.CommandGetTablesOrBuilder
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;
getTableTypesCount
in interface FlightSql.CommandGetTablesOrBuilder
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;
getTableTypes
in interface FlightSql.CommandGetTablesOrBuilder
index
- 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.CommandGetTablesOrBuilder
index
- The index of the value to return.public boolean getIncludeSchema()
Specifies if the Arrow schema should be returned for found tables.
bool include_schema = 5;
getIncludeSchema
in interface FlightSql.CommandGetTablesOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static FlightSql.CommandGetTables parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static FlightSql.CommandGetTables parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static FlightSql.CommandGetTables parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static FlightSql.CommandGetTables parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static FlightSql.CommandGetTables parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static FlightSql.CommandGetTables parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static FlightSql.CommandGetTables parseFrom(InputStream input) throws IOException
IOException
public static FlightSql.CommandGetTables parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static FlightSql.CommandGetTables parseDelimitedFrom(InputStream input) throws IOException
IOException
public static FlightSql.CommandGetTables parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static FlightSql.CommandGetTables parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOException
public static FlightSql.CommandGetTables parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public FlightSql.CommandGetTables.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static FlightSql.CommandGetTables.Builder newBuilder()
public static FlightSql.CommandGetTables.Builder newBuilder(FlightSql.CommandGetTables prototype)
public FlightSql.CommandGetTables.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected FlightSql.CommandGetTables.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static FlightSql.CommandGetTables getDefaultInstance()
public static com.google.protobuf.Parser<FlightSql.CommandGetTables> parser()
public com.google.protobuf.Parser<FlightSql.CommandGetTables> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public FlightSql.CommandGetTables getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
Copyright © 2023 The Apache Software Foundation. All rights reserved.