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 Detail

      • 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;

      • 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.

      • 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.

      • hasResultCompression

        boolean hasResultCompression()
        / Controls how a ClickHouse server will compress query execution results before sending back to the client.
 / If not set the compression settings from the configuration file will be used.
        .clickhouse.grpc.Compression result_compression = 17;
        Returns:
        Whether the resultCompression field is set.

      • getResultCompression

        Compression getResultCompression()
        / Controls how a ClickHouse server will compress query execution results before sending back to the client.
 / If not set the compression settings from the configuration file will be used.
        .clickhouse.grpc.Compression result_compression = 17;
        Returns:
        The resultCompression.

      • getResultCompressionOrBuilder

        CompressionOrBuilder getResultCompressionOrBuilder()
        / Controls how a ClickHouse server will compress query execution results before sending back to the client.
 / If not set the compression settings from the configuration file will be used.
        .clickhouse.grpc.Compression result_compression = 17;