org.apache.arrow.flight.sql.impl

Class FlightSql.CommandGetDbSchemas

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.apache.arrow.flight.sql.impl.FlightSql.CommandGetDbSchemas

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, FlightSql.CommandGetDbSchemasOrBuilder

Enclosing class:

FlightSql

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

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

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CATALOG_FIELD_NUMBER
static int	DB_SCHEMA_FILTER_PATTERN_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

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)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

CATALOG_FIELD_NUMBER

public static final int CATALOG_FIELD_NUMBER

See Also:

Constant Field Values

DB_SCHEMA_FILTER_PATTERN_FIELD_NUMBER

public static final int DB_SCHEMA_FILTER_PATTERN_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

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.CommandGetDbSchemasOrBuilder

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.CommandGetDbSchemasOrBuilder

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.CommandGetDbSchemasOrBuilder

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, 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;

Specified by:

hasDbSchemaFilterPattern in interface FlightSql.CommandGetDbSchemasOrBuilder

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, 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;

Specified by:

getDbSchemaFilterPattern in interface FlightSql.CommandGetDbSchemasOrBuilder

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, 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;

Specified by:

getDbSchemaFilterPatternBytes in interface FlightSql.CommandGetDbSchemasOrBuilder

Returns:

The bytes for dbSchemaFilterPattern.

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.CommandGetDbSchemas parseFrom(ByteBuffer data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FlightSql.CommandGetDbSchemas parseFrom(com.google.protobuf.ByteString data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FlightSql.CommandGetDbSchemas parseFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static FlightSql.CommandGetDbSchemas parseDelimitedFrom(InputStream input)
                                                        throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static FlightSql.CommandGetDbSchemas parseFrom(com.google.protobuf.CodedInputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public FlightSql.CommandGetDbSchemas.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static FlightSql.CommandGetDbSchemas.Builder newBuilder()

newBuilder

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

toBuilder

public FlightSql.CommandGetDbSchemas.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected FlightSql.CommandGetDbSchemas.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static FlightSql.CommandGetDbSchemas getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<FlightSql.CommandGetDbSchemas> 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.CommandGetDbSchemas getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder