ClickHouse/dbms/src/Client/Client.cpp

1182 lines
38 KiB
C++
Raw Normal View History

#define DBMS_CLIENT 1 /// Используется в Context.h
2012-05-08 05:42:05 +00:00
#include <unistd.h>
2012-03-25 03:47:13 +00:00
#include <stdlib.h>
2012-03-26 02:48:08 +00:00
#include <fcntl.h>
2012-05-09 08:16:09 +00:00
#include <signal.h>
2012-03-25 03:47:13 +00:00
#include <readline/readline.h>
2012-03-25 07:52:31 +00:00
#include <readline/history.h>
2012-03-25 03:47:13 +00:00
#include <iostream>
2012-03-26 02:48:08 +00:00
#include <fstream>
#include <iomanip>
2012-03-25 03:47:13 +00:00
2014-01-08 16:33:28 +00:00
#include <unordered_set>
#include <algorithm>
2012-03-25 03:47:13 +00:00
#include <boost/program_options.hpp>
2012-03-25 03:47:13 +00:00
#include <Poco/File.h>
#include <Poco/SharedPtr.h>
#include <Poco/Util/Application.h>
#include <Yandex/Revision.h>
2012-03-26 02:48:08 +00:00
#include <statdaemons/Stopwatch.h>
2012-03-25 03:47:13 +00:00
#include <DB/Core/Exception.h>
#include <DB/Core/Types.h>
2012-05-09 13:12:38 +00:00
#include <DB/Core/QueryProcessingStage.h>
2012-03-25 03:47:13 +00:00
2012-05-08 11:19:00 +00:00
#include <DB/IO/ReadBufferFromFileDescriptor.h>
2012-03-25 07:52:31 +00:00
#include <DB/IO/WriteBufferFromFileDescriptor.h>
#include <DB/IO/WriteBufferFromString.h>
2012-03-25 03:47:13 +00:00
#include <DB/IO/ReadHelpers.h>
#include <DB/IO/WriteHelpers.h>
#include <DB/IO/copyData.h>
#include <DB/IO/ReadBufferFromIStream.h>
2012-03-25 03:47:13 +00:00
#include <DB/DataStreams/AsynchronousBlockInputStream.h>
#include <DB/DataStreams/BlockInputStreamFromRowInputStream.h>
#include <DB/DataStreams/TabSeparatedRowInputStream.h>
2012-03-26 04:17:17 +00:00
#include <DB/Parsers/ParserQuery.h>
#include <DB/Parsers/ASTSetQuery.h>
#include <DB/Parsers/ASTUseQuery.h>
#include <DB/Parsers/ASTInsertQuery.h>
#include <DB/Parsers/ASTSelectQuery.h>
#include <DB/Parsers/ASTQueryWithOutput.h>
#include <DB/Parsers/ASTIdentifier.h>
2012-03-26 04:17:17 +00:00
#include <DB/Parsers/formatAST.h>
2012-03-25 03:47:13 +00:00
#include <DB/Interpreters/Context.h>
2012-05-16 18:03:00 +00:00
#include <DB/Client/Connection.h>
#include "InterruptListener.h"
#include <DB/Common/ExternalTable.h>
#include <DB/Common/UnicodeBar.h>
#include <DB/Common/formatReadable.h>
#include <DB/Columns/ColumnString.h>
2012-03-25 03:47:13 +00:00
/// http://en.wikipedia.org/wiki/ANSI_escape_code
#define SAVE_CURSOR_POSITION "\033[s"
#define RESTORE_CURSOR_POSITION "\033[u"
#define CLEAR_TO_END_OF_LINE "\033[K"
/// Эти коды, возможно, поддерживаются не везде.
#define DISABLE_LINE_WRAPPING "\033[?7l"
#define ENABLE_LINE_WRAPPING "\033[?7h"
2012-03-25 03:47:13 +00:00
/** Клиент командной строки СУБД ClickHouse.
*/
namespace DB
{
2012-03-25 07:52:31 +00:00
using Poco::SharedPtr;
2012-03-25 03:47:13 +00:00
class Client : public Poco::Util::Application
{
public:
Client() {}
2014-01-08 16:33:28 +00:00
2012-03-25 03:47:13 +00:00
private:
2014-01-08 16:33:28 +00:00
typedef std::unordered_set<String> StringSet;
StringSet exit_strings {
"exit", "quit", "logout",
"учше", "йгше", "дщпщге",
"exit;", "quit;", "logout;",
"учшеж", "йгшеж", "дщпщгеж",
"q", "й", "\\q", "\\Q", "\\й", "\\Й", ":q", "Жй"
};
2012-03-25 03:47:13 +00:00
bool is_interactive = true; /// Использовать readline интерфейс или batch режим.
bool print_time_to_stderr = false; /// В неинтерактивном режиме, выводить время выполнения в stderr.
bool stdin_is_not_tty = false; /// stdin - не терминал.
2012-05-08 05:42:05 +00:00
winsize terminal_size {}; /// Размер терминала - для вывода прогресс-бара.
2012-05-16 18:03:00 +00:00
SharedPtr<Connection> connection; /// Соединение с БД.
2012-03-25 03:47:13 +00:00
String query; /// Текущий запрос.
String format; /// Формат вывода результата в консоль.
size_t format_max_block_size = 0; /// Максимальный размер блока при выводе в консоль.
2012-05-08 11:19:00 +00:00
String insert_format; /// Формат данных для INSERT-а при чтении их из stdin в batch режиме
size_t insert_format_max_block_size = 0; /// Максимальный размер блока при чтении данных INSERT-а.
2012-03-25 03:47:13 +00:00
bool has_vertical_output_suffix = false; /// \G указан в конце команды?
2012-03-25 03:47:13 +00:00
Context context;
2012-05-08 11:19:00 +00:00
/// Чтение из stdin для batch режима
ReadBufferFromFileDescriptor std_in {STDIN_FILENO};
2012-05-08 11:19:00 +00:00
2012-03-25 03:47:13 +00:00
/// Вывод в консоль
WriteBufferFromFileDescriptor std_out {STDOUT_FILENO};
2012-03-25 03:47:13 +00:00
BlockOutputStreamPtr block_std_out;
2012-03-26 02:48:08 +00:00
String home_path;
String current_profile;
2012-03-26 02:48:08 +00:00
/// Путь к файлу истории команд.
String history_file;
2012-03-26 04:17:17 +00:00
2012-05-21 06:49:05 +00:00
/// Строк прочитано или записано.
size_t processed_rows = 0;
2012-03-26 04:17:17 +00:00
/// Распарсенный запрос. Оттуда берутся некоторые настройки (формат).
ASTPtr parsed_query;
/// Последнее полученное от сервера исключение. Для кода возврата в неинтерактивном режиме.
ExceptionPtr last_exception;
2012-05-09 08:16:09 +00:00
/// Было ли в последнем запросе исключение.
bool got_exception = false;
2012-05-10 07:47:13 +00:00
Stopwatch watch;
/// С сервера периодически приходит информация, о том, сколько прочитано данных за прошедшее время.
Progress progress;
bool show_progress_bar = false;
size_t written_progress_chars = 0;
bool written_first_block = false;
2012-05-09 15:15:45 +00:00
/// Информация о внешних таблицах
std::list<ExternalTable> external_tables;
2012-03-25 03:47:13 +00:00
void initialize(Poco::Util::Application & self)
{
Poco::Util::Application::initialize(self);
2012-03-26 02:48:08 +00:00
const char * home_path_cstr = getenv("HOME");
if (home_path_cstr)
2012-03-26 02:48:08 +00:00
home_path = home_path_cstr;
2012-03-25 03:47:13 +00:00
if (config().has("config-file"))
loadConfiguration(config().getString("config-file"));
else if (Poco::File("./clickhouse-client.xml").exists())
loadConfiguration("./clickhouse-client.xml");
else if (!home_path.empty() && Poco::File(home_path + "/.clickhouse-client/config.xml").exists())
2012-03-26 02:48:08 +00:00
loadConfiguration(home_path + "/.clickhouse-client/config.xml");
2012-03-25 03:47:13 +00:00
else if (Poco::File("/etc/clickhouse-client/config.xml").exists())
loadConfiguration("/etc/clickhouse-client/config.xml");
/// settings и limits могли так же быть указаны в кофигурационном файле, но уже записанные настройки имеют больший приоритет.
#define EXTRACT_SETTING(TYPE, NAME, DEFAULT) \
if (config().has(#NAME) && !context.getSettingsRef().NAME.changed) \
context.setSetting(#NAME, config().getString(#NAME));
APPLY_FOR_SETTINGS(EXTRACT_SETTING)
#undef EXTRACT_SETTING
#define EXTRACT_LIMIT(TYPE, NAME, DEFAULT) \
if (config().has(#NAME) && !context.getSettingsRef().limits.NAME.changed) \
context.setSetting(#NAME, config().getString(#NAME));
APPLY_FOR_LIMITS(EXTRACT_LIMIT)
#undef EXTRACT_LIMIT
2012-03-25 03:47:13 +00:00
}
2012-03-26 02:48:08 +00:00
2012-03-25 03:47:13 +00:00
int main(const std::vector<std::string> & args)
{
2012-03-26 02:48:08 +00:00
try
{
return mainImpl(args);
}
catch (const Exception & e)
2012-03-26 02:48:08 +00:00
{
2013-08-10 09:04:45 +00:00
std::string text = e.displayText();
2013-08-10 09:04:45 +00:00
std::cerr << "Code: " << e.code() << ". " << text << std::endl << std::endl;
/// Если есть стек-трейс на сервере, то не будем писать стек-трейс на клиенте.
/// Также не будем писать стек-трейс в случае сетевых ошибок.
if (e.code() != ErrorCodes::NETWORK_ERROR
&& std::string::npos == text.find("Stack trace"))
{
2013-08-10 09:04:45 +00:00
std::cerr << "Stack trace:" << std::endl
<< e.getStackTrace().toString();
}
/// В случае нулевого кода исключения, надо всё-равно вернуть ненулевой код возврата.
return e.code() ? e.code() : -1;
2012-03-26 02:48:08 +00:00
}
catch (const Poco::Exception & e)
{
std::cerr << "Poco::Exception: " << e.displayText() << std::endl;
return ErrorCodes::POCO_EXCEPTION;
2012-03-26 02:48:08 +00:00
}
catch (const std::exception & e)
{
std::cerr << "std::exception: " << e.what() << std::endl;
return ErrorCodes::STD_EXCEPTION;
2012-03-26 02:48:08 +00:00
}
catch (...)
{
std::cerr << "Unknown exception" << std::endl;
return ErrorCodes::UNKNOWN_EXCEPTION;
2012-03-26 02:48:08 +00:00
}
}
2012-03-26 02:48:08 +00:00
int mainImpl(const std::vector<std::string> & args)
{
2012-05-08 05:42:05 +00:00
/** Будем работать в batch режиме, если выполнено одно из следующих условий:
* - задан параметр -e (--query)
* (в этом случае - запрос или несколько запросов берём оттуда;
* а если при этом stdin не терминал, то берём оттуда данные для INSERT-а первого запроса).
* - stdin - не терминал (в этом случае, считываем оттуда запросы);
*/
stdin_is_not_tty = !isatty(STDIN_FILENO);
if (stdin_is_not_tty || config().has("query"))
is_interactive = false;
2012-05-09 08:16:09 +00:00
2012-03-26 04:17:17 +00:00
std::cout << std::fixed << std::setprecision(3);
2012-05-08 05:42:05 +00:00
std::cerr << std::fixed << std::setprecision(3);
2012-05-08 05:42:05 +00:00
if (is_interactive)
std::cout << "ClickHouse client version " << DBMS_VERSION_MAJOR
<< "." << DBMS_VERSION_MINOR
<< "." << Revision::get()
<< "." << std::endl;
2012-03-25 03:47:13 +00:00
if (config().has("vertical"))
format = config().getString("format", "Vertical");
else
format = config().getString("format", is_interactive ? "PrettyCompact" : "TabSeparated");
2012-03-25 03:47:13 +00:00
format_max_block_size = config().getInt("format_max_block_size", DEFAULT_BLOCK_SIZE);
2012-05-21 06:49:05 +00:00
insert_format = "Values";
insert_format_max_block_size = config().getInt("insert_format_max_block_size", DEFAULT_INSERT_BLOCK_SIZE);
2012-05-21 06:49:05 +00:00
2012-05-16 18:03:00 +00:00
connect();
2012-05-08 05:42:05 +00:00
if (is_interactive)
2012-03-26 02:48:08 +00:00
{
if (print_time_to_stderr)
throw Exception("time option could be specified only in non-interactive mode", ErrorCodes::BAD_ARGUMENTS);
2012-05-08 05:42:05 +00:00
/// Отключаем tab completion.
rl_bind_key('\t', rl_insert);
/// Загружаем историю команд, если есть.
if (config().has("history_file"))
history_file = config().getString("history_file");
else if (!home_path.empty())
history_file = home_path + "/.clickhouse-client-history";
if (!history_file.empty())
2012-05-08 05:42:05 +00:00
{
if (Poco::File(history_file).exists())
{
int res = read_history(history_file.c_str());
if (res)
throwFromErrno("Cannot read history from file " + history_file, ErrorCodes::CANNOT_READ_HISTORY);
}
else /// Создаём файл с историей.
Poco::File(history_file).createFile();
2012-05-08 05:42:05 +00:00
}
2012-08-31 18:44:05 +00:00
/// Инициализируем DateLUT, чтобы потраченное время не отображалось, как время, потраченное на запрос.
2014-07-08 23:52:53 +00:00
DateLUT::instance();
2012-08-31 18:44:05 +00:00
2012-05-08 05:42:05 +00:00
loop();
std::cout << "Bye." << std::endl;
return 0;
2012-03-26 02:48:08 +00:00
}
2012-05-08 05:42:05 +00:00
else
{
2012-05-08 05:42:05 +00:00
nonInteractive();
if (last_exception)
return last_exception->code();
return 0;
}
2012-03-25 03:47:13 +00:00
}
2012-05-09 13:12:38 +00:00
void connect()
{
String host = config().getString("host", "localhost");
2012-07-06 18:12:52 +00:00
UInt16 port = config().getInt("port", DBMS_DEFAULT_PORT);
2012-05-30 06:46:57 +00:00
String default_database = config().getString("database", "");
2013-08-10 09:04:45 +00:00
String user = config().getString("user", "");
String password = config().getString("password", "");
2012-05-16 18:03:00 +00:00
Protocol::Compression::Enum compression = config().getBool("compression", true)
? Protocol::Compression::Enable
: Protocol::Compression::Disable;
2012-05-09 13:12:38 +00:00
if (is_interactive)
2013-08-10 09:04:45 +00:00
std::cout << "Connecting to "
<< (!default_database.empty() ? "database " + default_database + " at " : "")
<< host << ":" << port
<< (!user.empty() ? " as user " + user : "")
<< "." << std::endl;
2012-05-09 13:12:38 +00:00
2013-08-10 09:04:45 +00:00
connection = new Connection(host, port, default_database, user, password, context.getDataTypeFactory(), "client", compression,
2012-07-26 20:16:57 +00:00
Poco::Timespan(config().getInt("connect_timeout", DBMS_DEFAULT_CONNECT_TIMEOUT_SEC), 0),
Poco::Timespan(config().getInt("receive_timeout", DBMS_DEFAULT_RECEIVE_TIMEOUT_SEC), 0),
Poco::Timespan(config().getInt("send_timeout", DBMS_DEFAULT_SEND_TIMEOUT_SEC), 0));
2012-05-16 18:20:45 +00:00
2012-05-21 06:49:05 +00:00
if (is_interactive)
{
String server_name;
UInt64 server_version_major = 0;
UInt64 server_version_minor = 0;
UInt64 server_revision = 0;
2012-05-16 18:20:45 +00:00
2012-05-21 06:49:05 +00:00
connection->getServerVersion(server_name, server_version_major, server_version_minor, server_revision);
2012-05-16 18:20:45 +00:00
std::cout << "Connected to " << server_name
<< " server version " << server_version_major
<< "." << server_version_minor
<< "." << server_revision
<< "." << std::endl << std::endl;
2012-05-21 06:49:05 +00:00
}
2012-05-09 13:12:38 +00:00
}
static bool isWhitespace(char c)
{
return c == ' ' || c == '\t' || c == '\n' || c == '\r' || c == '\f';
}
2012-05-09 13:12:38 +00:00
2012-03-25 03:47:13 +00:00
void loop()
{
String query;
String prev_query;
while (char * line_ = readline(query.empty() ? ":) " : ":-] "))
2012-03-25 03:47:13 +00:00
{
String line = line_;
2012-03-25 03:47:13 +00:00
free(line_);
size_t ws = line.size();
while (ws > 0 && isWhitespace(line[ws - 1]))
--ws;
if (ws == 0 && query.empty())
2012-03-26 04:17:17 +00:00
continue;
bool ends_with_semicolon = line[ws - 1] == ';';
bool ends_with_backslash = line[ws - 1] == '\\';
has_vertical_output_suffix = (ws >= 2) && (line[ws - 2] == '\\') && (line[ws - 1] == 'G');
if (ends_with_backslash)
line = line.substr(0, ws - 1);
query += line;
if (!ends_with_backslash && (ends_with_semicolon || has_vertical_output_suffix || !config().has("multiline")))
{
if (query != prev_query)
{
2014-12-18 09:44:57 +00:00
// Заменяем переводы строк на пробелы, а то возникает следуцющая проблема.
// Каждая строчка многострочного запроса сохраняется в истории отдельно. Если
// выйти из клиента и войти заново, то при нажатии клавиши "вверх" выводится не
2014-12-18 09:44:57 +00:00
// весь многострочный запрос, а каждая его строчка по-отдельности.
std::string logged_query = query;
std::replace(logged_query.begin(), logged_query.end(), '\n', ' ');
add_history(logged_query.c_str());
if (!history_file.empty() && append_history(1, history_file.c_str()))
throwFromErrno("Cannot append history to file " + history_file, ErrorCodes::CANNOT_APPEND_HISTORY);
prev_query = query;
}
if (has_vertical_output_suffix)
query = query.substr(0, query.length() - 2);
try
{
/// Выясняем размер терминала.
ioctl(0, TIOCGWINSZ, &terminal_size);
if (!process(query))
break;
}
catch (const Exception & e)
{
std::cerr << std::endl
<< "Exception on client:" << std::endl
<< "Code: " << e.code() << ". " << e.displayText() << std::endl
<< std::endl;
/** Эксепшен на клиенте в процессе обработки запроса может привести к рассинхронизации соединения.
* Установим соединение заново и позволим ввести следующий запрос.
*/
connect();
}
query = "";
}
else
{
query += '\n';
}
2012-03-25 03:47:13 +00:00
}
}
2012-05-08 05:42:05 +00:00
void nonInteractive()
{
String line;
2012-05-08 05:42:05 +00:00
if (config().has("query"))
line = config().getString("query");
2012-05-08 05:42:05 +00:00
else
{
/** В случае, если параметр query не задан, то запрос будет читаться из stdin.
* При этом, запрос будет читаться не потоково (целиком в оперативку).
* Поддерживается только один запрос в stdin.
*/
ReadBufferFromFileDescriptor in(STDIN_FILENO);
WriteBufferFromString out(line);
copyData(in, out);
}
if (config().has("multiquery"))
{
/// Несколько запросов, разделенных ';'.
/// Данные для INSERT заканчиваются переводом строки, а не ';'.
String query;
const char * begin = line.data();
const char * end = begin + line.size();
while (begin < end)
{
const char * pos = begin;
ASTPtr ast = parseQuery(pos, end);
ASTInsertQuery * insert = typeid_cast<ASTInsertQuery *>(&*ast);
if (insert && insert->data)
{
pos = insert->data;
while (*pos && *pos != '\n')
++pos;
insert->end = pos;
}
query = line.substr(begin - line.data(), pos - begin);
begin = pos;
while (isWhitespace(*begin) || *begin == ';')
++begin;
process(query, ast);
}
}
else
{
process(line);
2012-05-08 05:42:05 +00:00
}
}
bool process(const String & line, ASTPtr parsed_query_ = nullptr)
2012-03-25 03:47:13 +00:00
{
if (exit_strings.end() != exit_strings.find(line))
return false;
resetOutput();
got_exception = false;
2012-05-16 18:03:00 +00:00
2012-05-10 07:47:13 +00:00
watch.restart();
2012-03-26 02:48:08 +00:00
2012-03-25 03:47:13 +00:00
query = line;
2012-03-26 04:17:17 +00:00
/// Некоторые части запроса выполняются на стороне клиента (форматирование результата). Поэтому, распарсим запрос.
parsed_query = parsed_query_;
if (!parsed_query)
{
const char * begin = query.data();
parsed_query = parseQuery(begin, begin + query.size());
}
if (!parsed_query)
2012-03-26 04:17:17 +00:00
return true;
2012-05-09 08:16:09 +00:00
2012-05-21 06:49:05 +00:00
processed_rows = 0;
progress.reset();
show_progress_bar = false;
2012-05-09 16:34:41 +00:00
written_progress_chars = 0;
written_first_block = false;
2012-05-09 13:12:38 +00:00
const ASTSetQuery * set_query = typeid_cast<const ASTSetQuery *>(&*parsed_query);
const ASTUseQuery * use_query = typeid_cast<const ASTUseQuery *>(&*parsed_query);
/// Запрос INSERT (но только тот, что требует передачи данных - не INSERT SELECT), обрабатывается отдельным способом.
const ASTInsertQuery * insert = typeid_cast<const ASTInsertQuery *>(&*parsed_query);
if (insert && !insert->select)
processInsertQuery();
else
processOrdinaryQuery();
/// В случае исключения, не будем менять контекст (текущая БД, настройки) на клиенте.
if (!got_exception)
{
if (set_query)
{
/// Запоминаем все изменения в настройках, чтобы не потерять их при разрыве соединения.
for (ASTSetQuery::Changes::const_iterator it = set_query->changes.begin(); it != set_query->changes.end(); ++it)
{
if (it->name == "profile")
current_profile = it->value.safeGet<String>();
else
context.setSetting(it->name, it->value);
}
}
if (use_query)
{
const String & new_database = use_query->database;
/// Если клиент инициирует пересоединение, он берет настройки из конфига
config().setString("database", new_database);
/// Если connection инициирует пересоединение, он использует свою переменную
connection->setDefaultDatabase(new_database);
}
}
2012-05-08 05:42:05 +00:00
if (is_interactive)
{
2012-05-08 05:42:05 +00:00
std::cout << std::endl
<< processed_rows << " rows in set. Elapsed: " << watch.elapsedSeconds() << " sec. ";
if (progress.rows >= 1000)
writeFinalProgress();
std::cout << std::endl << std::endl;
}
else if (print_time_to_stderr)
{
std::cerr << watch.elapsedSeconds() << "\n";
}
2012-03-26 02:48:08 +00:00
2012-03-25 03:47:13 +00:00
return true;
}
/// Преобразовать внешние таблицы к ExternalTableData и переслать через connection
void sendExternalTables()
{
const ASTSelectQuery * select = typeid_cast<const ASTSelectQuery *>(&*parsed_query);
if (!select && !external_tables.empty())
throw Exception("External tables could be sent only with select query", ErrorCodes::BAD_ARGUMENTS);
std::vector<ExternalTableData> data;
for (auto & table : external_tables)
data.emplace_back(table.getData(context));
connection->sendExternalTablesData(data);
}
2012-05-21 06:49:05 +00:00
/// Обработать запрос, который не требует передачи блоков данных на сервер.
void processOrdinaryQuery()
{
connection->sendQuery(query, "", QueryProcessingStage::Complete, &context.getSettingsRef(), true);
sendExternalTables();
2012-05-21 06:49:05 +00:00
receiveResult();
}
/// Обработать запрос, который требует передачи блоков данных на сервер.
void processInsertQuery()
{
/// Отправляем часть запроса - без данных, так как данные будут отправлены отдельно.
const ASTInsertQuery & parsed_insert_query = typeid_cast<const ASTInsertQuery &>(*parsed_query);
2012-05-21 06:49:05 +00:00
String query_without_data = parsed_insert_query.data
? query.substr(0, parsed_insert_query.data - query.data())
: query;
if (!parsed_insert_query.data && (is_interactive || (stdin_is_not_tty && std_in.eof())))
2012-05-28 19:57:44 +00:00
throw Exception("No data to insert", ErrorCodes::NO_DATA_TO_INSERT);
connection->sendQuery(query_without_data, "", QueryProcessingStage::Complete, &context.getSettingsRef(), true);
sendExternalTables();
2012-05-21 06:49:05 +00:00
2014-12-18 12:11:08 +00:00
/// Получаем структуру таблицы.
Block sample;
if (receiveSampleBlock(sample))
{
/// Если была получена структура, т.е. сервер не выкинул исключения,
/// отправляем эту структуру вместе с данными.
sendData(sample);
receivePacket();
}
2012-05-21 06:49:05 +00:00
}
ASTPtr parseQuery(Expected & pos, const char * end)
2012-03-26 04:17:17 +00:00
{
ParserQuery parser;
Expected expected = "";
2012-03-26 04:17:17 +00:00
const char * begin = pos;
2012-03-26 04:17:17 +00:00
ASTPtr res;
bool parse_res = parser.parse(pos, end, res, expected);
2012-03-26 04:17:17 +00:00
/// Распарсенный запрос должен заканчиваться на конец входных данных или на точку с запятой.
if (!parse_res || (pos != end && *pos != ';'))
{
std::string message = getSyntaxErrorMessage(parse_res, begin, end, pos, expected);
2012-03-26 04:17:17 +00:00
if (is_interactive)
std::cerr << message << std::endl << std::endl;
else
throw Exception(message, ErrorCodes::SYNTAX_ERROR);
return nullptr;
2012-03-26 04:17:17 +00:00
}
2012-05-08 05:42:05 +00:00
if (is_interactive)
{
std::cout << std::endl;
formatAST(*res, std::cout);
2012-05-08 05:42:05 +00:00
std::cout << std::endl << std::endl;
}
return res;
2012-03-26 04:17:17 +00:00
}
2012-05-21 06:49:05 +00:00
void sendData(Block & sample)
2012-05-08 11:19:00 +00:00
{
/// Если нужно отправить данные INSERT-а.
const ASTInsertQuery * parsed_insert_query = typeid_cast<const ASTInsertQuery *>(&*parsed_query);
2012-05-08 11:19:00 +00:00
if (!parsed_insert_query)
return;
2012-05-28 19:34:55 +00:00
2012-05-08 11:19:00 +00:00
if (parsed_insert_query->data)
{
/// Отправляем данные из запроса.
2012-05-21 06:49:05 +00:00
ReadBuffer data_in(const_cast<char *>(parsed_insert_query->data), parsed_insert_query->end - parsed_insert_query->data, 0);
sendDataFrom(data_in, sample);
2012-05-08 11:19:00 +00:00
}
else if (!is_interactive)
2012-05-08 11:19:00 +00:00
{
/// Отправляем данные из stdin.
2012-05-21 06:49:05 +00:00
sendDataFrom(std_in, sample);
2012-05-08 11:19:00 +00:00
}
else
throw Exception("No data to insert", ErrorCodes::NO_DATA_TO_INSERT);
}
2012-05-21 06:49:05 +00:00
void sendDataFrom(ReadBuffer & buf, Block & sample)
2012-05-08 11:19:00 +00:00
{
2012-05-21 06:49:05 +00:00
String current_format = insert_format;
/// Формат может быть указан в INSERT запросе.
if (ASTInsertQuery * insert = typeid_cast<ASTInsertQuery *>(&*parsed_query))
2012-05-21 06:49:05 +00:00
if (!insert->format.empty())
current_format = insert->format;
BlockInputStreamPtr block_input = context.getFormatFactory().getInput(
current_format, buf, sample, insert_format_max_block_size, context.getDataTypeFactory());
2012-05-21 06:49:05 +00:00
BlockInputStreamPtr async_block_input = new AsynchronousBlockInputStream(block_input);
async_block_input->readPrefix();
while (true)
{
Block block = async_block_input->read();
connection->sendData(block);
processed_rows += block.rows();
if (!block)
break;
}
async_block_input->readSuffix();
2012-05-08 11:19:00 +00:00
}
/** Сбросить все данные, что ещё остались в буферах. */
void resetOutput()
{
block_std_out = nullptr;
std_out.next();
}
2012-05-16 18:03:00 +00:00
/** Получает и обрабатывает пакеты из сервера.
* Также следит, не требуется ли прервать выполнение запроса.
*/
2012-03-25 03:47:13 +00:00
void receiveResult()
{
2012-05-09 08:16:09 +00:00
InterruptListener interrupt_listener;
bool cancelled = false;
while (true)
{
/** Проверим, не требуется ли остановить выполнение запроса (Ctrl+C).
* Если требуется - отправим об этом информацию на сервер.
* После чего, получим оставшиеся пакеты с сервера (чтобы не было рассинхронизации).
*/
if (!cancelled)
{
if (interrupt_listener.check())
{
2012-05-16 18:03:00 +00:00
connection->sendCancel();
2012-05-09 08:16:09 +00:00
cancelled = true;
if (is_interactive)
std::cout << "Cancelling query." << std::endl;
/// Повторное нажатие Ctrl+C приведёт к завершению работы.
interrupt_listener.unblock();
2012-05-09 08:16:09 +00:00
}
2012-05-16 18:03:00 +00:00
else if (!connection->poll(1000000))
2012-05-09 08:16:09 +00:00
continue; /// Если новых данных в ещё нет, то после таймаута продолжим проверять, не остановлено ли выполнение запроса.
}
2012-03-25 07:52:31 +00:00
2012-05-09 08:16:09 +00:00
if (!receivePacket())
break;
}
if (cancelled && is_interactive)
std::cout << "Query was cancelled." << std::endl;
2012-03-25 03:47:13 +00:00
}
2012-05-16 18:03:00 +00:00
/** Получить кусок результата или прогресс выполнения или эксепшен,
* и обработать пакет соответствующим образом.
* Возвращает true, если нужно продолжать чтение пакетов.
*/
2012-03-25 03:47:13 +00:00
bool receivePacket()
{
2012-05-16 18:03:00 +00:00
Connection::Packet packet = connection->receivePacket();
2012-03-25 03:47:13 +00:00
2012-05-16 18:03:00 +00:00
switch (packet.type)
2012-03-25 03:47:13 +00:00
{
case Protocol::Server::Data:
2012-05-16 18:03:00 +00:00
onData(packet.block);
return true;
case Protocol::Server::Progress:
onProgress(packet.progress);
return true;
2013-05-22 14:57:43 +00:00
case Protocol::Server::ProfileInfo:
onProfileInfo(packet.profile_info);
return true;
2012-03-25 03:47:13 +00:00
case Protocol::Server::Totals:
onTotals(packet.block);
return true;
case Protocol::Server::Extremes:
onExtremes(packet.block);
return true;
2012-05-08 05:42:05 +00:00
case Protocol::Server::Exception:
2012-05-16 18:03:00 +00:00
onException(*packet.exception);
last_exception = packet.exception;
2012-05-08 05:42:05 +00:00
return false;
2012-05-16 18:03:00 +00:00
case Protocol::Server::EndOfStream:
onEndOfStream();
2012-05-08 11:19:00 +00:00
return false;
2012-03-25 03:47:13 +00:00
default:
throw Exception("Unknown packet from server", ErrorCodes::UNKNOWN_PACKET_FROM_SERVER);
}
}
2012-05-21 06:49:05 +00:00
/** Получить блок - пример структуры таблицы, в которую будут вставляться данные.
*/
2014-12-18 12:11:08 +00:00
bool receiveSampleBlock(Block & out)
2012-05-21 06:49:05 +00:00
{
Connection::Packet packet = connection->receivePacket();
switch (packet.type)
{
case Protocol::Server::Data:
2014-12-18 12:11:08 +00:00
out = packet.block;
return true;
2012-05-21 06:49:05 +00:00
2014-12-18 12:11:08 +00:00
case Protocol::Server::Exception:
onException(*packet.exception);
last_exception = packet.exception;
return false;
2012-05-21 06:49:05 +00:00
default:
2012-06-19 22:46:02 +00:00
throw Exception("Unexpected packet from server (expected Data, got "
+ String(Protocol::Server::toString(packet.type)) + ")", ErrorCodes::UNEXPECTED_PACKET_FROM_SERVER);
2012-05-21 06:49:05 +00:00
}
}
2012-05-16 18:03:00 +00:00
void onData(Block & block)
2012-03-25 03:47:13 +00:00
{
2012-05-09 15:15:45 +00:00
if (written_progress_chars)
clearProgress();
2012-05-09 15:15:45 +00:00
if (!block)
return;
2012-05-09 16:34:41 +00:00
processed_rows += block.rows();
if (!block_std_out)
2012-03-25 03:47:13 +00:00
{
String current_format = format;
/// Формат может быть указан в запросе.
if (ASTQueryWithOutput * query_with_output = dynamic_cast<ASTQueryWithOutput *>(&*parsed_query))
{
if (query_with_output->format)
{
if (has_vertical_output_suffix)
throw Exception("Output format already specified", ErrorCodes::CLIENT_OUTPUT_FORMAT_SPECIFIED);
if (ASTIdentifier * id = typeid_cast<ASTIdentifier *>(&*query_with_output->format))
current_format = id->name;
}
}
if (has_vertical_output_suffix)
current_format = "Vertical";
block_std_out = context.getFormatFactory().getOutput(current_format, std_out, block);
block_std_out->writePrefix();
2012-03-25 03:47:13 +00:00
}
/// Загаловочный блок с нулем строк использовался для инициализации block_std_out,
/// выводить его не нужно
if (block.rows() != 0)
{
block_std_out->write(block);
written_first_block = true;
}
/// Полученный блок данных сразу выводится клиенту.
block_std_out->flush();
}
void onTotals(Block & block)
{
block_std_out->setTotals(block);
2012-03-25 03:47:13 +00:00
}
2012-05-08 05:42:05 +00:00
void onExtremes(Block & block)
{
block_std_out->setExtremes(block);
}
2012-05-08 05:42:05 +00:00
void onProgress(const Progress & value)
2012-05-08 11:19:00 +00:00
{
progress.increment(value);
writeProgress();
}
void clearProgress()
{
std::cerr << RESTORE_CURSOR_POSITION CLEAR_TO_END_OF_LINE;
written_progress_chars = 0;
}
void writeProgress()
{
if (!is_interactive)
return;
2012-05-09 15:15:45 +00:00
static size_t increment = 0;
static const char * indicators[8] =
{
2012-05-09 16:34:41 +00:00
"\033[1;30m→\033[0m",
"\033[1;31m↘\033[0m",
"\033[1;32m↓\033[0m",
"\033[1;33m↙\033[0m",
"\033[1;34m←\033[0m",
"\033[1;35m↖\033[0m",
"\033[1;36m↑\033[0m",
"\033[1m↗\033[0m",
2012-05-09 15:15:45 +00:00
};
if (written_progress_chars)
clearProgress();
else
std::cerr << SAVE_CURSOR_POSITION;
std::stringstream message;
message << indicators[increment % 8]
<< std::fixed << std::setprecision(3)
<< " Progress: ";
message
<< formatReadableQuantity(progress.rows) << " rows, "
<< formatReadableSizeWithDecimalSuffix(progress.bytes);
size_t elapsed_ns = watch.elapsed();
if (elapsed_ns)
message << " ("
<< formatReadableQuantity(progress.rows * 1000000000.0 / elapsed_ns) << " rows/s., "
<< formatReadableSizeWithDecimalSuffix(progress.bytes * 1000000000.0 / elapsed_ns) << "/s.) ";
else
message << ". ";
written_progress_chars = message.str().size() - (increment % 8 == 7 ? 10 : 13);
std::cerr << DISABLE_LINE_WRAPPING << message.rdbuf();
/** Если известно приблизительное общее число строк, которых нужно обработать - можно вывести прогрессбар.
* Чтобы не было "мерцания", выводим его только если с момента начала выполнения запроса прошло хотя бы пол секунды,
* и если к этому моменту запрос обработан менее чем наполовину.
*/
ssize_t width_of_progress_bar = static_cast<ssize_t>(terminal_size.ws_col) - written_progress_chars - strlen(" 99%");
if (show_progress_bar
|| (width_of_progress_bar > 0
&& progress.total_rows
&& elapsed_ns > 500000000
&& progress.rows * 2 < progress.total_rows))
{
show_progress_bar = true;
size_t total_rows_corrected = std::max(progress.rows, progress.total_rows);
std::string bar = UnicodeBar::render(UnicodeBar::getWidth(progress.rows, 0, total_rows_corrected, width_of_progress_bar));
std::cerr << "\033[0;32m" << bar << "\033[0m";
if (width_of_progress_bar > static_cast<ssize_t>(bar.size() / UNICODE_BAR_CHAR_SIZE))
std::cerr << std::string(width_of_progress_bar - bar.size() / UNICODE_BAR_CHAR_SIZE, ' ');
std::cerr << ' ' << (99 * progress.rows / total_rows_corrected) << '%'; /// Чуть-чуть занижаем процент, чтобы не показывать 100%.
}
std::cerr << ENABLE_LINE_WRAPPING;
++increment;
2012-05-09 15:15:45 +00:00
}
2012-05-16 18:03:00 +00:00
void writeFinalProgress()
{
std::cout << "Processed "
<< formatReadableQuantity(progress.rows) << " rows, "
<< formatReadableSizeWithDecimalSuffix(progress.bytes);
size_t elapsed_ns = watch.elapsed();
if (elapsed_ns)
std::cout << " ("
<< formatReadableQuantity(progress.rows * 1000000000.0 / elapsed_ns) << " rows/s., "
<< formatReadableSizeWithDecimalSuffix(progress.bytes * 1000000000.0 / elapsed_ns) << "/s.) ";
else
std::cout << ". ";
}
2012-05-16 18:03:00 +00:00
void onException(const Exception & e)
{
resetOutput();
got_exception = true;
2012-05-16 18:03:00 +00:00
std::cerr << "Received exception from server:" << std::endl
<< "Code: " << e.code() << ". " << e.displayText();
}
2013-05-22 14:57:43 +00:00
void onProfileInfo(const BlockStreamProfileInfo & profile_info)
{
if (profile_info.hasAppliedLimit() && block_std_out)
2013-05-22 14:57:43 +00:00
block_std_out->setRowsBeforeLimit(profile_info.getRowsBeforeLimit());
}
2012-05-16 18:03:00 +00:00
void onEndOfStream()
{
if (block_std_out)
block_std_out->writeSuffix();
resetOutput();
2012-05-16 18:03:00 +00:00
if (is_interactive && !written_first_block)
std::cout << "Ok." << std::endl;
}
2012-03-25 03:47:13 +00:00
public:
void init(int argc, char ** argv)
2012-03-25 03:47:13 +00:00
{
/// Останавливаем внутреннюю обработку командной строки
stopOptionsProcessing();
#define DECLARE_SETTING(TYPE, NAME, DEFAULT) (#NAME, boost::program_options::value<std::string> (), "Settings.h")
#define DECLARE_LIMIT(TYPE, NAME, DEFAULT) (#NAME, boost::program_options::value<std::string> (), "Limits.h")
/// Перечисляем основные опции командной строки относящиеся к функциональности клиента,
/// а так же все параметры из Settings
boost::program_options::options_description main_description("Main options");
main_description.add_options()
("help", "produce help message")
("config-file,c", boost::program_options::value<std::string>(), "config-file path")
("host,h", boost::program_options::value<std::string>()->implicit_value("")->default_value("localhost"), "server host")
("port", boost::program_options::value<int>()->default_value(9000), "server port")
("user,u", boost::program_options::value<std::string>(), "user")
("password", boost::program_options::value<std::string>(), "password")
("query,q,e", boost::program_options::value<std::string>(), "query")
("database,d", boost::program_options::value<std::string>(), "database")
("multiline,m", "multiline")
("multiquery,n", "multiquery")
("format,f", boost::program_options::value<std::string>(), "default output format")
("vertical,E", "vertical output format, same as --format=Vertical or FORMAT Vertical or \\G at end of command")
("time,t", "print query execution time to stderr in non-interactive mode (for benchmarks)")
APPLY_FOR_SETTINGS(DECLARE_SETTING)
APPLY_FOR_LIMITS(DECLARE_LIMIT)
;
#undef DECLARE_SETTING
#undef DECLARE_LIMIT
/// Перечисляем опции командной строки относящиеся к внешним таблицам
boost::program_options::options_description external_description("External tables options");
external_description.add_options()
("file", boost::program_options::value<std::string>(), "data file or - for stdin")
("name", boost::program_options::value<std::string>()->default_value("_data"), "name of the table")
("format", boost::program_options::value<std::string>()->default_value("TabSeparated"), "data format")
("structure", boost::program_options::value<std::string>(), "structure")
("types", boost::program_options::value<std::string>(), "types")
;
/// Парсим основные опции командной строки
boost::program_options::parsed_options parsed = boost::program_options::command_line_parser(argc, argv).options(main_description).allow_unregistered().run();
boost::program_options::variables_map options;
boost::program_options::store(parsed, options);
/// Демонстрация help message
if (options.count("help")
|| (options.count("host") && (options["host"].as<std::string>().empty() || options["host"].as<std::string>() == "elp")))
{
std::cout << main_description << "\n";
std::cout << external_description << "\n";
exit(0);
}
std::vector<std::string> to_pass_further = boost::program_options::collect_unrecognized(parsed.options, boost::program_options::include_positional);
/// Опции командной строки, составленные только из аргументов, не перечисленных в main_description.
char newargc = to_pass_further.size() + 1;
const char * new_argv[newargc];
new_argv[0] = "";
for (size_t i = 0; i < to_pass_further.size(); ++i)
new_argv[i + 1] = to_pass_further[i].c_str();
/// Разбиваем на интервалы внешних таблиц.
std::vector<int> positions;
positions.push_back(0);
for (int i = 1; i < newargc; ++i)
if (strcmp(new_argv[i], "--external") == 0)
positions.push_back(i);
positions.push_back(newargc);
size_t cnt = positions.size();
if (cnt == 2 && newargc > 1)
{
Exception e("Unknown option " + to_pass_further[0] + ". Maybe missed --external flag in front of it.", ErrorCodes::BAD_ARGUMENTS);
std::string text = e.displayText();
std::cerr << "Code: " << e.code() << ". " << text << std::endl;
exit(e.code());
}
size_t stdin_count = 0;
for (size_t i = 1; i + 1 < cnt; ++i)
{
/// Парсим основные опции командной строки
boost::program_options::parsed_options parsed = boost::program_options::command_line_parser(positions[i + 1] - positions[i], &new_argv[positions[i]]).options(external_description).run();
boost::program_options::variables_map external_options;
boost::program_options::store(parsed, external_options);
try
{
external_tables.emplace_back(external_options);
if (external_tables.back().file == "-")
2014-03-27 19:09:23 +00:00
++stdin_count;
if (stdin_count > 1)
throw Exception("Two or more external tables has stdin (-) set as --file field", ErrorCodes::BAD_ARGUMENTS);
}
catch (const Exception & e)
{
std::string text = e.displayText();
std::cerr << "Code: " << e.code() << ". " << text << std::endl;
std::cerr << "Table №" << i << std::endl << std::endl;
exit(e.code());
}
}
/// Извлекаем settings and limits из полученных options
#define EXTRACT_SETTING(TYPE, NAME, DEFAULT) \
if (options.count(#NAME)) \
context.setSetting(#NAME, options[#NAME].as<std::string>());
APPLY_FOR_SETTINGS(EXTRACT_SETTING)
APPLY_FOR_LIMITS(EXTRACT_SETTING)
#undef EXTRACT_SETTING
/// Сохраняем полученные данные во внутренний конфиг
if (options.count("config-file"))
config().setString("config-file", options["config-file"].as<std::string>());
if (options.count("host"))
config().setString("host", options["host"].as<std::string>());
if (options.count("query"))
config().setString("query", options["query"].as<std::string>());
if (options.count("database"))
config().setString("database", options["database"].as<std::string>());
if (options.count("port"))
config().setInt("port", options["port"].as<int>());
if (options.count("user"))
config().setString("user", options["user"].as<std::string>());
if (options.count("password"))
config().setString("password", options["password"].as<std::string>());
if (options.count("multiline"))
config().setBool("multiline", true);
if (options.count("multiquery"))
config().setBool("multiquery", true);
if (options.count("format"))
config().setString("format", options["format"].as<std::string>());
if (options.count("vertical"))
config().setBool("vertical", true);
if (options.count("time"))
print_time_to_stderr = true;
2012-03-25 03:47:13 +00:00
}
};
}
int main(int argc, char ** argv)
{
2012-03-26 02:48:08 +00:00
DB::Client client;
try
{
client.init(argc, argv);
}
catch (const boost::program_options::error & e)
{
std::cerr << "Bad arguments: " << e.what() << std::endl;
return 1;
}
2012-03-26 02:48:08 +00:00
return client.run();
2012-03-25 03:47:13 +00:00
}