KVX_new_version.htm 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  7. <meta name="description" content="" />
  8. <meta name="author" content="Maxim Sokhatsky" />
  9. <title>Нова версія KVX</title>
  10. <link rel="stylesheet" href="https://forms.n2o.space/priv/static/css/forms.css?v=1" />
  11. <link rel="stylesheet" href="../../blank.css?v=2" />
  12. </head>
  13. <body>
  14. <nav>
  15. <a href='https://n2o.dev'>DEV</a>
  16. <a href='https://kvx.n2o.space'>KVS</a>
  17. <a href='#' style="background:#ededed;">KVX</a>
  18. </nav>
  19. <main>
  20. <section>
  21. <h3>Нова версія KVX 6.4</h3>
  22. <p>KVX — слой абстракції, який складається з двох частин: базового API та API керування стрімами,
  23. тейк, дроп, фолд, катаморфізм, як ви любите. Головний API в модулі kvx,
  24. а стрімовий — в kvx_stream. Користуючись нагодою, хочу пропіарити схожі рішення
  25. в області зберігання даних на erlang: <a href="https://github.com/fogfish/datum">datum</a> та серія бібліотек
  26. від Дмитра Колесникова, <a href="https://github.com/emqx/replayq">replayq</a> від Фенга Лі,
  27. а також небагатьох інших, хто намагався абстрактно вирішити проблему.</p>
  28. <h3>Чому KVX?</h3>
  29. <p>Призначення KVX:</p>
  30. <p>— надання інтерфейсу абстрагування широкого спектра сховищ;<br>
  31. — надання зручного Erlang REPL інтерфейсу для роботи з записами (records);<br>
  32. — розділення на базовий (get put) інтерфейс, та стрім інтерфейс ітераторів (next prev);<br>
  33. — набір драйверів (внутрішня база, зовнішня база і файлова система);<br>
  34. — шари даних: файлова система, ланцюжки повідомлень, банківські транзакції, дерева
  35. підписів, трейси бізнес-процесів, блокчейни, системи черг,
  36. тайм серіес, ось це все.<br>
  37. </p>
  38. <p>Розпочинаючи з незначної модифікації KVX поміняла назву, тепер це "Абстрактна База Ланцюжків",
  39. а не "Абстрактна База Термів", оскільки відділився окремий стрім API.</p>
  40. <p>— <a href="https://github.com/synrc/kvx">synrc/kvx</a> — 6.4<br></p>
  41. <p> Розповімо трохи про теоретичні основи KVX. Ця бібліотека дозволяє або повинна
  42. дозволяти зберігати та діставати структури будь-якого виду, надаючи семантику управління
  43. курсорами next prev, якою володіють дерева. Тому можна сказати, що це інтерфейс
  44. оператора до деревоподібних сховищ та сховищ ланцюжків. У своїй основі KVX підтримує три
  45. механізми зберігання ланцюжків:</p>
  46. <p>1) перший, очевидний — двонаправлені списки, де вказівники next та prev
  47. безпосереднім чином присутні в даних. Спосіб підходить
  48. навіть для керування деревами;</p>
  49. <p>2) другий, очевидний — однонаправлені списки, де наявний тільки вказівник next. Цей спосіб підходить для списків.
  50. Багато людей запитують про цей спосіб, але ми його ніколи не використовували,
  51. тому немає імплементації;</p>
  52. <p>3) третій, неочевидний спосіб — пряме вбудовувавання записів в BTree index,
  53. zero-overhead.</p>
  54. <p>В якомусь сенсі перший та другий способи реалізують певний шар поверх KVX,
  55. оскільки kvx_stream працює з будь-якими стораджами поліморфно, а ось kvx_st драйвер
  56. стрімів зроблений спеціально для rocksdb.</p>
  57. <h3>Дерева</h3>
  58. <p>Двонаправлені списки або дерева, перша модель, яка лягає прямо з С++ класів, при вивченні програмування —
  59. це зберігати в базі прямі вказівники, така система зберігання може використовуватися навіть,
  60. якщо integer поміняти на pid, тоді можна буде точково відновлювати історію виклику.</p>
  61. <figure>
  62. <code>
  63. -record(iter, { id = [] :: [] | integer(),
  64. next = [] :: [] | integer(),
  65. prev = [] :: [] | integer() } ).
  66. </code>
  67. </figure>
  68. <p>Перше поле будь-якої таблиці — це її ім'я, друге — id, третє та
  69. четверте — next і prev (сигнатура бінарного розгалуження).
  70. Поліморфно за цими зміщеннями ми очікуємо наявність цих полів
  71. для лінковки даних в ланцюжки.
  72. Базова частина разом називається #iter.</p>
  73. <h4>kvx_stream — <b>#iter{}</b></h4>
  74. <p> За поліморфое явне управління application level полями next prev рекорда #iter
  75. відповідає модуль kvx_stream. Наприклад, файловая система не надає управління
  76. своїми курсорами, тому імплементація fs вимагає наявності полів лінковки.</p>
  77. <h3>Списки</h3>
  78. <p>Однонаправлені списки, чи просто списки, це друга модель. Все таке ж, тільки без повернення назад.
  79. Не підтримується пока жодною версією KVX.</p>
  80. <figure>
  81. <code>
  82. -record(ite, { id = [] :: [] | integer(),
  83. next = [] :: [] | integer() } ).
  84. </code>
  85. </figure>
  86. <h4>kvx_stre — <b>#ite{}</b></h4>
  87. <p>Цей модуль не реалізовано, і запис не специфікований.</p>
  88. <h3>Вбудовування в індекс</h3>
  89. <p>Третя модель представляє собою прямий, більш ефективний спосіб вбудовування простору бізнес-об'єктів
  90. в простір ключів розташованої нижче таблиці, і передача управління курсорами BTree таблиці
  91. відразу в драйвер, а не в ручний link walking, як це було в riak.
  92. Базова частина поліморфних записів складається тільки з імені таблиці
  93. та id, і має назву #it. Ця модель використовується в rocksdb бекенді, який з'явився у 6.4.</p>
  94. <figure>
  95. <code>
  96. -record(it, { id = [] :: [] | integer() } ).
  97. </code>
  98. </figure>
  99. <p>Таким чином, ми можемо емулювати таблиці, в рамках єдиного простору ключів,
  100. додаючи їх як префікси до ключа (little endian), який буде автоматично
  101. відображатись в головному BTree дереві, також в цьому просторі ви можете
  102. зберігати і фіди (стріми), наприклад, топіки: <b>/p2p/maxim/doxtop</b>.
  103. Це вимагає спеціальної модифікації kvx_st для работи з записом #it,
  104. на відміну від двонаправленого #iter, який працює з драйвером kvx_stream.</p>
  105. <h4>kvx_st — <b>#it{}</b></h4>
  106. <p>За керування курсорами по ітератору бази даних відповідає модуль kvx_st.</p>
  107. <h3>На прикладі</h3>
  108. <p>Код, який показує головну ідею, на прикладі драйвера rocksdb:</p>
  109. <figure>
  110. <code>
  111. 1> {ok,Ref} = rocksdb:open("hey",[{create_if_missing,true}]).
  112. 2> rocksdb:put(Ref, <<"/users/1">>,<<"maxim">>,[{sync,true}]).
  113. 3> rocksdb:put(Ref, <<"/users/2">>,<<"doxtop">>,[{sync,true}]).
  114. 4> rocksdb:put(Ref, <<"/users/3">>,<<"vlad">>,[{sync,true}]).
  115. 5> rocksdb:put(Ref, <<"/staff/1">>,<<"vlad">>,[{sync,true}]).
  116. 6> rocksdb:put(Ref, <<"/staff/2">>,<<"maxim">>,[{sync,true}]).
  117. 7> rocksdb:put(Ref, <<"/staff/3">>,<<"doxtop">>,[{sync,true}]).
  118. 8> {ok,I} = rocksdb:iterator(Ref,[]).
  119. 9> rocksdb:iterator_move(I,{seek,<<"/staff/">>}).
  120. 10> rocksdb:iterator_move(I,next).
  121. 11> rocksdb:iterator_move(I,next).
  122. 12> rocksdb:iterator_move(I,next).
  123. 13> rocksdb:iterator_move(I,{seek,<<"/users/">>}).
  124. 14> rocksdb:iterator_move(I,next).
  125. 15> rocksdb:iterator_move(I,next).
  126. 16> rocksdb:iterator_move(I,next).
  127. </code>
  128. </figure>
  129. <h3>KVX REPL</h3>
  130. <p>Тепер, щоб зробити те ж саме на KVX, ви можете зробити просто:</p>
  131. <figure>
  132. <code>
  133. 1> kvx:ver().
  134. {version,"KVX ROCKSDB"}
  135. 2> rr(kvx).
  136. [emails,id_seq,it,iter,kvx,reader,schema,table,writer]
  137. 3> kvx:join().
  138. ok
  139. 4> kvx:put(#emails{id=1,email="maxim"}).
  140. 5> kvx:put(#emails{id=2,email="doxtop"}).
  141. 6> kvx:put(#writer{id=2}).
  142. 7> kvx:put(#writer{id=1}).
  143. 8> kvx:all(writer).
  144. [#writer{id = 1,count = 0,cache = [],args = [],first = []},
  145. #writer{id = 2,count = 0,cache = [],args = [],first = []}]
  146. 9> kvx:all(emails).
  147. [#emails{id = 1,next = [],prev = [],email = "maxim"},
  148. #emails{id = 2,next = [],prev = [],email = "doxtop"}]
  149. 10> kvx:add(#writer{id=chain,args=#emails{email="maxim@synrc.com"}}).
  150. 11> kvx:add(#writer{id=chain,args=#emails{email="vlad@synrc.com"}}).
  151. 12> kvx:add(#writer{id=chain,args=#emails{email="doxtop@synrc.com"}}).
  152. 13> kvx:all(chain).
  153. [#emails{id = 1555244691729330000,next = [],prev = [],
  154. email = "maxim@synrc.com"},
  155. #emails{id = 1555244699905648000,next = [],prev = [],
  156. email = "doxtop@synrc.com"},
  157. #emails{id = 1555244696660271000,next = [],prev = [],
  158. email = "vlad@synrc.com"}]
  159. </code>
  160. </figure>
  161. <p>Єдиний тест на стріми, який проходить:</p>
  162. <figure>
  163. <code>
  164. > kvx:check().
  165. ok
  166. </code>
  167. </figure>
  168. <h3>Документація</h3>
  169. <p>Надіюсь зробити цю рубрику в release notes офіційною та регулярною,
  170. на жаль, якщо не брать до уваги man сторінки для модулій драйверів,
  171. то залишається лише два модулі, для яких потрібна документація — це <a href="https://kvx.n2o.space/man/kvx.htm">kvx</a> та <a href="https://kvx.n2o.space/man/kvx_stream.htm">kvx_stream</a>.
  172. Я, звичайно, формально додав сторінки для всіх модулів, і в майбутньому хочеться,
  173. щоб штучний інтелект генерував документацію. Також я зрозумів, що
  174. ченджлог та реліз замітки у власному блозі є чудовим способом авторського анонсування!
  175. Зробив історію таких сторінок в README.md.</p>
  176. <h3>На закінчення</h3>
  177. <p>Репозиторій (що депендить <a href="https://gitlab.com/barrel-db/erlang-rocksdb">rocksdb NIF драйвер</a>, який повільно компілюється,
  178. від Бенуа Кісенау, <a href="https://github.com/Vonmo/rocker">Rust-версію Rocker</a> від Максима Молчанова вирішив відкласти,
  179. надто часто раст оновлюється, неможливо зафрізити)
  180. одразу включає файл конфігурації для rocksdb:</p>
  181. <p>— <a href="https://github.com/voxoz/kv">voxoz/kv</a></p>
  182. <p>P.S. Вбудовування в BTree можна застосовувати не лише в таких базах, як rocksdb,
  183. але й для mnesia, і для будь-яких баз взагалі.</p>
  184. <p>P.P.S. Також можна використовувати rocksdb у якості драйвера для mnesia (написаний
  185. Ульфом Вігером для проекта Аетерніті), або скоріше різновид таблиці rocksdb_copies —
  186. <a href="https://github.com/aeternity/mnesia_rocksdb">mnesia_rocksdb</a>.</p>
  187. </section>
  188. </main>
  189. <footer>Namdak Tonpa <span class="heart">&nbsp;❤&nbsp;</span> 2009—2019</footer>
  190. </body>
  191. </html>