executeQuery.cpp 34.1 KB
Newer Older
1
#include <Common/formatReadable.h>
2
#include <Common/PODArray.h>
3
#include <Common/typeid_cast.h>
4 5 6

#include <IO/ConcatReadBuffer.h>
#include <IO/WriteBufferFromFile.h>
7 8 9
#include <IO/WriteBufferFromVector.h>
#include <IO/LimitReadBuffer.h>
#include <IO/copyData.h>
10 11 12

#include <DataStreams/BlockIO.h>
#include <DataStreams/copyData.h>
13
#include <DataStreams/IBlockInputStream.h>
14 15 16 17
#include <DataStreams/InputStreamFromASTInsertQuery.h>
#include <DataStreams/CountingBlockOutputStream.h>

#include <Parsers/ASTInsertQuery.h>
18
#include <Parsers/ASTSelectQuery.h>
19 20 21 22 23
#include <Parsers/ASTShowProcesslistQuery.h>
#include <Parsers/ASTIdentifier.h>
#include <Parsers/ASTLiteral.h>
#include <Parsers/ParserQuery.h>
#include <Parsers/parseQuery.h>
24
#include <Parsers/queryToString.h>
25 26
#include <Parsers/ASTWatchQuery.h>
#include <Parsers/Lexer.h>
27

P
palasonicq 已提交
28 29
#include <Storages/StorageInput.h>

30
#include <Access/EnabledQuota.h>
31 32
#include <Interpreters/InterpreterFactory.h>
#include <Interpreters/ProcessList.h>
A
fixup  
Alexander Kuzmenkov 已提交
33
#include <Interpreters/OpenTelemetryLog.h>
34
#include <Interpreters/QueryLog.h>
35
#include <Interpreters/InterpreterSetQuery.h>
A
new  
Alexander Tretiakov 已提交
36
#include <Interpreters/ReplaceQueryParameterVisitor.h>
37
#include <Interpreters/executeQuery.h>
38
#include <Interpreters/Context.h>
M
Mikhail Filimonov 已提交
39
#include <Common/ProfileEvents.h>
40

41
#include <Interpreters/DNSCacheUpdater.h>
42
#include <Common/SensitiveDataMasker.h>
A
Alexey Milovidov 已提交
43

N
Nikolai Kochetov 已提交
44
#include <Processors/Transforms/LimitsCheckingTransform.h>
45
#include <Processors/Transforms/MaterializingTransform.h>
N
Nikolai Kochetov 已提交
46
#include <Processors/Formats/IOutputFormat.h>
A
Alexey Milovidov 已提交
47

A
Alexey Milovidov 已提交
48

M
Mikhail Filimonov 已提交
49 50 51
namespace ProfileEvents
{
    extern const Event QueryMaskingRulesMatch;
52 53 54
    extern const Event FailedQuery;
    extern const Event FailedInsertQuery;
    extern const Event FailedSelectQuery;
55 56 57
    extern const Event QueryTimeMicroseconds;
    extern const Event SelectQueryTimeMicroseconds;
    extern const Event InsertQueryTimeMicroseconds;
M
Mikhail Filimonov 已提交
58 59
}

A
Alexey Milovidov 已提交
60 61 62
namespace DB
{

63 64
namespace ErrorCodes
{
65
    extern const int INTO_OUTFILE_NOT_ALLOWED;
66
    extern const int QUERY_WAS_CANCELLED;
67 68
}

A
Alexey Milovidov 已提交
69

70
static void checkASTSizeLimits(const IAST & ast, const Settings & settings)
71
{
72 73 74 75
    if (settings.max_ast_depth)
        ast.checkDepth(settings.max_ast_depth);
    if (settings.max_ast_elements)
        ast.checkSize(settings.max_ast_elements);
76
}
77

78

79 80
static String joinLines(const String & query)
{
81
    /// Care should be taken. We don't join lines inside non-whitespace tokens (e.g. multiline string literals)
A
Alexey Milovidov 已提交
82
    ///  and we don't join line after comment (because it can be single-line comment).
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
    /// All other whitespaces replaced to a single whitespace.

    String res;
    const char * begin = query.data();
    const char * end = begin + query.size();

    Lexer lexer(begin, end);
    Token token = lexer.nextToken();
    for (; !token.isEnd(); token = lexer.nextToken())
    {
        if (token.type == TokenType::Whitespace)
        {
            res += ' ';
        }
        else if (token.type == TokenType::Comment)
        {
            res.append(token.begin, token.end);
            if (token.end < end && *token.end == '\n')
                res += '\n';
        }
        else
            res.append(token.begin, token.end);
    }

107
    return res;
108 109 110
}


M
Mikhail Filimonov 已提交
111 112 113 114
static String prepareQueryForLogging(const String & query, Context & context)
{
    String res = query;

115 116
    // wiping sensitive data before cropping query by log_queries_cut_to_length,
    // otherwise something like credit card without last digit can go to log
A
Alexey Milovidov 已提交
117
    if (auto * masker = SensitiveDataMasker::getInstance())
M
Mikhail Filimonov 已提交
118 119 120 121 122 123 124
    {
        auto matches = masker->wipeSensitiveData(res);
        if (matches > 0)
        {
            ProfileEvents::increment(ProfileEvents::QueryMaskingRulesMatch, matches);
        }
    }
125 126 127

    res = res.substr(0, context.getSettingsRef().log_queries_cut_to_length);

M
Mikhail Filimonov 已提交
128 129 130 131
    return res;
}


132
/// Log query into text log (not into system table).
A
Alexey Milovidov 已提交
133
static void logQuery(const String & query, const Context & context, bool internal)
134
{
A
Alexey Milovidov 已提交
135 136
    if (internal)
    {
A
Alexey Milovidov 已提交
137
        LOG_DEBUG(&Poco::Logger::get("executeQuery"), "(internal) {}", joinLines(query));
A
Alexey Milovidov 已提交
138 139 140 141 142 143 144
    }
    else
    {
        const auto & current_query_id = context.getClientInfo().current_query_id;
        const auto & initial_query_id = context.getClientInfo().initial_query_id;
        const auto & current_user = context.getClientInfo().current_user;

A
Alexey Milovidov 已提交
145
        LOG_DEBUG(&Poco::Logger::get("executeQuery"), "(from {}{}{}) {}",
A
Alexey Milovidov 已提交
146 147 148 149
            context.getClientInfo().current_address.toString(),
            (current_user != "default" ? ", user: " + context.getClientInfo().current_user : ""),
            (!initial_query_id.empty() && current_query_id != initial_query_id ? ", initial_query_id: " + initial_query_id : std::string()),
            joinLines(query));
A
fixup  
Alexander Kuzmenkov 已提交
150 151 152 153 154
        
        LOG_TRACE(&Poco::Logger::get("executeQuery"),
            "OpenTelemetry trace id {:x}, span id {:x}, parent span id {:x}",
            context.getClientInfo().trace_id, context.getClientInfo().span_id,
            context.getClientInfo().parent_span_id);
A
Alexey Milovidov 已提交
155
    }
156 157 158 159 160 161
}


/// Call this inside catch block.
static void setExceptionStackTrace(QueryLogElement & elem)
{
162 163
    /// Disable memory tracker for stack trace.
    /// Because if exception is "Memory limit (for query) exceed", then we probably can't allocate another one string.
164
    auto temporarily_disable_memory_tracker = getCurrentMemoryTrackerActionLock();
165

166 167 168 169
    try
    {
        throw;
    }
170
    catch (const std::exception & e)
171
    {
172
        elem.stack_trace = getExceptionStackTraceString(e);
173 174
    }
    catch (...) {}
175 176 177 178 179 180
}


/// Log exception (with query info) into text log (not into system table).
static void logException(Context & context, QueryLogElement & elem)
{
A
Alexey Milovidov 已提交
181
    if (elem.stack_trace.empty())
A
Alexey Milovidov 已提交
182
        LOG_ERROR(&Poco::Logger::get("executeQuery"), "{} (from {}) (in query: {})",
A
Alexey Milovidov 已提交
183 184
            elem.exception, context.getClientInfo().current_address.toString(), joinLines(elem.query));
    else
A
Alexey Milovidov 已提交
185
        LOG_ERROR(&Poco::Logger::get("executeQuery"), "{} (from {}) (in query: {})"
A
Alexey Milovidov 已提交
186 187
            ", Stack trace (when copying this message, always include the lines below):\n\n{}",
            elem.exception, context.getClientInfo().current_address.toString(), joinLines(elem.query), elem.stack_trace);
188 189 190
}


191
static void onExceptionBeforeStart(const String & query_for_logging, Context & context, time_t current_time, ASTPtr ast)
192
{
193
    /// Exception before the query execution.
194 195
    if (auto quota = context.getQuota())
        quota->used(Quota::ERRORS, 1, /* check_exceeded = */ false);
196

197
    const Settings & settings = context.getSettingsRef();
198

199
    /// Log the start of query execution into the table if necessary.
200
    QueryLogElement elem;
201

202
    elem.type = QueryLogElementType::EXCEPTION_BEFORE_START;
203

204 205
    elem.event_time = current_time;
    elem.query_start_time = current_time;
206

207
    elem.current_database = context.getCurrentDatabase();
M
Mikhail Filimonov 已提交
208
    elem.query = query_for_logging;
M
millb 已提交
209
    elem.exception_code = getCurrentExceptionCode();
210
    elem.exception = getCurrentExceptionMessage(false);
211

212
    elem.client_info = context.getClientInfo();
213

214 215
    if (settings.calculate_text_stack_trace)
        setExceptionStackTrace(elem);
216
    logException(context, elem);
217

218 219 220
    /// Update performance counters before logging to query_log
    CurrentThread::finalizePerformanceCounters();

221
    if (settings.log_queries && elem.type >= settings.log_queries_min_type)
222 223
        if (auto query_log = context.getQueryLog())
            query_log->add(elem);
224

A
fixup  
Alexander Kuzmenkov 已提交
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
    if (auto opentelemetry_log = context.getOpenTelemetryLog())
    {
        OpenTelemetrySpanLogElement span;
        span.trace_id = context.getClientInfo().trace_id;
        span.span_id = context.getClientInfo().span_id;
        span.parent_span_id = context.getClientInfo().parent_span_id;
        span.operation_name = "query";
        span.start_time = current_time;
        span.finish_time = current_time;

        // keep values synchonized to type enum in QueryLogElement::createBlock
        span.attribute_names.push_back("status");
        span.attribute_values.push_back("ExceptionBeforeStart");

        span.attribute_names.push_back("query");
        span.attribute_values.push_back(elem.query);

        span.attribute_names.push_back("query_id");
        span.attribute_values.push_back(elem.client_info.current_query_id);

        opentelemetry_log->add(span);
    }

248 249 250 251 252 253 254 255 256 257 258 259 260
    ProfileEvents::increment(ProfileEvents::FailedQuery);

    if (ast)
    {
        if (ast->as<ASTSelectQuery>() || ast->as<ASTSelectWithUnionQuery>())
        {
            ProfileEvents::increment(ProfileEvents::FailedSelectQuery);
        }
        else if (ast->as<ASTInsertQuery>())
        {
            ProfileEvents::increment(ProfileEvents::FailedInsertQuery);
        }
    }
261 262
}

263 264 265 266 267
static void setQuerySpecificSettings(ASTPtr & ast, Context & context)
{
    if (auto * ast_insert_into = dynamic_cast<ASTInsertQuery *>(ast.get()))
    {
        if (ast_insert_into->watch)
268
            context.setSetting("output_format_enable_streaming", 1);
269 270
    }
}
271

272
static std::tuple<ASTPtr, BlockIO> executeQueryImpl(
273 274
    const char * begin,
    const char * end,
275 276
    Context & context,
    bool internal,
A
alesapin 已提交
277
    QueryProcessingStage::Enum stage,
278
    bool has_query_tail,
279
    ReadBuffer * istr)
280
{
281
    time_t current_time = time(nullptr);
282

283 284 285 286 287 288 289
    /// If we already executing query and it requires to execute internal query, than
    /// don't replace thread context with given (it can be temporary). Otherwise, attach context to thread.
    if (!internal)
    {
        context.makeQueryContext();
        CurrentThread::attachQueryContext(context);
    }
290

291 292
    const Settings & settings = context.getSettingsRef();

293
    ParserQuery parser(end, settings.enable_debug_queries);
294
    ASTPtr ast;
295
    const char * query_end;
296 297 298 299 300

    /// Don't limit the size of internal queries.
    size_t max_query_size = 0;
    if (!internal)
        max_query_size = settings.max_query_size;
301 302 303

    try
    {
304
        /// TODO Parser should fail early when max_query_size limit is reached.
305
        ast = parseQuery(parser, begin, end, "", max_query_size, settings.max_parser_depth);
306

I
Ivan Lezhankin 已提交
307
        auto * insert_query = ast->as<ASTInsertQuery>();
Z
zhang2014 已提交
308 309 310 311

        if (insert_query && insert_query->settings_ast)
            InterpreterSetQuery(insert_query->settings_ast, context).executeForCurrentContext();

312
        if (insert_query && insert_query->data)
A
alesapin 已提交
313
        {
314
            query_end = insert_query->data;
A
alesapin 已提交
315 316
            insert_query->has_tail = has_query_tail;
        }
317
        else
A
Alexey Milovidov 已提交
318
        {
319
            query_end = end;
A
Alexey Milovidov 已提交
320
        }
321 322 323
    }
    catch (...)
    {
A
Alexey Milovidov 已提交
324 325
        /// Anyway log the query.
        String query = String(begin, begin + std::min(end - begin, static_cast<ptrdiff_t>(max_query_size)));
M
Mikhail Filimonov 已提交
326 327 328

        auto query_for_logging = prepareQueryForLogging(query, context);
        logQuery(query_for_logging, context, internal);
A
Alexey Milovidov 已提交
329

330
        if (!internal)
331
            onExceptionBeforeStart(query_for_logging, context, current_time, ast);
332

333 334
        throw;
    }
335

336 337
    setQuerySpecificSettings(ast, context);

338 339
    /// Copy query into string. It will be written to log and presented in processlist. If an INSERT query, string will not include data to insertion.
    String query(begin, query_end);
340
    BlockIO res;
341

A
Alexey Milovidov 已提交
342
    String query_for_logging;
M
Mikhail Filimonov 已提交
343

344 345
    try
    {
A
Alexey Milovidov 已提交
346
        /// Replace ASTQueryParameter with ASTLiteral for prepared statements.
A
Merging  
Alexey Milovidov 已提交
347 348 349 350
        if (context.hasQueryParameters())
        {
            ReplaceQueryParameterVisitor visitor(context.getQueryParameters());
            visitor.visit(ast);
A
Alexey Milovidov 已提交
351

A
Alexey Milovidov 已提交
352
            /// Get new query after substitutions.
A
Alexander Tretiakov 已提交
353
            query = serializeAST(*ast);
A
Alexey Milovidov 已提交
354
        }
A
Alexander Tretiakov 已提交
355

M
Mikhail Filimonov 已提交
356 357 358
        query_for_logging = prepareQueryForLogging(query, context);

        logQuery(query_for_logging, context, internal);
359

360
        /// Check the limits.
361
        checkASTSizeLimits(*ast, settings);
362 363 364

        /// Put query to process list. But don't put SHOW PROCESSLIST query itself.
        ProcessList::EntryPtr process_list_entry;
I
Ivan Lezhankin 已提交
365
        if (!internal && !ast->as<ASTShowProcesslistQuery>())
366
        {
M
Mikhail Filimonov 已提交
367 368
            /// processlist also has query masked now, to avoid secrets leaks though SHOW PROCESSLIST by other users.
            process_list_entry = context.getProcessList().insert(query_for_logging, ast.get(), context);
369 370 371
            context.setProcessListElement(&process_list_entry->get());
        }

372 373 374
        /// Load external tables if they were provided
        context.initializeExternalTablesIfSet();

P
palasonicq 已提交
375
        auto * insert_query = ast->as<ASTInsertQuery>();
376
        if (insert_query && insert_query->select)
P
palasonicq 已提交
377
        {
378
            /// Prepare Input storage before executing interpreter if we already got a buffer with data.
P
palasonicq 已提交
379 380
            if (istr)
            {
381
                ASTPtr input_function;
P
palasonicq 已提交
382
                insert_query->tryFindInputFunction(input_function);
383 384 385 386
                if (input_function)
                {
                    StoragePtr storage = context.executeTableFunction(input_function);
                    auto & input_storage = dynamic_cast<StorageInput &>(*storage);
387 388 389
                    auto input_metadata_snapshot = input_storage.getInMemoryMetadataPtr();
                    BlockInputStreamPtr input_stream = std::make_shared<InputStreamFromASTInsertQuery>(
                        ast, istr, input_metadata_snapshot->getSampleBlock(), context, input_function);
390 391
                    input_storage.setInputStream(input_stream);
                }
P
palasonicq 已提交
392 393 394 395 396 397
            }
        }
        else
            /// reset Input callbacks if query is not INSERT SELECT
            context.resetInputCallbacks();

398
        auto interpreter = InterpreterFactory::get(ast, context, stage);
N
Nikolai Kochetov 已提交
399

400
        std::shared_ptr<const EnabledQuota> quota;
401 402 403
        if (!interpreter->ignoreQuota())
        {
            quota = context.getQuota();
404 405 406 407 408
            if (quota)
            {
                quota->used(Quota::QUERIES, 1);
                quota->checkExceeded(Quota::ERRORS);
            }
409 410 411 412 413 414 415 416 417
        }

        IBlockInputStream::LocalLimits limits;
        if (!interpreter->ignoreLimits())
        {
            limits.mode = IBlockInputStream::LIMITS_CURRENT;
            limits.size_limits = SizeLimits(settings.max_result_rows, settings.max_result_bytes, settings.result_overflow_mode);
        }

N
Nikolai Kochetov 已提交
418 419 420
        res = interpreter->execute();
        QueryPipeline & pipeline = res.pipeline;
        bool use_processors = pipeline.initialized();
N
Nikolai Kochetov 已提交
421

422 423 424
        if (res.pipeline.initialized())
            use_processors = true;

A
Alexey Milovidov 已提交
425
        if (const auto * insert_interpreter = typeid_cast<const InterpreterInsertQuery *>(&*interpreter))
426 427
        {
            /// Save insertion table (not table function). TODO: support remote() table function.
428 429 430
            auto table_id = insert_interpreter->getDatabaseTable();
            if (!table_id.empty())
                context.setInsertionTable(std::move(table_id));
431
        }
432 433

        if (process_list_entry)
434 435 436 437 438
        {
            /// Query was killed before execution
            if ((*process_list_entry)->isKilled())
                throw Exception("Query '" + (*process_list_entry)->getInfo().client_info.current_query_id + "' is killed in pending state",
                    ErrorCodes::QUERY_WAS_CANCELLED);
N
Nikolai Kochetov 已提交
439
            else if (!use_processors)
440 441
                (*process_list_entry)->setQueryStreams(res);
        }
442 443 444 445

        /// Hold element of process list till end of query execution.
        res.process_list_entry = process_list_entry;

N
Nikolai Kochetov 已提交
446
        if (use_processors)
447
        {
448 449
            /// Limits on the result, the quota on the result, and also callback for progress.
            /// Limits apply only to the final result.
450 451
            pipeline.setProgressCallback(context.getProgressCallback());
            pipeline.setProcessListElement(context.getProcessListElement());
452
            if (stage == QueryProcessingStage::Complete && !pipeline.isCompleted())
453
            {
N
Nikolai Kochetov 已提交
454
                pipeline.resize(1);
N
Nikolai Kochetov 已提交
455 456
                pipeline.addSimpleTransform([&](const Block & header)
                {
N
Nikolai Kochetov 已提交
457 458 459 460
                    auto transform = std::make_shared<LimitsCheckingTransform>(header, limits);
                    transform->setQuota(quota);
                    return transform;
                });
461 462
            }
        }
N
Nikolai Kochetov 已提交
463
        else
464
        {
465 466
            /// Limits on the result, the quota on the result, and also callback for progress.
            /// Limits apply only to the final result.
N
Nikolai Kochetov 已提交
467
            if (res.in)
468
            {
N
Nikolai Kochetov 已提交
469 470 471 472
                res.in->setProgressCallback(context.getProgressCallback());
                res.in->setProcessListElement(context.getProcessListElement());
                if (stage == QueryProcessingStage::Complete)
                {
473 474 475 476
                    if (!interpreter->ignoreQuota())
                        res.in->setQuota(quota);
                    if (!interpreter->ignoreLimits())
                        res.in->setLimits(limits);
N
Nikolai Kochetov 已提交
477 478 479 480
                }
            }

            if (res.out)
481
            {
A
Alexey Milovidov 已提交
482
                if (auto * stream = dynamic_cast<CountingBlockOutputStream *>(res.out.get()))
N
Nikolai Kochetov 已提交
483 484 485
                {
                    stream->setProcessListElement(context.getProcessListElement());
                }
486 487 488 489 490 491 492
            }
        }

        /// Everything related to query log.
        {
            QueryLogElement elem;

493
            elem.type = QueryLogElementType::QUERY_START;
494 495 496 497

            elem.event_time = current_time;
            elem.query_start_time = current_time;

498
            elem.current_database = context.getCurrentDatabase();
M
Mikhail Filimonov 已提交
499
            elem.query = query_for_logging;
500 501 502 503 504 505

            elem.client_info = context.getClientInfo();

            bool log_queries = settings.log_queries && !internal;

            /// Log into system table start of query execution, if need.
506
            if (log_queries)
507
            {
508 509 510
                if (settings.log_query_settings)
                    elem.query_settings = std::make_shared<Settings>(context.getSettingsRef());

511 512 513 514 515
                if (elem.type >= settings.log_queries_min_type)
                {
                    if (auto query_log = context.getQueryLog())
                        query_log->add(elem);
                }
516
            }
517

518
            /// Common code for finish and exception callbacks
519
            auto status_info_to_query_log = [](QueryLogElement &element, const QueryStatusInfo &info, const ASTPtr query_ast) mutable
520 521 522
            {
                DB::UInt64 query_time = info.elapsed_seconds * 1000000;
                ProfileEvents::increment(ProfileEvents::QueryTimeMicroseconds, query_time);
523
                if (query_ast->as<ASTSelectQuery>() || query_ast->as<ASTSelectWithUnionQuery>())
524 525 526
                {
                    ProfileEvents::increment(ProfileEvents::SelectQueryTimeMicroseconds, query_time);
                }
527
                else if (query_ast->as<ASTInsertQuery>())
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545
                {
                    ProfileEvents::increment(ProfileEvents::InsertQueryTimeMicroseconds, query_time);
                }

                element.query_duration_ms = info.elapsed_seconds * 1000;

                element.read_rows = info.read_rows;
                element.read_bytes = info.read_bytes;

                element.written_rows = info.written_rows;
                element.written_bytes = info.written_bytes;

                element.memory_usage = info.peak_memory_usage > 0 ? info.peak_memory_usage : 0;

                element.thread_ids = std::move(info.thread_ids);
                element.profile_counters = std::move(info.profile_counters);
            };

546
            /// Also make possible for caller to log successful query finish and exception during execution.
547 548
            auto finish_callback = [elem, &context, ast, log_queries, log_queries_min_type = settings.log_queries_min_type,
                status_info_to_query_log]
549
                (IBlockInputStream * stream_in, IBlockOutputStream * stream_out, QueryPipeline * query_pipeline) mutable
550
            {
551
                QueryStatus * process_list_elem = context.getProcessListElement();
552 553 554 555

                if (!process_list_elem)
                    return;

556
                /// Update performance counters before logging to query_log
557
                CurrentThread::finalizePerformanceCounters();
558

559
                QueryStatusInfo info = process_list_elem->getInfo(true, context.getSettingsRef().log_profile_events);
560 561

                double elapsed_seconds = info.elapsed_seconds;
562

563
                elem.type = QueryLogElementType::QUERY_FINISH;
564

565
                elem.event_time = time(nullptr);
566

567
                status_info_to_query_log(elem, info, ast);
568

569
                auto progress_callback = context.getProgressCallback();
G
Guillaume Tassery 已提交
570

571 572 573
                if (progress_callback)
                    progress_callback(Progress(WriteProgress(info.written_rows, info.written_bytes)));

574 575
                if (stream_in)
                {
576
                    const BlockStreamProfileInfo & stream_in_info = stream_in->getProfileInfo();
577

578 579 580
                    /// NOTE: INSERT SELECT query contains zero metrics
                    elem.result_rows = stream_in_info.rows;
                    elem.result_bytes = stream_in_info.bytes;
581 582 583
                }
                else if (stream_out) /// will be used only for ordinary INSERT queries
                {
A
Alexey Milovidov 已提交
584
                    if (const auto * counting_stream = dynamic_cast<const CountingBlockOutputStream *>(stream_out))
585
                    {
M
maiha 已提交
586
                        /// NOTE: Redundancy. The same values could be extracted from process_list_elem->progress_out.query_settings = process_list_elem->progress_in
587 588
                        elem.result_rows = counting_stream->getProgress().read_rows;
                        elem.result_bytes = counting_stream->getProgress().read_bytes;
589 590
                    }
                }
591 592 593 594 595 596 597 598
                else if (query_pipeline)
                {
                    if (const auto * output_format = query_pipeline->getOutputFormat())
                    {
                        elem.result_rows = output_format->getResultRows();
                        elem.result_bytes = output_format->getResultBytes();
                    }
                }
599 600 601

                if (elem.read_rows != 0)
                {
A
Alexey Milovidov 已提交
602
                    LOG_INFO(&Poco::Logger::get("executeQuery"), "Read {} rows, {} in {} sec., {} rows/sec., {}/sec.",
603
                        elem.read_rows, ReadableSize(elem.read_bytes), elapsed_seconds,
A
Alexey Milovidov 已提交
604
                        static_cast<size_t>(elem.read_rows / elapsed_seconds),
605
                        ReadableSize(elem.read_bytes / elapsed_seconds));
606 607
                }

A
Alexey Milovidov 已提交
608
                elem.thread_ids = std::move(info.thread_ids);
609 610
                elem.profile_counters = std::move(info.profile_counters);

611
                if (log_queries && elem.type >= log_queries_min_type)
612 613 614 615
                {
                    if (auto query_log = context.getQueryLog())
                        query_log->add(elem);
                }
A
Alexander Kuzmenkov 已提交
616 617 618

                if (auto opentelemetry_log = context.getOpenTelemetryLog())
                {
A
fixup  
Alexander Kuzmenkov 已提交
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
                    OpenTelemetrySpanLogElement span;
                    span.trace_id = context.getClientInfo().trace_id;
                    span.span_id = context.getClientInfo().span_id;
                    span.parent_span_id = context.getClientInfo().parent_span_id;
                    span.operation_name = "query";
                    span.start_time = elem.query_start_time;
                    span.finish_time = time(nullptr); // current time

                    // keep values synchonized to type enum in QueryLogElement::createBlock
                    span.attribute_names.push_back("status");
                    span.attribute_values.push_back("QueryFinish");

                    span.attribute_names.push_back("query");
                    span.attribute_values.push_back(elem.query);

                    span.attribute_names.push_back("query_id");
                    span.attribute_values.push_back(elem.client_info.current_query_id);

                    opentelemetry_log->add(span);
A
Alexander Kuzmenkov 已提交
638
                }
639 640
            };

641 642
            auto exception_callback = [elem, &context, ast, log_queries, log_queries_min_type = settings.log_queries_min_type, quota(quota),
                    status_info_to_query_log] () mutable
643
            {
644 645
                if (quota)
                    quota->used(Quota::ERRORS, 1, /* check_exceeded = */ false);
646

647
                elem.type = QueryLogElementType::EXCEPTION_WHILE_PROCESSING;
648

649
                elem.event_time = time(nullptr);
650
                elem.query_duration_ms = 1000 * (elem.event_time - elem.query_start_time);
M
millb 已提交
651
                elem.exception_code = getCurrentExceptionCode();
652 653
                elem.exception = getCurrentExceptionMessage(false);

654
                QueryStatus * process_list_elem = context.getProcessListElement();
655
                const Settings & current_settings = context.getSettingsRef();
656

657
                /// Update performance counters before logging to query_log
658
                CurrentThread::finalizePerformanceCounters();
659

660 661
                if (process_list_elem)
                {
662
                    QueryStatusInfo info = process_list_elem->getInfo(true, current_settings.log_profile_events, false);
663
                    status_info_to_query_log(elem, info, ast);
664
                }
665

666
                if (current_settings.calculate_text_stack_trace)
667
                    setExceptionStackTrace(elem);
668
                logException(context, elem);
669

670
                /// In case of exception we log internal queries also
671
                if (log_queries && elem.type >= log_queries_min_type)
672 673 674 675
                {
                    if (auto query_log = context.getQueryLog())
                        query_log->add(elem);
                }
676 677

                ProfileEvents::increment(ProfileEvents::FailedQuery);
N
Nikita Orlov 已提交
678 679
                if (ast->as<ASTSelectQuery>() || ast->as<ASTSelectWithUnionQuery>())
                {
680 681
                    ProfileEvents::increment(ProfileEvents::FailedSelectQuery);
                }
N
Nikita Orlov 已提交
682 683 684 685
                else if (ast->as<ASTInsertQuery>())
                {
                    ProfileEvents::increment(ProfileEvents::FailedInsertQuery);
                }
686

687
            };
688

N
Nikolai Kochetov 已提交
689 690
            res.finish_callback = std::move(finish_callback);
            res.exception_callback = std::move(exception_callback);
N
Nikolai Kochetov 已提交
691

692 693 694 695 696
            if (!internal && res.in)
            {
                std::stringstream log_str;
                log_str << "Query pipeline:\n";
                res.in->dumpTree(log_str);
A
Alexey Milovidov 已提交
697
                LOG_DEBUG(&Poco::Logger::get("executeQuery"), log_str.str());
698 699 700 701 702 703
            }
        }
    }
    catch (...)
    {
        if (!internal)
M
Mikhail Filimonov 已提交
704 705 706 707
        {
            if (query_for_logging.empty())
                query_for_logging = prepareQueryForLogging(query, context);

708
            onExceptionBeforeStart(query_for_logging, context, current_time, ast);
M
Mikhail Filimonov 已提交
709
        }
710 711 712 713

        throw;
    }

714
    return std::make_tuple(ast, std::move(res));
715 716 717 718
}


BlockIO executeQuery(
719 720 721
    const String & query,
    Context & context,
    bool internal,
722
    QueryProcessingStage::Enum stage,
723
    bool may_have_embedded_data)
724
{
A
Amos Bird 已提交
725
    ASTPtr ast;
726
    BlockIO streams;
A
Amos Bird 已提交
727
    std::tie(ast, streams) = executeQueryImpl(query.data(), query.data() + query.size(), context,
728
        internal, stage, !may_have_embedded_data, nullptr);
729 730

    if (const auto * ast_query_with_output = dynamic_cast<const ASTQueryWithOutput *>(ast.get()))
A
Amos Bird 已提交
731
    {
732 733 734 735
        String format_name = ast_query_with_output->format
                ? getIdentifierName(ast_query_with_output->format)
                : context.getDefaultFormat();

A
Amos Bird 已提交
736 737 738
        if (format_name == "Null")
            streams.null_format = true;
    }
739

740
    return streams;
741 742
}

N
Nikolai Kochetov 已提交
743 744 745 746 747 748 749 750
BlockIO executeQuery(
        const String & query,
        Context & context,
        bool internal,
        QueryProcessingStage::Enum stage,
        bool may_have_embedded_data,
        bool allow_processors)
{
N
Nikolai Kochetov 已提交
751
    BlockIO res = executeQuery(query, context, internal, stage, may_have_embedded_data);
N
Nikolai Kochetov 已提交
752 753 754 755 756 757 758

    if (!allow_processors && res.pipeline.initialized())
        res.in = res.getInputStream();

    return res;
}

759

A
Alexey Milovidov 已提交
760
void executeQuery(
761 762 763 764
    ReadBuffer & istr,
    WriteBuffer & ostr,
    bool allow_into_outfile,
    Context & context,
765
    std::function<void(const String &, const String &, const String &, const String &)> set_result_details)
A
Alexey Milovidov 已提交
766
{
767 768 769 770 771
    PODArray<char> parse_buf;
    const char * begin;
    const char * end;

    /// If 'istr' is empty now, fetch next data into buffer.
A
Alexander Kuzmenkov 已提交
772
    if (!istr.hasPendingData())
773 774 775 776
        istr.next();

    size_t max_query_size = context.getSettingsRef().max_query_size;

777
    bool may_have_tail;
N
Nikolai Kochetov 已提交
778
    if (istr.buffer().end() - istr.position() > static_cast<ssize_t>(max_query_size))
779 780 781 782 783
    {
        /// If remaining buffer space in 'istr' is enough to parse query up to 'max_query_size' bytes, then parse inplace.
        begin = istr.position();
        end = istr.buffer().end();
        istr.position() += end - begin;
784 785 786
        /// Actually we don't know will query has additional data or not.
        /// But we can't check istr.eof(), because begin and end pointers will became invalid
        may_have_tail = true;
787 788 789 790
    }
    else
    {
        /// If not - copy enough data into 'parse_buf'.
791 792 793
        WriteBufferFromVector<PODArray<char>> out(parse_buf);
        LimitReadBuffer limit(istr, max_query_size + 1, false);
        copyData(limit, out);
A
Alexander Burmak 已提交
794
        out.finalize();
795

796
        begin = parse_buf.data();
797
        end = begin + parse_buf.size();
798 799
        /// Can check stream for eof, because we have copied data
        may_have_tail = !istr.eof();
800 801 802 803 804
    }

    ASTPtr ast;
    BlockIO streams;

805
    std::tie(ast, streams) = executeQueryImpl(begin, end, context, false, QueryProcessingStage::Complete, may_have_tail, &istr);
806

N
Nikolai Kochetov 已提交
807 808
    auto & pipeline = streams.pipeline;

809 810 811 812
    try
    {
        if (streams.out)
        {
813
            InputStreamFromASTInsertQuery in(ast, &istr, streams.out->getHeader(), context, nullptr);
814 815 816 817 818
            copyData(in, *streams.out);
        }

        if (streams.in)
        {
819 820
            /// FIXME: try to prettify this cast using `as<>()`
            const auto * ast_query_with_output = dynamic_cast<const ASTQueryWithOutput *>(ast.get());
821 822

            WriteBuffer * out_buf = &ostr;
823
            std::optional<WriteBufferFromFile> out_file_buf;
824 825 826 827 828
            if (ast_query_with_output && ast_query_with_output->out_file)
            {
                if (!allow_into_outfile)
                    throw Exception("INTO OUTFILE is not allowed", ErrorCodes::INTO_OUTFILE_NOT_ALLOWED);

829
                const auto & out_file = ast_query_with_output->out_file->as<ASTLiteral &>().value.safeGet<std::string>();
830
                out_file_buf.emplace(out_file, DBMS_DEFAULT_BUFFER_SIZE, O_WRONLY | O_EXCL | O_CREAT);
831
                out_buf = &*out_file_buf;
832 833 834
            }

            String format_name = ast_query_with_output && (ast_query_with_output->format != nullptr)
A
Alexey Milovidov 已提交
835
                ? getIdentifierName(ast_query_with_output->format)
836 837
                : context.getDefaultFormat();

A
Alexey Milovidov 已提交
838 839
            if (ast_query_with_output && ast_query_with_output->settings_ast)
                InterpreterSetQuery(ast_query_with_output->settings_ast, context).executeForCurrentContext();
840

841
            BlockOutputStreamPtr out = context.getOutputFormat(format_name, *out_buf, streams.in->getHeader());
842

843 844
            /// Save previous progress callback if any. TODO Do it more conveniently.
            auto previous_progress_callback = context.getProgressCallback();
845

846 847 848 849 850 851 852
            /// NOTE Progress callback takes shared ownership of 'out'.
            streams.in->setProgressCallback([out, previous_progress_callback] (const Progress & progress)
            {
                if (previous_progress_callback)
                    previous_progress_callback(progress);
                out->onProgress(progress);
            });
853

854 855
            if (set_result_details)
                set_result_details(context.getClientInfo().current_query_id, out->getContentType(), format_name, DateLUT::instance().getTimeZone());
856

857
            copyData(*streams.in, *out, [](){ return false; }, [&out](const Block &) { out->flush(); });
858
        }
N
Nikolai Kochetov 已提交
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876

        if (pipeline.initialized())
        {
            const ASTQueryWithOutput * ast_query_with_output = dynamic_cast<const ASTQueryWithOutput *>(ast.get());

            WriteBuffer * out_buf = &ostr;
            std::optional<WriteBufferFromFile> out_file_buf;
            if (ast_query_with_output && ast_query_with_output->out_file)
            {
                if (!allow_into_outfile)
                    throw Exception("INTO OUTFILE is not allowed", ErrorCodes::INTO_OUTFILE_NOT_ALLOWED);

                const auto & out_file = typeid_cast<const ASTLiteral &>(*ast_query_with_output->out_file).value.safeGet<std::string>();
                out_file_buf.emplace(out_file, DBMS_DEFAULT_BUFFER_SIZE, O_WRONLY | O_EXCL | O_CREAT);
                out_buf = &*out_file_buf;
            }

            String format_name = ast_query_with_output && (ast_query_with_output->format != nullptr)
A
Alexey Milovidov 已提交
877
                                 ? getIdentifierName(ast_query_with_output->format)
N
Nikolai Kochetov 已提交
878 879 880 881 882
                                 : context.getDefaultFormat();

            if (ast_query_with_output && ast_query_with_output->settings_ast)
                InterpreterSetQuery(ast_query_with_output->settings_ast, context).executeForCurrentContext();

883
            if (!pipeline.isCompleted())
N
Nikolai Kochetov 已提交
884
            {
885 886 887 888
                pipeline.addSimpleTransform([](const Block & header)
                {
                    return std::make_shared<MaterializingTransform>(header);
                });
N
Nikolai Kochetov 已提交
889

890 891
                auto out = context.getOutputFormatProcessor(format_name, *out_buf, pipeline.getHeader());
                out->setAutoFlush();
N
Nikolai Kochetov 已提交
892

893 894
                /// Save previous progress callback if any. TODO Do it more conveniently.
                auto previous_progress_callback = context.getProgressCallback();
N
Nikolai Kochetov 已提交
895

896 897 898 899 900 901 902
                /// NOTE Progress callback takes shared ownership of 'out'.
                pipeline.setProgressCallback([out, previous_progress_callback] (const Progress & progress)
                {
                    if (previous_progress_callback)
                        previous_progress_callback(progress);
                    out->onProgress(progress);
                });
N
Nikolai Kochetov 已提交
903

904 905
                if (set_result_details)
                    set_result_details(context.getClientInfo().current_query_id, out->getContentType(), format_name, DateLUT::instance().getTimeZone());
N
Nikolai Kochetov 已提交
906

907 908 909 910 911 912
                pipeline.setOutputFormat(std::move(out));
            }
            else
            {
                pipeline.setProgressCallback(context.getProgressCallback());
            }
913

914
            {
N
Nikolai Kochetov 已提交
915
                auto executor = pipeline.execute();
916
                executor->execute(pipeline.getNumThreads());
917
            }
N
Nikolai Kochetov 已提交
918
        }
919 920 921 922 923 924 925 926
    }
    catch (...)
    {
        streams.onException();
        throw;
    }

    streams.onFinish();
927
}
928

A
Alexey Milovidov 已提交
929
}