diff options
author | max42 <max42@yandex-team.com> | 2023-06-30 03:37:03 +0300 |
---|---|---|
committer | max42 <max42@yandex-team.com> | 2023-06-30 03:37:03 +0300 |
commit | fac2bd72b4b31ec3238292caf8fb2a8aaa6d6c4a (patch) | |
tree | b8cbc1deb00309c7f1a7ab6df520a76cf0b5c6d7 /yt/cpp/mapreduce/interface/init.h | |
parent | 7bf166b1a7ed0af927f230022b245af618e998c1 (diff) | |
download | ydb-fac2bd72b4b31ec3238292caf8fb2a8aaa6d6c4a.tar.gz |
YT-19324: move YT provider to ydb/library/yql
This commit is formed by the following script: https://paste.yandex-team.ru/6f92e4b8-efc5-4d34-948b-15ee2accd7e7/text.
This commit has zero effect on all projects that depend on YQL.
The summary of changes:
- `yql/providers/yt -> ydb/library/yql/providers/yt `- the whole implementation of YT provider is moved into YDB code base for further export as a part of YT YQL plugin shared library;
- `yql/providers/stat/{expr_nodes,uploader} -> ydb/library/yql/providers/stat/{expr_nodes,uploader}` - a small interface without implementation and the description of stat expr nodes;
- `yql/core/extract_predicate/ut -> ydb/library/yql/core/extract_predicate/ut`;
- `yql/core/{ut,ut_common} -> ydb/library/yql/core/{ut,ut_common}`;
- `yql/core` is gone;
- `yql/library/url_preprocessing -> ydb/library/yql/core/url_preprocessing`.
**NB**: all new targets inside `ydb/` are under `IF (NOT CMAKE_EXPORT)` clause which disables them from open-source cmake generation and ya make build. They will be enabled in the subsequent commits.
Diffstat (limited to 'yt/cpp/mapreduce/interface/init.h')
-rw-r--r-- | yt/cpp/mapreduce/interface/init.h | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/yt/cpp/mapreduce/interface/init.h b/yt/cpp/mapreduce/interface/init.h new file mode 100644 index 0000000000..302be268fc --- /dev/null +++ b/yt/cpp/mapreduce/interface/init.h @@ -0,0 +1,71 @@ +#pragma once + +/// +/// @file yt/cpp/mapreduce/interface/init.h +/// +/// Initialization functions of YT Wrapper. + +#include <yt/cpp/mapreduce/interface/wait_proxy.h> + +#include <util/generic/fwd.h> + +#include <functional> + +namespace NYT { + +//////////////////////////////////////////////////////////////////////////////// + +/// Options for @ref NYT::Initialize() and @ref NYT::JoblessInitialize() functions +struct TInitializeOptions +{ + using TSelf = TInitializeOptions; + + /// + /// @brief Override waiting functions for YT Wrapper. + /// + /// This options allows to override functions used by this library to wait something. + FLUENT_FIELD_DEFAULT(::TIntrusivePtr<IWaitProxy>, WaitProxy, nullptr); + + /// + /// @brief Enable/disable cleanup when program execution terminates abnormally. + /// + /// When set to true, library will abort all active transactions and running operations when program + /// terminates on error or signal. + FLUENT_FIELD_DEFAULT(bool, CleanupOnTermination, false); + + /// + /// @brief Set callback to be called before exit() in job mode. + /// + /// Provided function will be called just before exit() when program is started in job mode. + /// This might be useful for shutting down libraries that are used inside operations. + /// + /// NOTE: Keep in mind that inside job execution environment differs from client execution environment. + /// So JobOnExitFunction should not depend on argc/argv environment variables etc. + FLUENT_FIELD_OPTION(std::function<void()>, JobOnExitFunction); +}; + +/// +/// @brief Performs basic initialization (logging, termination handlers, etc). +/// +/// This function never switches to job mode. +void JoblessInitialize(const TInitializeOptions& options = TInitializeOptions()); + +/// +/// @brief Performs basic initialization and switches to a job mode if required. +/// +/// This function performs basic initialization (it sets up logging reads the config, etc) and checks if binary is launched +/// on YT machine inside a job. If latter is true this function launches proper job and after job is done it calls exit(). +/// +/// This function must be called if application starts any operation. +/// This function must be called immediately after entering main() function before any argument parsing is done. +void Initialize(int argc, const char **argv, const TInitializeOptions &options = TInitializeOptions()); + +/// Similar to @ref NYT::Initialize(int, const char**, const TInitializeOptions&) +void Initialize(int argc, char **argv, const TInitializeOptions &options = TInitializeOptions()); + +/// Similar to @ref NYT::Initialize(int, const char**, const TInitializeOptions&) +void Initialize(const TInitializeOptions &options = TInitializeOptions()); + +//////////////////////////////////////////////////////////////////////////////// + +} // namespace NYT |