org.apache.arrow.flight.sql.impl

Class FlightSql.CommandGetDbSchemas.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetDbSchemas.Builder>

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

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, FlightSql.CommandGetDbSchemasOrBuilder

Enclosing class:

FlightSql.CommandGetDbSchemas

public static final class FlightSql.CommandGetDbSchemas.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetDbSchemas.Builder>
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

Method Summary

Modifier and Type	Method and Description
FlightSql.CommandGetDbSchemas	build()
FlightSql.CommandGetDbSchemas	buildPartial()
FlightSql.CommandGetDbSchemas.Builder	clear()
FlightSql.CommandGetDbSchemas.Builder	clearCatalog() Specifies the Catalog to search for the tables.
FlightSql.CommandGetDbSchemas.Builder	clearDbSchemaFilterPattern() Specifies a filter pattern for schemas to search for.
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.CommandGetDbSchemas	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	hasCatalog() Specifies the Catalog to search for the tables.
boolean	hasDbSchemaFilterPattern() Specifies a filter pattern for schemas to search for.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
FlightSql.CommandGetDbSchemas.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
FlightSql.CommandGetDbSchemas.Builder	mergeFrom(FlightSql.CommandGetDbSchemas other)
FlightSql.CommandGetDbSchemas.Builder	mergeFrom(com.google.protobuf.Message other)
FlightSql.CommandGetDbSchemas.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
FlightSql.CommandGetDbSchemas.Builder	setCatalog(String value) Specifies the Catalog to search for the tables.
FlightSql.CommandGetDbSchemas.Builder	setCatalogBytes(com.google.protobuf.ByteString value) Specifies the Catalog to search for the tables.
FlightSql.CommandGetDbSchemas.Builder	setDbSchemaFilterPattern(String value) Specifies a filter pattern for schemas to search for.
FlightSql.CommandGetDbSchemas.Builder	setDbSchemaFilterPatternBytes(com.google.protobuf.ByteString value) Specifies a filter pattern for schemas to search for.
FlightSql.CommandGetDbSchemas.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

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

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

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.Builder<FlightSql.CommandGetDbSchemas.Builder>

clear

public FlightSql.CommandGetDbSchemas.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetDbSchemas.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetDbSchemas.Builder>

getDefaultInstanceForType

public FlightSql.CommandGetDbSchemas getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public FlightSql.CommandGetDbSchemas build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public FlightSql.CommandGetDbSchemas buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public FlightSql.CommandGetDbSchemas.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FlightSql.CommandGetDbSchemas.Builder>

mergeFrom

public FlightSql.CommandGetDbSchemas.Builder mergeFrom(FlightSql.CommandGetDbSchemas other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetDbSchemas.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FlightSql.CommandGetDbSchemas.Builder>

Throws:

IOException

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.

setCatalog

public FlightSql.CommandGetDbSchemas.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;

Parameters:

value - The catalog to set.

Returns:

This builder for chaining.

clearCatalog

public FlightSql.CommandGetDbSchemas.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;

Returns:

This builder for chaining.

setCatalogBytes

public FlightSql.CommandGetDbSchemas.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;

Parameters:

value - The bytes for catalog to set.

Returns:

This builder for chaining.

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.

setDbSchemaFilterPattern

public FlightSql.CommandGetDbSchemas.Builder setDbSchemaFilterPattern(String value)

 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;

Parameters:

value - The dbSchemaFilterPattern to set.

Returns:

This builder for chaining.

clearDbSchemaFilterPattern

public FlightSql.CommandGetDbSchemas.Builder clearDbSchemaFilterPattern()

 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;

Returns:

This builder for chaining.

setDbSchemaFilterPatternBytes

public FlightSql.CommandGetDbSchemas.Builder setDbSchemaFilterPatternBytes(com.google.protobuf.ByteString value)

 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;

Parameters:

value - The bytes for dbSchemaFilterPattern to set.

Returns:

This builder for chaining.

setUnknownFields

public final FlightSql.CommandGetDbSchemas.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetDbSchemas.Builder>

mergeUnknownFields

public final FlightSql.CommandGetDbSchemas.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetDbSchemas.Builder>