org.apache.arrow.flight.sql.impl

Class FlightSql.CommandGetExportedKeys.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

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

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

All Implemented Interfaces:

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

Enclosing class:

FlightSql.CommandGetExportedKeys

public static final class FlightSql.CommandGetExportedKeys.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetExportedKeys.Builder>
implements FlightSql.CommandGetExportedKeysOrBuilder

 Represents a request to retrieve a description of the foreign key columns that reference the given table's
 primary key columns (the foreign keys exported by a table) of a table 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:
 <
  pk_catalog_name: utf8,
  pk_db_schema_name: utf8,
  pk_table_name: utf8 not null,
  pk_column_name: utf8 not null,
  fk_catalog_name: utf8,
  fk_db_schema_name: utf8,
  fk_table_name: utf8 not null,
  fk_column_name: utf8 not null,
  key_sequence: int32 not null,
  fk_key_name: utf8,
  pk_key_name: utf8,
  update_rule: uint8 not null,
  delete_rule: uint8 not null
 >
 The returned data should be ordered by fk_catalog_name, fk_db_schema_name, fk_table_name, fk_key_name, then key_sequence.
 update_rule and delete_rule returns a byte that is equivalent to actions declared on UpdateDeleteRules enum.
 

Protobuf type arrow.flight.protocol.sql.CommandGetExportedKeys

Method Summary

Modifier and Type	Method and Description
FlightSql.CommandGetExportedKeys	build()
FlightSql.CommandGetExportedKeys	buildPartial()
FlightSql.CommandGetExportedKeys.Builder	clear()
FlightSql.CommandGetExportedKeys.Builder	clearCatalog() Specifies the catalog to search for the foreign key table.
FlightSql.CommandGetExportedKeys.Builder	clearDbSchema() Specifies the schema to search for the foreign key table.
FlightSql.CommandGetExportedKeys.Builder	clearTable() Specifies the foreign key table to get the foreign keys for.
String	getCatalog() Specifies the catalog to search for the foreign key table.
com.google.protobuf.ByteString	getCatalogBytes() Specifies the catalog to search for the foreign key table.
String	getDbSchema() Specifies the schema to search for the foreign key table.
com.google.protobuf.ByteString	getDbSchemaBytes() Specifies the schema to search for the foreign key table.
FlightSql.CommandGetExportedKeys	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getTable() Specifies the foreign key table to get the foreign keys for.
com.google.protobuf.ByteString	getTableBytes() Specifies the foreign key table to get the foreign keys for.
boolean	hasCatalog() Specifies the catalog to search for the foreign key table.
boolean	hasDbSchema() Specifies the schema to search for the foreign key table.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
FlightSql.CommandGetExportedKeys.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
FlightSql.CommandGetExportedKeys.Builder	mergeFrom(FlightSql.CommandGetExportedKeys other)
FlightSql.CommandGetExportedKeys.Builder	mergeFrom(com.google.protobuf.Message other)
FlightSql.CommandGetExportedKeys.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
FlightSql.CommandGetExportedKeys.Builder	setCatalog(String value) Specifies the catalog to search for the foreign key table.
FlightSql.CommandGetExportedKeys.Builder	setCatalogBytes(com.google.protobuf.ByteString value) Specifies the catalog to search for the foreign key table.
FlightSql.CommandGetExportedKeys.Builder	setDbSchema(String value) Specifies the schema to search for the foreign key table.
FlightSql.CommandGetExportedKeys.Builder	setDbSchemaBytes(com.google.protobuf.ByteString value) Specifies the schema to search for the foreign key table.
FlightSql.CommandGetExportedKeys.Builder	setTable(String value) Specifies the foreign key table to get the foreign keys for.
FlightSql.CommandGetExportedKeys.Builder	setTableBytes(com.google.protobuf.ByteString value) Specifies the foreign key table to get the foreign keys for.
FlightSql.CommandGetExportedKeys.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.CommandGetExportedKeys.Builder>

clear

public FlightSql.CommandGetExportedKeys.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.CommandGetExportedKeys.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.CommandGetExportedKeys.Builder>

getDefaultInstanceForType

public FlightSql.CommandGetExportedKeys getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public FlightSql.CommandGetExportedKeys build()

Specified by:

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

Specified by:

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

buildPartial

public FlightSql.CommandGetExportedKeys buildPartial()

Specified by:

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

Specified by:

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

mergeFrom

public FlightSql.CommandGetExportedKeys.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.CommandGetExportedKeys.Builder>

mergeFrom

public FlightSql.CommandGetExportedKeys.Builder mergeFrom(FlightSql.CommandGetExportedKeys 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.CommandGetExportedKeys.Builder>

mergeFrom

public FlightSql.CommandGetExportedKeys.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.CommandGetExportedKeys.Builder>

Throws:

IOException

hasCatalog

public boolean hasCatalog()

 Specifies the catalog to search for the foreign key table.
 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.CommandGetExportedKeysOrBuilder

Returns:

Whether the catalog field is set.

getCatalog

public String getCatalog()

 Specifies the catalog to search for the foreign key table.
 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.CommandGetExportedKeysOrBuilder

Returns:

The catalog.

getCatalogBytes

public com.google.protobuf.ByteString getCatalogBytes()

 Specifies the catalog to search for the foreign key table.
 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.CommandGetExportedKeysOrBuilder

Returns:

The bytes for catalog.

setCatalog

public FlightSql.CommandGetExportedKeys.Builder setCatalog(String value)

 Specifies the catalog to search for the foreign key table.
 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.CommandGetExportedKeys.Builder clearCatalog()

 Specifies the catalog to search for the foreign key table.
 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.CommandGetExportedKeys.Builder setCatalogBytes(com.google.protobuf.ByteString value)

 Specifies the catalog to search for the foreign key table.
 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.

hasDbSchema

public boolean hasDbSchema()

 Specifies the schema to search for the foreign key table.
 An empty string retrieves those without a schema.
 If omitted the schema name should not be used to narrow the search.
 

optional string db_schema = 2;

Specified by:

hasDbSchema in interface FlightSql.CommandGetExportedKeysOrBuilder

Returns:

Whether the dbSchema field is set.

getDbSchema

public String getDbSchema()

 Specifies the schema to search for the foreign key table.
 An empty string retrieves those without a schema.
 If omitted the schema name should not be used to narrow the search.
 

optional string db_schema = 2;

Specified by:

getDbSchema in interface FlightSql.CommandGetExportedKeysOrBuilder

Returns:

The dbSchema.

getDbSchemaBytes

public com.google.protobuf.ByteString getDbSchemaBytes()

 Specifies the schema to search for the foreign key table.
 An empty string retrieves those without a schema.
 If omitted the schema name should not be used to narrow the search.
 

optional string db_schema = 2;

Specified by:

getDbSchemaBytes in interface FlightSql.CommandGetExportedKeysOrBuilder

Returns:

The bytes for dbSchema.

setDbSchema

public FlightSql.CommandGetExportedKeys.Builder setDbSchema(String value)

 Specifies the schema to search for the foreign key table.
 An empty string retrieves those without a schema.
 If omitted the schema name should not be used to narrow the search.
 

optional string db_schema = 2;

Parameters:

value - The dbSchema to set.

Returns:

This builder for chaining.

clearDbSchema

public FlightSql.CommandGetExportedKeys.Builder clearDbSchema()

 Specifies the schema to search for the foreign key table.
 An empty string retrieves those without a schema.
 If omitted the schema name should not be used to narrow the search.
 

optional string db_schema = 2;

Returns:

This builder for chaining.

setDbSchemaBytes

public FlightSql.CommandGetExportedKeys.Builder setDbSchemaBytes(com.google.protobuf.ByteString value)

 Specifies the schema to search for the foreign key table.
 An empty string retrieves those without a schema.
 If omitted the schema name should not be used to narrow the search.
 

optional string db_schema = 2;

Parameters:

value - The bytes for dbSchema to set.

Returns:

This builder for chaining.

getTable

public String getTable()

 Specifies the foreign key table to get the foreign keys for.
 

string table = 3;

Specified by:

getTable in interface FlightSql.CommandGetExportedKeysOrBuilder

Returns:

The table.

getTableBytes

public com.google.protobuf.ByteString getTableBytes()

 Specifies the foreign key table to get the foreign keys for.
 

string table = 3;

Specified by:

getTableBytes in interface FlightSql.CommandGetExportedKeysOrBuilder

Returns:

The bytes for table.

setTable

public FlightSql.CommandGetExportedKeys.Builder setTable(String value)

 Specifies the foreign key table to get the foreign keys for.
 

string table = 3;

Parameters:

value - The table to set.

Returns:

This builder for chaining.

clearTable

public FlightSql.CommandGetExportedKeys.Builder clearTable()

 Specifies the foreign key table to get the foreign keys for.
 

string table = 3;

Returns:

This builder for chaining.

setTableBytes

public FlightSql.CommandGetExportedKeys.Builder setTableBytes(com.google.protobuf.ByteString value)

 Specifies the foreign key table to get the foreign keys for.
 

string table = 3;

Parameters:

value - The bytes for table to set.

Returns:

This builder for chaining.

setUnknownFields

public final FlightSql.CommandGetExportedKeys.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.CommandGetExportedKeys.Builder>

mergeUnknownFields

public final FlightSql.CommandGetExportedKeys.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.CommandGetExportedKeys.Builder>