Package com.clickhouse.client.grpc.impl

Class ExternalTable

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.clickhouse.client.grpc.impl.ExternalTable

All Implemented Interfaces:

ExternalTableOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class ExternalTable
extends com.google.protobuf.GeneratedMessageV3
implements ExternalTableOrBuilder

 Describes an external table - a table which will exists only while a query is executing.
 

Protobuf type clickhouse.grpc.ExternalTable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExternalTable.Builder	Describes an external table - a table which will exists only while a query is executing.

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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	Description
static int	COLUMNS_FIELD_NUMBER
static int	COMPRESSION_TYPE_FIELD_NUMBER
static int	DATA_FIELD_NUMBER
static int	FORMAT_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	SETTINGS_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	Description
boolean	containsSettings(String key)	Settings for executing that insertion, applied after QueryInfo.settings.
boolean	equals(Object obj)
NameAndType	getColumns(int index)	Columns of the table.
int	getColumnsCount()	Columns of the table.
List<NameAndType>	getColumnsList()	Columns of the table.
NameAndTypeOrBuilder	getColumnsOrBuilder(int index)	Columns of the table.
List<? extends NameAndTypeOrBuilder>	getColumnsOrBuilderList()	Columns of the table.
String	getCompressionType()	Compression type used to compress `data`.
com.google.protobuf.ByteString	getCompressionTypeBytes()	Compression type used to compress `data`.
com.google.protobuf.ByteString	getData()	Data to insert to the external table.
static ExternalTable	getDefaultInstance()
ExternalTable	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getFormat()	Format of the data to insert to the external table.
com.google.protobuf.ByteString	getFormatBytes()	Format of the data to insert to the external table.
String	getName()	Name of the table.
com.google.protobuf.ByteString	getNameBytes()	Name of the table.
com.google.protobuf.Parser<ExternalTable>	getParserForType()
int	getSerializedSize()
Map<String,String>	getSettings()	Deprecated.
int	getSettingsCount()	Settings for executing that insertion, applied after QueryInfo.settings.
Map<String,String>	getSettingsMap()	Settings for executing that insertion, applied after QueryInfo.settings.
String	getSettingsOrDefault(String key, String defaultValue)	Settings for executing that insertion, applied after QueryInfo.settings.
String	getSettingsOrThrow(String key)	Settings for executing that insertion, applied after QueryInfo.settings.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static ExternalTable.Builder	newBuilder()
static ExternalTable.Builder	newBuilder(ExternalTable prototype)
ExternalTable.Builder	newBuilderForType()
protected ExternalTable.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ExternalTable	parseDelimitedFrom(InputStream input)
static ExternalTable	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExternalTable	parseFrom(byte[] data)
static ExternalTable	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExternalTable	parseFrom(com.google.protobuf.ByteString data)
static ExternalTable	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExternalTable	parseFrom(com.google.protobuf.CodedInputStream input)
static ExternalTable	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExternalTable	parseFrom(InputStream input)
static ExternalTable	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExternalTable	parseFrom(ByteBuffer data)
static ExternalTable	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ExternalTable>	parser()
ExternalTable.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, hasField, hasOneof, makeExtensionsImmutable, 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.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

COLUMNS_FIELD_NUMBER

public static final int COLUMNS_FIELD_NUMBER

See Also:

Constant Field Values

DATA_FIELD_NUMBER

public static final int DATA_FIELD_NUMBER

See Also:

Constant Field Values

FORMAT_FIELD_NUMBER

public static final int FORMAT_FIELD_NUMBER

See Also:

Constant Field Values

COMPRESSION_TYPE_FIELD_NUMBER

public static final int COMPRESSION_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

SETTINGS_FIELD_NUMBER

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

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

 Name of the table. If omitted, "_data" is used.
 

string name = 1;

Specified by:

getName in interface ExternalTableOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Name of the table. If omitted, "_data" is used.
 

string name = 1;

Specified by:

getNameBytes in interface ExternalTableOrBuilder

Returns:

The bytes for name.

getColumnsList

public List<NameAndType> getColumnsList()

 Columns of the table. Types are required, names can be omitted. If the names are omitted, "_1", "_2", ... is used.
 

repeated .clickhouse.grpc.NameAndType columns = 2;

Specified by:

getColumnsList in interface ExternalTableOrBuilder

getColumnsOrBuilderList

public List<? extends NameAndTypeOrBuilder> getColumnsOrBuilderList()

 Columns of the table. Types are required, names can be omitted. If the names are omitted, "_1", "_2", ... is used.
 

repeated .clickhouse.grpc.NameAndType columns = 2;

Specified by:

getColumnsOrBuilderList in interface ExternalTableOrBuilder

getColumnsCount

public int getColumnsCount()

 Columns of the table. Types are required, names can be omitted. If the names are omitted, "_1", "_2", ... is used.
 

repeated .clickhouse.grpc.NameAndType columns = 2;

Specified by:

getColumnsCount in interface ExternalTableOrBuilder

getColumns

public NameAndType getColumns(int index)

 Columns of the table. Types are required, names can be omitted. If the names are omitted, "_1", "_2", ... is used.
 

repeated .clickhouse.grpc.NameAndType columns = 2;

Specified by:

getColumns in interface ExternalTableOrBuilder

getColumnsOrBuilder

public NameAndTypeOrBuilder getColumnsOrBuilder(int index)

 Columns of the table. Types are required, names can be omitted. If the names are omitted, "_1", "_2", ... is used.
 

repeated .clickhouse.grpc.NameAndType columns = 2;

Specified by:

getColumnsOrBuilder in interface ExternalTableOrBuilder

getData

public com.google.protobuf.ByteString getData()

 Data to insert to the external table.
 If a method with streaming input (i.e. ExecuteQueryWithStreamInput() or ExecuteQueryWithStreamIO()) is used,
 then data for insertion to the same external table can be split between multiple QueryInfos.
 

bytes data = 3;

Specified by:

getData in interface ExternalTableOrBuilder

Returns:

The data.

getFormat

public String getFormat()

 Format of the data to insert to the external table.
 

string format = 4;

Specified by:

getFormat in interface ExternalTableOrBuilder

Returns:

The format.

getFormatBytes

public com.google.protobuf.ByteString getFormatBytes()

 Format of the data to insert to the external table.
 

string format = 4;

Specified by:

getFormatBytes in interface ExternalTableOrBuilder

Returns:

The bytes for format.

getCompressionType

public String getCompressionType()

 Compression type used to compress `data`.
 Supported values: none, gzip(gz), deflate, brotli(br), lzma(xz), zstd(zst), lz4, bz2.
 

string compression_type = 6;

Specified by:

getCompressionType in interface ExternalTableOrBuilder

Returns:

The compressionType.

getCompressionTypeBytes

public com.google.protobuf.ByteString getCompressionTypeBytes()

 Compression type used to compress `data`.
 Supported values: none, gzip(gz), deflate, brotli(br), lzma(xz), zstd(zst), lz4, bz2.
 

string compression_type = 6;

Specified by:

getCompressionTypeBytes in interface ExternalTableOrBuilder

Returns:

The bytes for compressionType.

getSettingsCount

public int getSettingsCount()

Description copied from interface: ExternalTableOrBuilder

 Settings for executing that insertion, applied after QueryInfo.settings.
 

map<string, string> settings = 5;

Specified by:

getSettingsCount in interface ExternalTableOrBuilder

containsSettings

public boolean containsSettings(String key)

 Settings for executing that insertion, applied after QueryInfo.settings.
 

map<string, string> settings = 5;

Specified by:

containsSettings in interface ExternalTableOrBuilder

getSettings

@Deprecated
public Map<String,String> getSettings()

Deprecated.

Use getSettingsMap() instead.

Specified by:

getSettings in interface ExternalTableOrBuilder

getSettingsMap

public Map<String,String> getSettingsMap()

 Settings for executing that insertion, applied after QueryInfo.settings.
 

map<string, string> settings = 5;

Specified by:

getSettingsMap in interface ExternalTableOrBuilder

getSettingsOrDefault

public String getSettingsOrDefault(String key,
                                   String defaultValue)

 Settings for executing that insertion, applied after QueryInfo.settings.
 

map<string, string> settings = 5;

Specified by:

getSettingsOrDefault in interface ExternalTableOrBuilder

getSettingsOrThrow

public String getSettingsOrThrow(String key)

 Settings for executing that insertion, applied after QueryInfo.settings.
 

map<string, string> settings = 5;

Specified by:

getSettingsOrThrow in interface ExternalTableOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExternalTable parseFrom(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExternalTable parseFrom(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExternalTable parseFrom(InputStream input)
                               throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static ExternalTable parseDelimitedFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public ExternalTable.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ExternalTable.Builder newBuilder()

newBuilder

public static ExternalTable.Builder newBuilder(ExternalTable prototype)

toBuilder

public ExternalTable.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ExternalTable getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder