org.apache.arrow.flight.sql.impl

Class FlightSql.CommandGetCrossReference

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

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

Enclosing class:

FlightSql

public static final class FlightSql.CommandGetCrossReference
extends com.google.protobuf.GeneratedMessageV3
implements FlightSql.CommandGetCrossReferenceOrBuilder

 Represents a request to retrieve a description of the foreign key columns in the given foreign key table that
 reference the primary key or the columns representing a unique constraint of the parent table (could be the same
 or a different 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 pk_catalog_name, pk_db_schema_name, pk_table_name, pk_key_name, then key_sequence.
 update_rule and delete_rule returns a byte that is equivalent to actions:
    - 0 = CASCADE
    - 1 = RESTRICT
    - 2 = SET NULL
    - 3 = NO ACTION
    - 4 = SET DEFAULT
 

Protobuf type arrow.flight.protocol.sql.CommandGetCrossReference

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FlightSql.CommandGetCrossReference.Builder Represents a request to retrieve a description of the foreign key columns in the given foreign key table that reference the primary key or the columns representing a unique constraint of the parent table (could be the same or a different table) 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	FK_CATALOG_FIELD_NUMBER
static int	FK_DB_SCHEMA_FIELD_NUMBER
static int	FK_TABLE_FIELD_NUMBER
static int	PK_CATALOG_FIELD_NUMBER
static int	PK_DB_SCHEMA_FIELD_NUMBER
static int	PK_TABLE_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)
static FlightSql.CommandGetCrossReference	getDefaultInstance()
FlightSql.CommandGetCrossReference	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getFkCatalog() The catalog name where the foreign table is.
com.google.protobuf.ByteString	getFkCatalogBytes() The catalog name where the foreign table is.
String	getFkDbSchema() The schema name where the foreign table is.
com.google.protobuf.ByteString	getFkDbSchemaBytes() The schema name where the foreign table is.
String	getFkTable() The foreign table name.
com.google.protobuf.ByteString	getFkTableBytes() The foreign table name.
com.google.protobuf.Parser<FlightSql.CommandGetCrossReference>	getParserForType()
String	getPkCatalog() The catalog name where the parent table is.
com.google.protobuf.ByteString	getPkCatalogBytes() The catalog name where the parent table is.
String	getPkDbSchema() The Schema name where the parent table is.
com.google.protobuf.ByteString	getPkDbSchemaBytes() The Schema name where the parent table is.
String	getPkTable() The parent table name.
com.google.protobuf.ByteString	getPkTableBytes() The parent table name.
int	getSerializedSize()
boolean	hasFkCatalog() The catalog name where the foreign table is.
boolean	hasFkDbSchema() The schema name where the foreign table is.
int	hashCode()
boolean	hasPkCatalog() The catalog name where the parent table is.
boolean	hasPkDbSchema() The Schema name where the parent table is.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static FlightSql.CommandGetCrossReference.Builder	newBuilder()
static FlightSql.CommandGetCrossReference.Builder	newBuilder(FlightSql.CommandGetCrossReference prototype)
FlightSql.CommandGetCrossReference.Builder	newBuilderForType()
protected FlightSql.CommandGetCrossReference.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static FlightSql.CommandGetCrossReference	parseDelimitedFrom(InputStream input)
static FlightSql.CommandGetCrossReference	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandGetCrossReference	parseFrom(byte[] data)
static FlightSql.CommandGetCrossReference	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandGetCrossReference	parseFrom(ByteBuffer data)
static FlightSql.CommandGetCrossReference	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandGetCrossReference	parseFrom(com.google.protobuf.ByteString data)
static FlightSql.CommandGetCrossReference	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandGetCrossReference	parseFrom(com.google.protobuf.CodedInputStream input)
static FlightSql.CommandGetCrossReference	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlightSql.CommandGetCrossReference	parseFrom(InputStream input)
static FlightSql.CommandGetCrossReference	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<FlightSql.CommandGetCrossReference>	parser()
FlightSql.CommandGetCrossReference.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

PK_CATALOG_FIELD_NUMBER

public static final int PK_CATALOG_FIELD_NUMBER

See Also:

Constant Field Values

PK_DB_SCHEMA_FIELD_NUMBER

public static final int PK_DB_SCHEMA_FIELD_NUMBER

See Also:

Constant Field Values

PK_TABLE_FIELD_NUMBER

public static final int PK_TABLE_FIELD_NUMBER

See Also:

Constant Field Values

FK_CATALOG_FIELD_NUMBER

public static final int FK_CATALOG_FIELD_NUMBER

See Also:

Constant Field Values

FK_DB_SCHEMA_FIELD_NUMBER

public static final int FK_DB_SCHEMA_FIELD_NUMBER

See Also:

Constant Field Values

FK_TABLE_FIELD_NUMBER

public static final int FK_TABLE_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

hasPkCatalog

public boolean hasPkCatalog()

 The catalog name where the parent table is.
 An empty string retrieves those without a catalog.
 If omitted the catalog name should not be used to narrow the search.
 

optional string pk_catalog = 1;

Specified by:

hasPkCatalog in interface FlightSql.CommandGetCrossReferenceOrBuilder

Returns:

Whether the pkCatalog field is set.

getPkCatalog

public String getPkCatalog()

 The catalog name where the parent table is.
 An empty string retrieves those without a catalog.
 If omitted the catalog name should not be used to narrow the search.
 

optional string pk_catalog = 1;

Specified by:

getPkCatalog in interface FlightSql.CommandGetCrossReferenceOrBuilder

Returns:

The pkCatalog.

getPkCatalogBytes

public com.google.protobuf.ByteString getPkCatalogBytes()

 The catalog name where the parent table is.
 An empty string retrieves those without a catalog.
 If omitted the catalog name should not be used to narrow the search.
 

optional string pk_catalog = 1;

Specified by:

getPkCatalogBytes in interface FlightSql.CommandGetCrossReferenceOrBuilder

Returns:

The bytes for pkCatalog.

hasPkDbSchema

public boolean hasPkDbSchema()

 The Schema name where the parent table is.
 An empty string retrieves those without a schema.
 If omitted the schema name should not be used to narrow the search.
 

optional string pk_db_schema = 2;

Specified by:

hasPkDbSchema in interface FlightSql.CommandGetCrossReferenceOrBuilder

Returns:

Whether the pkDbSchema field is set.

getPkDbSchema

public String getPkDbSchema()

 The Schema name where the parent table is.
 An empty string retrieves those without a schema.
 If omitted the schema name should not be used to narrow the search.
 

optional string pk_db_schema = 2;

Specified by:

getPkDbSchema in interface FlightSql.CommandGetCrossReferenceOrBuilder

Returns:

The pkDbSchema.

getPkDbSchemaBytes

public com.google.protobuf.ByteString getPkDbSchemaBytes()

 The Schema name where the parent table is.
 An empty string retrieves those without a schema.
 If omitted the schema name should not be used to narrow the search.
 

optional string pk_db_schema = 2;

Specified by:

getPkDbSchemaBytes in interface FlightSql.CommandGetCrossReferenceOrBuilder

Returns:

The bytes for pkDbSchema.

getPkTable

public String getPkTable()

 The parent table name. It cannot be null.
 

string pk_table = 3;

Specified by:

getPkTable in interface FlightSql.CommandGetCrossReferenceOrBuilder

Returns:

The pkTable.

getPkTableBytes

public com.google.protobuf.ByteString getPkTableBytes()

 The parent table name. It cannot be null.
 

string pk_table = 3;

Specified by:

getPkTableBytes in interface FlightSql.CommandGetCrossReferenceOrBuilder

Returns:

The bytes for pkTable.

hasFkCatalog

public boolean hasFkCatalog()

 The catalog name where the foreign table is.
 An empty string retrieves those without a catalog.
 If omitted the catalog name should not be used to narrow the search.
 

optional string fk_catalog = 4;

Specified by:

hasFkCatalog in interface FlightSql.CommandGetCrossReferenceOrBuilder

Returns:

Whether the fkCatalog field is set.

getFkCatalog

public String getFkCatalog()

 The catalog name where the foreign table is.
 An empty string retrieves those without a catalog.
 If omitted the catalog name should not be used to narrow the search.
 

optional string fk_catalog = 4;

Specified by:

getFkCatalog in interface FlightSql.CommandGetCrossReferenceOrBuilder

Returns:

The fkCatalog.

getFkCatalogBytes

public com.google.protobuf.ByteString getFkCatalogBytes()

 The catalog name where the foreign table is.
 An empty string retrieves those without a catalog.
 If omitted the catalog name should not be used to narrow the search.
 

optional string fk_catalog = 4;

Specified by:

getFkCatalogBytes in interface FlightSql.CommandGetCrossReferenceOrBuilder

Returns:

The bytes for fkCatalog.

hasFkDbSchema

public boolean hasFkDbSchema()

 The schema name where the foreign table is.
 An empty string retrieves those without a schema.
 If omitted the schema name should not be used to narrow the search.
 

optional string fk_db_schema = 5;

Specified by:

hasFkDbSchema in interface FlightSql.CommandGetCrossReferenceOrBuilder

Returns:

Whether the fkDbSchema field is set.

getFkDbSchema

public String getFkDbSchema()

 The schema name where the foreign table is.
 An empty string retrieves those without a schema.
 If omitted the schema name should not be used to narrow the search.
 

optional string fk_db_schema = 5;

Specified by:

getFkDbSchema in interface FlightSql.CommandGetCrossReferenceOrBuilder

Returns:

The fkDbSchema.

getFkDbSchemaBytes

public com.google.protobuf.ByteString getFkDbSchemaBytes()

 The schema name where the foreign table is.
 An empty string retrieves those without a schema.
 If omitted the schema name should not be used to narrow the search.
 

optional string fk_db_schema = 5;

Specified by:

getFkDbSchemaBytes in interface FlightSql.CommandGetCrossReferenceOrBuilder

Returns:

The bytes for fkDbSchema.

getFkTable

public String getFkTable()

 The foreign table name. It cannot be null.
 

string fk_table = 6;

Specified by:

getFkTable in interface FlightSql.CommandGetCrossReferenceOrBuilder

Returns:

The fkTable.

getFkTableBytes

public com.google.protobuf.ByteString getFkTableBytes()

 The foreign table name. It cannot be null.
 

string fk_table = 6;

Specified by:

getFkTableBytes in interface FlightSql.CommandGetCrossReferenceOrBuilder

Returns:

The bytes for fkTable.

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public FlightSql.CommandGetCrossReference.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static FlightSql.CommandGetCrossReference.Builder newBuilder()

newBuilder

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

toBuilder

public FlightSql.CommandGetCrossReference.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static FlightSql.CommandGetCrossReference getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder