mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-12-14 10:22:10 +00:00
70 lines
2.9 KiB
C++
70 lines
2.9 KiB
C++
#pragma once
|
|
|
|
#include <Core/QueryProcessingStage.h>
|
|
#include <QueryPipeline/BlockIO.h>
|
|
#include <Interpreters/Context_fwd.h>
|
|
#include <Formats/FormatSettings.h>
|
|
|
|
namespace DB
|
|
{
|
|
|
|
class ReadBuffer;
|
|
class WriteBuffer;
|
|
|
|
struct QueryResultDetails
|
|
{
|
|
String query_id;
|
|
std::optional<String> content_type;
|
|
std::optional<String> format;
|
|
std::optional<String> timezone;
|
|
};
|
|
|
|
using SetResultDetailsFunc = std::function<void(const QueryResultDetails &)>;
|
|
|
|
/// Parse and execute a query.
|
|
void executeQuery(
|
|
ReadBuffer & istr, /// Where to read query from (and data for INSERT, if present).
|
|
WriteBuffer & ostr, /// Where to write query output to.
|
|
bool allow_into_outfile, /// If true and the query contains INTO OUTFILE section, redirect output to that file.
|
|
ContextMutablePtr context, /// DB, tables, data types, storage engines, functions, aggregate functions...
|
|
SetResultDetailsFunc set_result_details, /// If a non-empty callback is passed, it will be called with the query id, the content-type, the format, and the timezone.
|
|
const std::optional<FormatSettings> & output_format_settings = std::nullopt /// Format settings for output format, will be calculated from the context if not set.
|
|
);
|
|
|
|
|
|
/// More low-level function for server-to-server interaction.
|
|
/// Prepares a query for execution but doesn't execute it.
|
|
/// Returns a pair of block streams which, when used, will result in query execution.
|
|
/// This means that the caller can to the extent control the query execution pipeline.
|
|
///
|
|
/// To execute:
|
|
/// * if present, write INSERT data into BlockIO::out
|
|
/// * then read the results from BlockIO::in.
|
|
///
|
|
/// If the query doesn't involve data insertion or returning of results, out and in respectively
|
|
/// will be equal to nullptr.
|
|
///
|
|
/// Correctly formatting the results (according to INTO OUTFILE and FORMAT sections)
|
|
/// must be done separately.
|
|
BlockIO executeQuery(
|
|
const String & query, /// Query text without INSERT data. The latter must be written to BlockIO::out.
|
|
ContextMutablePtr context, /// DB, tables, data types, storage engines, functions, aggregate functions...
|
|
bool internal = false, /// If true, this query is caused by another query and thus needn't be registered in the ProcessList.
|
|
QueryProcessingStage::Enum stage = QueryProcessingStage::Complete /// To which stage the query must be executed.
|
|
);
|
|
|
|
/// Old interface with allow_processors flag. For compatibility.
|
|
BlockIO executeQuery(
|
|
bool allow_processors, /// If can use processors pipeline
|
|
const String & query,
|
|
ContextMutablePtr context,
|
|
bool internal = false,
|
|
QueryProcessingStage::Enum stage = QueryProcessingStage::Complete
|
|
);
|
|
|
|
/// Executes BlockIO returned from executeQuery(...)
|
|
/// if built pipeline does not require any input and does not produce any output.
|
|
void executeTrivialBlockIO(BlockIO & streams, ContextPtr context);
|
|
|
|
}
|