Package com.clickhouse.client.grpc.impl

Interface QueryInfoOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
QueryInfo, QueryInfo.Builder
public interface QueryInfoOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getQuery

      String getQuery()
      string query = 1;
      Returns:
      The query.

    • getQueryBytes

      com.google.protobuf.ByteString getQueryBytes()
      string query = 1;
      Returns:
      The bytes for query.

    • getQueryId

      String getQueryId()
      string query_id = 2;
      Returns:
      The queryId.

    • getQueryIdBytes

      com.google.protobuf.ByteString getQueryIdBytes()
      string query_id = 2;
      Returns:
      The bytes for queryId.

    • getSettingsCount

      int getSettingsCount()
      map<string, string> settings = 3;

    • containsSettings

      boolean containsSettings(String key)
      map<string, string> settings = 3;

    • getSettings

      @Deprecated Map<String,String> getSettings()
      Deprecated.
      Use getSettingsMap() instead.

    • getSettingsMap

      Map<String,String> getSettingsMap()
      map<string, string> settings = 3;

    • getSettingsOrDefault

      String getSettingsOrDefault(String key, String defaultValue)
      map<string, string> settings = 3;

    • getSettingsOrThrow

      String getSettingsOrThrow(String key)
      map<string, string> settings = 3;

    • getDatabase

      String getDatabase()
       Default database.
      string database = 4;
      Returns:
      The database.

    • getDatabaseBytes

      com.google.protobuf.ByteString getDatabaseBytes()
       Default database.
      string database = 4;
      Returns:
      The bytes for database.

    • getInputData

      com.google.protobuf.ByteString getInputData()
       Input data, used both as data for INSERT query and as data for the input() function.
      bytes input_data = 5;
      Returns:
      The inputData.

    • getInputDataDelimiter

      com.google.protobuf.ByteString getInputDataDelimiter()
       Delimiter for input_data, inserted between input_data from adjacent QueryInfos.
      bytes input_data_delimiter = 6;
      Returns:
      The inputDataDelimiter.

    • getOutputFormat

      String getOutputFormat()
       Default output format. If not specified, 'TabSeparated' is used.
      string output_format = 7;
      Returns:
      The outputFormat.

    • getOutputFormatBytes

      com.google.protobuf.ByteString getOutputFormatBytes()
       Default output format. If not specified, 'TabSeparated' is used.
      string output_format = 7;
      Returns:
      The bytes for outputFormat.

    • getSendOutputColumns

      boolean getSendOutputColumns()
       Set it if you want the names and the types of output columns to be sent to the client.
      bool send_output_columns = 24;
      Returns:
      The sendOutputColumns.

    • getExternalTablesList

      List<ExternalTable> getExternalTablesList()
      repeated .clickhouse.grpc.ExternalTable external_tables = 8;

    • getExternalTables

      ExternalTable getExternalTables(int index)
      repeated .clickhouse.grpc.ExternalTable external_tables = 8;

    • getExternalTablesCount

      int getExternalTablesCount()
      repeated .clickhouse.grpc.ExternalTable external_tables = 8;

    • getExternalTablesOrBuilderList

      List<? extends ExternalTableOrBuilder> getExternalTablesOrBuilderList()
      repeated .clickhouse.grpc.ExternalTable external_tables = 8;

    • getExternalTablesOrBuilder

      ExternalTableOrBuilder getExternalTablesOrBuilder(int index)
      repeated .clickhouse.grpc.ExternalTable external_tables = 8;

    • getUserName

      String getUserName()
      string user_name = 9;
      Returns:
      The userName.

    • getUserNameBytes

      com.google.protobuf.ByteString getUserNameBytes()
      string user_name = 9;
      Returns:
      The bytes for userName.

    • getPassword

      String getPassword()
      string password = 10;
      Returns:
      The password.

    • getPasswordBytes

      com.google.protobuf.ByteString getPasswordBytes()
      string password = 10;
      Returns:
      The bytes for password.

    • getQuota

      String getQuota()
      string quota = 11;
      Returns:
      The quota.

    • getQuotaBytes

      com.google.protobuf.ByteString getQuotaBytes()
      string quota = 11;
      Returns:
      The bytes for quota.

    • getSessionId

      String getSessionId()
       Works exactly like sessions in the HTTP protocol.
      string session_id = 12;
      Returns:
      The sessionId.

    • getSessionIdBytes

      com.google.protobuf.ByteString getSessionIdBytes()
       Works exactly like sessions in the HTTP protocol.
      string session_id = 12;
      Returns:
      The bytes for sessionId.

    • getSessionCheck

      boolean getSessionCheck()
      bool session_check = 13;
      Returns:
      The sessionCheck.

    • getSessionTimeout

      int getSessionTimeout()
      uint32 session_timeout = 14;
      Returns:
      The sessionTimeout.

    • getCancel

      boolean getCancel()
       Set `cancel` to true to stop executing the query.
      bool cancel = 15;
      Returns:
      The cancel.

    • getNextQueryInfo

      boolean getNextQueryInfo()
       If true there will be at least one more QueryInfo in the input stream.
 `next_query_info` is allowed to be set only if a method with streaming input (i.e. ExecuteQueryWithStreamInput() or ExecuteQueryWithStreamIO()) is used.
      bool next_query_info = 16;
      Returns:
      The nextQueryInfo.

    • getInputCompressionType

      String getInputCompressionType()
       Compression type for `input_data`.
 Supported compression types: none, gzip(gz), deflate, brotli(br), lzma(xz), zstd(zst), lz4, bz2.
 The client is responsible to compress data before putting it into `input_data`.
      string input_compression_type = 20;
      Returns:
      The inputCompressionType.

    • getInputCompressionTypeBytes

      com.google.protobuf.ByteString getInputCompressionTypeBytes()
       Compression type for `input_data`.
 Supported compression types: none, gzip(gz), deflate, brotli(br), lzma(xz), zstd(zst), lz4, bz2.
 The client is responsible to compress data before putting it into `input_data`.
      string input_compression_type = 20;
      Returns:
      The bytes for inputCompressionType.

    • getOutputCompressionType

      String getOutputCompressionType()
       Compression type for `output_data`, `totals` and `extremes`.
 Supported compression types: none, gzip(gz), deflate, brotli(br), lzma(xz), zstd(zst), lz4, bz2.
 The client receives compressed data and should decompress it by itself.
 Consider also setting `output_compression_level`.
      string output_compression_type = 21;
      Returns:
      The outputCompressionType.

    • getOutputCompressionTypeBytes

      com.google.protobuf.ByteString getOutputCompressionTypeBytes()
       Compression type for `output_data`, `totals` and `extremes`.
 Supported compression types: none, gzip(gz), deflate, brotli(br), lzma(xz), zstd(zst), lz4, bz2.
 The client receives compressed data and should decompress it by itself.
 Consider also setting `output_compression_level`.
      string output_compression_type = 21;
      Returns:
      The bytes for outputCompressionType.

    • getOutputCompressionLevel

      int getOutputCompressionLevel()
       Compression level.
 WARNING: If it's not specified the compression level is set to zero by default which might be not the best choice for some compression types (see below).
 The compression level should be in the following range (the higher the number, the better the compression):
 none: compression level isn't used
 gzip: 0..9; 0 means no compression, 6 is recommended by default (compression level -1 also means 6)
 brotli: 0..11
 lzma: 0..9; 6 is recommended by default
 zstd: 1..22; 3 is recommended by default (compression level 0 also means 3)
 lz4: 0..16; values < 0 mean fast acceleration
 bz2: 1..9
      int32 output_compression_level = 19;
      Returns:
      The outputCompressionLevel.

    • getTransportCompressionType

      String getTransportCompressionType()
       Transport compression is an alternative way to make the server to compress its response.
 This kind of compression implies that instead of compressing just `output` the server will compress whole packed messages of the `Result` type,
 and then gRPC implementation on client side will decompress those messages so client code won't be bothered with decompression.
 Here is a big difference between the transport compression and the compression enabled by setting `output_compression_type` because
 in case of the transport compression the client code receives already decompressed data in `output`.
 If the transport compression is not set here it can still be enabled by the server configuration.
 Supported compression types: none, deflate, gzip, stream_gzip
 Supported compression levels: 0..3
 WARNING: Don't set `transport_compression` and `output_compression` at the same time because it will make the server to compress its output twice!
      string transport_compression_type = 22;
      Returns:
      The transportCompressionType.

    • getTransportCompressionTypeBytes

      com.google.protobuf.ByteString getTransportCompressionTypeBytes()
       Transport compression is an alternative way to make the server to compress its response.
 This kind of compression implies that instead of compressing just `output` the server will compress whole packed messages of the `Result` type,
 and then gRPC implementation on client side will decompress those messages so client code won't be bothered with decompression.
 Here is a big difference between the transport compression and the compression enabled by setting `output_compression_type` because
 in case of the transport compression the client code receives already decompressed data in `output`.
 If the transport compression is not set here it can still be enabled by the server configuration.
 Supported compression types: none, deflate, gzip, stream_gzip
 Supported compression levels: 0..3
 WARNING: Don't set `transport_compression` and `output_compression` at the same time because it will make the server to compress its output twice!
      string transport_compression_type = 22;
      Returns:
      The bytes for transportCompressionType.

    • getTransportCompressionLevel

      int getTransportCompressionLevel()
      int32 transport_compression_level = 23;
      Returns:
      The transportCompressionLevel.

    • hasObsoleteResultCompression

      boolean hasObsoleteResultCompression()
      / Obsolete fields, should not be used in new code.
      .clickhouse.grpc.ObsoleteTransportCompression obsolete_result_compression = 17;
      Returns:
      Whether the obsoleteResultCompression field is set.

    • getObsoleteResultCompression

      ObsoleteTransportCompression getObsoleteResultCompression()
      / Obsolete fields, should not be used in new code.
      .clickhouse.grpc.ObsoleteTransportCompression obsolete_result_compression = 17;
      Returns:
      The obsoleteResultCompression.

    • getObsoleteResultCompressionOrBuilder

      ObsoleteTransportCompressionOrBuilder getObsoleteResultCompressionOrBuilder()
      / Obsolete fields, should not be used in new code.
      .clickhouse.grpc.ObsoleteTransportCompression obsolete_result_compression = 17;

    • getObsoleteCompressionType

      String getObsoleteCompressionType()
      string obsolete_compression_type = 18;
      Returns:
      The obsoleteCompressionType.

    • getObsoleteCompressionTypeBytes

      com.google.protobuf.ByteString getObsoleteCompressionTypeBytes()
      string obsolete_compression_type = 18;
      Returns:
      The bytes for obsoleteCompressionType.