public static final class FlightSql.CommandGetCrossReference.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetCrossReference.Builder> 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| Modifier and Type | Method and Description |
|---|---|
FlightSql.CommandGetCrossReference |
build() |
FlightSql.CommandGetCrossReference |
buildPartial() |
FlightSql.CommandGetCrossReference.Builder |
clear() |
FlightSql.CommandGetCrossReference.Builder |
clearFkCatalog()
The catalog name where the foreign table is.
|
FlightSql.CommandGetCrossReference.Builder |
clearFkDbSchema()
The schema name where the foreign table is.
|
FlightSql.CommandGetCrossReference.Builder |
clearFkTable()
The foreign table name.
|
FlightSql.CommandGetCrossReference.Builder |
clearPkCatalog()
The catalog name where the parent table is.
|
FlightSql.CommandGetCrossReference.Builder |
clearPkDbSchema()
The Schema name where the parent table is.
|
FlightSql.CommandGetCrossReference.Builder |
clearPkTable()
The parent table name.
|
FlightSql.CommandGetCrossReference |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
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.
|
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.
|
boolean |
hasFkCatalog()
The catalog name where the foreign table is.
|
boolean |
hasFkDbSchema()
The schema name where the foreign table is.
|
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() |
FlightSql.CommandGetCrossReference.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
FlightSql.CommandGetCrossReference.Builder |
mergeFrom(FlightSql.CommandGetCrossReference other) |
FlightSql.CommandGetCrossReference.Builder |
mergeFrom(com.google.protobuf.Message other) |
FlightSql.CommandGetCrossReference.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
FlightSql.CommandGetCrossReference.Builder |
setFkCatalog(String value)
The catalog name where the foreign table is.
|
FlightSql.CommandGetCrossReference.Builder |
setFkCatalogBytes(com.google.protobuf.ByteString value)
The catalog name where the foreign table is.
|
FlightSql.CommandGetCrossReference.Builder |
setFkDbSchema(String value)
The schema name where the foreign table is.
|
FlightSql.CommandGetCrossReference.Builder |
setFkDbSchemaBytes(com.google.protobuf.ByteString value)
The schema name where the foreign table is.
|
FlightSql.CommandGetCrossReference.Builder |
setFkTable(String value)
The foreign table name.
|
FlightSql.CommandGetCrossReference.Builder |
setFkTableBytes(com.google.protobuf.ByteString value)
The foreign table name.
|
FlightSql.CommandGetCrossReference.Builder |
setPkCatalog(String value)
The catalog name where the parent table is.
|
FlightSql.CommandGetCrossReference.Builder |
setPkCatalogBytes(com.google.protobuf.ByteString value)
The catalog name where the parent table is.
|
FlightSql.CommandGetCrossReference.Builder |
setPkDbSchema(String value)
The Schema name where the parent table is.
|
FlightSql.CommandGetCrossReference.Builder |
setPkDbSchemaBytes(com.google.protobuf.ByteString value)
The Schema name where the parent table is.
|
FlightSql.CommandGetCrossReference.Builder |
setPkTable(String value)
The parent table name.
|
FlightSql.CommandGetCrossReference.Builder |
setPkTableBytes(com.google.protobuf.ByteString value)
The parent table name.
|
FlightSql.CommandGetCrossReference.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
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, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetCrossReference.Builder>public FlightSql.CommandGetCrossReference.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetCrossReference.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetCrossReference.Builder>public FlightSql.CommandGetCrossReference getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic FlightSql.CommandGetCrossReference build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic FlightSql.CommandGetCrossReference buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic FlightSql.CommandGetCrossReference.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<FlightSql.CommandGetCrossReference.Builder>public FlightSql.CommandGetCrossReference.Builder mergeFrom(FlightSql.CommandGetCrossReference other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetCrossReference.Builder>public FlightSql.CommandGetCrossReference.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<FlightSql.CommandGetCrossReference.Builder>IOExceptionpublic 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;hasPkCatalog in interface FlightSql.CommandGetCrossReferenceOrBuilderpublic 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;getPkCatalog in interface FlightSql.CommandGetCrossReferenceOrBuilderpublic 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;getPkCatalogBytes in interface FlightSql.CommandGetCrossReferenceOrBuilderpublic FlightSql.CommandGetCrossReference.Builder setPkCatalog(String value)
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;value - The pkCatalog to set.public FlightSql.CommandGetCrossReference.Builder clearPkCatalog()
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;public FlightSql.CommandGetCrossReference.Builder setPkCatalogBytes(com.google.protobuf.ByteString value)
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;value - The bytes for pkCatalog to set.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;hasPkDbSchema in interface FlightSql.CommandGetCrossReferenceOrBuilderpublic 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;getPkDbSchema in interface FlightSql.CommandGetCrossReferenceOrBuilderpublic 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;getPkDbSchemaBytes in interface FlightSql.CommandGetCrossReferenceOrBuilderpublic FlightSql.CommandGetCrossReference.Builder setPkDbSchema(String value)
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;value - The pkDbSchema to set.public FlightSql.CommandGetCrossReference.Builder clearPkDbSchema()
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;public FlightSql.CommandGetCrossReference.Builder setPkDbSchemaBytes(com.google.protobuf.ByteString value)
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;value - The bytes for pkDbSchema to set.public String getPkTable()
The parent table name. It cannot be null.
string pk_table = 3;getPkTable in interface FlightSql.CommandGetCrossReferenceOrBuilderpublic com.google.protobuf.ByteString getPkTableBytes()
The parent table name. It cannot be null.
string pk_table = 3;getPkTableBytes in interface FlightSql.CommandGetCrossReferenceOrBuilderpublic FlightSql.CommandGetCrossReference.Builder setPkTable(String value)
The parent table name. It cannot be null.
string pk_table = 3;value - The pkTable to set.public FlightSql.CommandGetCrossReference.Builder clearPkTable()
The parent table name. It cannot be null.
string pk_table = 3;public FlightSql.CommandGetCrossReference.Builder setPkTableBytes(com.google.protobuf.ByteString value)
The parent table name. It cannot be null.
string pk_table = 3;value - The bytes for pkTable to set.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;hasFkCatalog in interface FlightSql.CommandGetCrossReferenceOrBuilderpublic 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;getFkCatalog in interface FlightSql.CommandGetCrossReferenceOrBuilderpublic 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;getFkCatalogBytes in interface FlightSql.CommandGetCrossReferenceOrBuilderpublic FlightSql.CommandGetCrossReference.Builder setFkCatalog(String value)
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;value - The fkCatalog to set.public FlightSql.CommandGetCrossReference.Builder clearFkCatalog()
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;public FlightSql.CommandGetCrossReference.Builder setFkCatalogBytes(com.google.protobuf.ByteString value)
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;value - The bytes for fkCatalog to set.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;hasFkDbSchema in interface FlightSql.CommandGetCrossReferenceOrBuilderpublic 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;getFkDbSchema in interface FlightSql.CommandGetCrossReferenceOrBuilderpublic 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;getFkDbSchemaBytes in interface FlightSql.CommandGetCrossReferenceOrBuilderpublic FlightSql.CommandGetCrossReference.Builder setFkDbSchema(String value)
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;value - The fkDbSchema to set.public FlightSql.CommandGetCrossReference.Builder clearFkDbSchema()
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;public FlightSql.CommandGetCrossReference.Builder setFkDbSchemaBytes(com.google.protobuf.ByteString value)
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;value - The bytes for fkDbSchema to set.public String getFkTable()
The foreign table name. It cannot be null.
string fk_table = 6;getFkTable in interface FlightSql.CommandGetCrossReferenceOrBuilderpublic com.google.protobuf.ByteString getFkTableBytes()
The foreign table name. It cannot be null.
string fk_table = 6;getFkTableBytes in interface FlightSql.CommandGetCrossReferenceOrBuilderpublic FlightSql.CommandGetCrossReference.Builder setFkTable(String value)
The foreign table name. It cannot be null.
string fk_table = 6;value - The fkTable to set.public FlightSql.CommandGetCrossReference.Builder clearFkTable()
The foreign table name. It cannot be null.
string fk_table = 6;public FlightSql.CommandGetCrossReference.Builder setFkTableBytes(com.google.protobuf.ByteString value)
The foreign table name. It cannot be null.
string fk_table = 6;value - The bytes for fkTable to set.public final FlightSql.CommandGetCrossReference.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetCrossReference.Builder>public final FlightSql.CommandGetCrossReference.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandGetCrossReference.Builder>Copyright © 2023 The Apache Software Foundation. All rights reserved.