aboutsummaryrefslogtreecommitdiffstats
path: root/kikimr/README.md
diff options
context:
space:
mode:
authorkomels <komels@yandex-team.ru>2022-04-14 13:10:53 +0300
committerkomels <komels@yandex-team.ru>2022-04-14 13:10:53 +0300
commit21c9b0e6b039e9765eb414c406c2b86e8cea6850 (patch)
treef40ebc18ff8958dfbd189954ad024043ca983ea5 /kikimr/README.md
parent9a4effa852abe489707139c2b260dccc6f4f9aa9 (diff)
downloadydb-21c9b0e6b039e9765eb414c406c2b86e8cea6850.tar.gz
Final part on compatibility layer: LOGBROKER-7215
ref:777c67aadbf705d19034a09a792b2df61ba53697
Diffstat (limited to 'kikimr/README.md')
-rw-r--r--kikimr/README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/kikimr/README.md b/kikimr/README.md
new file mode 100644
index 0000000000..a0c453aa1d
--- /dev/null
+++ b/kikimr/README.md
@@ -0,0 +1,40 @@
+# Yandex Database (YDB aka KiKiMR) and Related Projects
+
+See <https://wiki.yandex-team.ru/kikimr> for details.
+
+> For client SDK, examples, API description go to the `public` directory.
+
+## YDB Directory Structure
+
+`blockstore` -- a contract for Blockstore project (messages and their ids);
+`core` -- YDB implementation;
+`docs` -- documentation as a code;
+`driver` -- YDB binary for Yandex (has some internal deps like Unified Agent, TVM, etc);
+`driver_lib` -- a common part for `driver` and `driver_oss`;
+`driver_oss` -- YDB binary for open source;
+`filestore` -- a contract for Filestore project (messages and their ids);
+`kikhouse_new` -- ClickHouse over YDB;
+`library` -- standalone libraries used by YDB;
+`mvp` -- a proxy to YDB, implements UI calls, etc;
+`papers` -- papers about YDB;
+`persqueue` -- persistent queue (aka Logbroker) implementation;
+`public` -- SDKs, APIs and tools for YDB end users;
+`services` -- grpc services for YDB public API;
+`sqs` -- Amazon SQS (Simple Queue Service) API implementation on top of YDB. It is provided in Yandex.Cloud as
+YMQ (Yandex Message Queue);
+`streaming` -- YQL Streams implementation (as a part of Yandex Query service);
+`ydbcp` -- YDB Control Plane;
+`yf` -- Yandex Functions serverless computing and job execution service;
+`yq` -- Yandex Query implementation;
+
+
+## Rest
+ci
+deployment
+juggler
+production
+scripts
+serverless_proxy
+testing
+tools
+