public static final class FlightSql.CommandGetDbSchemas extends com.google.protobuf.GeneratedMessageV3 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
Modifier and Type | Class and Description |
---|---|
static class |
FlightSql.CommandGetDbSchemas.Builder
Represents a request to retrieve the list of database 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 |
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.CommandGetDbSchemas |
getDefaultInstance() |
FlightSql.CommandGetDbSchemas |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Parser<FlightSql.CommandGetDbSchemas> |
getParserForType() |
int |
getSerializedSize() |
boolean |
hasCatalog()
Specifies the Catalog to search for the tables.
|
boolean |
hasDbSchemaFilterPattern()
Specifies a filter pattern for schemas to search for.
|
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static FlightSql.CommandGetDbSchemas.Builder |
newBuilder() |
static FlightSql.CommandGetDbSchemas.Builder |
newBuilder(FlightSql.CommandGetDbSchemas prototype) |
FlightSql.CommandGetDbSchemas.Builder |
newBuilderForType() |
protected FlightSql.CommandGetDbSchemas.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static FlightSql.CommandGetDbSchemas |
parseDelimitedFrom(InputStream input) |
static FlightSql.CommandGetDbSchemas |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static FlightSql.CommandGetDbSchemas |
parseFrom(byte[] data) |
static FlightSql.CommandGetDbSchemas |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static FlightSql.CommandGetDbSchemas |
parseFrom(ByteBuffer data) |
static FlightSql.CommandGetDbSchemas |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static FlightSql.CommandGetDbSchemas |
parseFrom(com.google.protobuf.ByteString data) |
static FlightSql.CommandGetDbSchemas |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static FlightSql.CommandGetDbSchemas |
parseFrom(com.google.protobuf.CodedInputStream input) |
static FlightSql.CommandGetDbSchemas |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static FlightSql.CommandGetDbSchemas |
parseFrom(InputStream input) |
static FlightSql.CommandGetDbSchemas |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<FlightSql.CommandGetDbSchemas> |
parser() |
FlightSql.CommandGetDbSchemas.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
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.CommandGetDbSchemasOrBuilder
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.CommandGetDbSchemasOrBuilder
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.CommandGetDbSchemasOrBuilder
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;
hasDbSchemaFilterPattern
in interface FlightSql.CommandGetDbSchemasOrBuilder
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;
getDbSchemaFilterPattern
in interface FlightSql.CommandGetDbSchemasOrBuilder
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;
getDbSchemaFilterPatternBytes
in interface FlightSql.CommandGetDbSchemasOrBuilder
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.CommandGetDbSchemas parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static FlightSql.CommandGetDbSchemas parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static FlightSql.CommandGetDbSchemas parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static FlightSql.CommandGetDbSchemas parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static FlightSql.CommandGetDbSchemas parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static FlightSql.CommandGetDbSchemas parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static FlightSql.CommandGetDbSchemas parseFrom(InputStream input) throws IOException
IOException
public static FlightSql.CommandGetDbSchemas parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static FlightSql.CommandGetDbSchemas parseDelimitedFrom(InputStream input) throws IOException
IOException
public static FlightSql.CommandGetDbSchemas parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static FlightSql.CommandGetDbSchemas parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOException
public static FlightSql.CommandGetDbSchemas parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public FlightSql.CommandGetDbSchemas.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static FlightSql.CommandGetDbSchemas.Builder newBuilder()
public static FlightSql.CommandGetDbSchemas.Builder newBuilder(FlightSql.CommandGetDbSchemas prototype)
public FlightSql.CommandGetDbSchemas.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected FlightSql.CommandGetDbSchemas.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static FlightSql.CommandGetDbSchemas getDefaultInstance()
public static com.google.protobuf.Parser<FlightSql.CommandGetDbSchemas> parser()
public com.google.protobuf.Parser<FlightSql.CommandGetDbSchemas> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public FlightSql.CommandGetDbSchemas getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
Copyright © 2023 The Apache Software Foundation. All rights reserved.