Update README.md adding CQRS diagram

fupelaqu · fupelaqu · commit 8c07509d39c5 · 2023-04-25T09:44:27.000+02:00
diff --git a/README.md b/README.md
@@ -1,2 +1,5 @@
 # generic-persistence-api
-a scala framework for persistence and CQRS using akka persistence
+a CQRS/ES framework in scala using akka persistence
+
+![](docs/diagrams/src/CQRS.svg)
+
diff --git a/docs/diagrams/src/CQRS.svg b/docs/diagrams/src/CQRS.svg
@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Do not edit this file with editors other than diagrams.net -->
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="801px" height="391px" viewBox="-0.5 -0.5 801 391" content="&lt;mxfile host=&quot;drawio-plugin&quot; modified=&quot;2023-04-25T07:35:02.622Z&quot; agent=&quot;5.0 (Macintosh; Intel Mac OS X 12_3_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.114 Safari/537.36&quot; etag=&quot;X5LtzmShXzT8pg6mCjXa&quot; version=&quot;20.5.3&quot; type=&quot;embed&quot;&gt;&lt;diagram id=&quot;23iRSUPoRavnBvh4doch&quot; name=&quot;Page-1&quot;&gt;5Vpdc6M2FP01flwPkkCIx42TbafTnab1w7aPAmSbWQyuwLHdX1/JiC9JdhwH7OxsHmJ0ERd079G5R4gJmq33v3C6WX3NY5ZOoBPvJ+hxAqGHffFfGg6VAQOvMix5Elcm0BrmyX9MGR1l3SYxK3odyzxPy2TTN0Z5lrGo7Nko5/mu322Rp/27buiSGYZ5RFPT+i2Jy1VlJdBv7b+yZLmq7wxwUJ1Z07qzGkmxonG+65jQ0wTNeJ6X1dF6P2OpjF0dl+q6LyfONg/GWVZedIF65BeabtXg1IOVh3q0S55vNxP0sMizcq7MTt2ucgNc0VaeGC/Z3pYGGtYeHfMxQTN4ARqWr1nJD6KLckTUFQov0FHtXRt9UHtddSJfX0dVwpeN5zYm4kCFxR6i4PUIsSz+LGElWlFKiyKJRDhW5TqVoRGHIoBZzOJO3L7QdZLK0czytegNnTnNCvHzdS46iKDww9+q97HxT7fxuO+1pBcCp15teGY8EYNkXPWqnpbFBqQ7wVcoKClfMmVD9oR0Iu5ZAl7bOEtpmbz0b2nLgrrDc56Ih2ny3SRTJRxpeSzyLY+YuqgLb92P3/fzCWqOqhEbjo6YaEZ9EUyIAZOnrExKGbMHtqIvSc5N3KSpoCzReNitkpLNNzSSZ3aCNPsAehUy3bkJZTtJ01me5vx4I7RYMBxJUBYlz7+zzpnYD0LnTbPZBM5ZlIw2L8EFE7OirvF4CffhBVyTlxrsDj1+/FMCLrgf4JAFbzgVN3hIelHG/25l+T4O8FNxHOFn0QHgzf44zPq8OFqq37Tu/y5HvwlWzGha+xPjqVz2byPMSWvTACL0yEYeRoc0ESWLo9ehElbF7fewMdDo+/JY8v7YlsINU/ZCJdu7CF99PMWUkYUVTzgiLFxoeMKGXLkIXGfnOnK1yQ4sIsSxYA/oRecqtvM+igyZ4jNCpGldo0LUgI61vcdxH0eXuHDqQuw6mPgABDDwNf4HUx94PiS+Bz3kB+Q62QIDDWrBaLIF2hYAb+Qj9wQffeOCOGTWX0SOJaxqzyF/l99dIlItUbEsTnMdXUueysJiY+O5thA2jJfm23iowtgpa0ZhXMAThRGH2BuDuACxi+lb1EybLJZoEKZnnkesKKRKceYlZ3Q9tlw5nZXYYyR2bVkhMERYzwocICueXk4s2nG8tNi080Cz/i9G4xEmfXiopvwPN+MZEOjybdgKsI/oGDPe9frYgjapMppMdizYGlepdDMgFyNsn5RSuICpUzcr6eIRpNqtdpGNQ6ehK5dTMqh54XJCBl2neJCpeCoOvZfkcYmuRbzrRI2HdMLTHA0nahA4SW/vW6r9uWXH0D/+aKspfW3Up6gQxPHCsVEUcHwUsBEoytfe8AGLKgksqNaV8FUMZa7kRdDWNIsLI4UtE4EbiEMSMbs4DIknSX0Ecahpw0tVCB4iDxdsPtyoUig6rwvF2SJxJbFbmP2uxK6vCq5+x67xuiEiBuR1czUhGTlhd563ocMQw7Z56zDiEDLCvMV6Nb3hvHVt5fUjzFtwXtw1Qm4qtceFW2vuFL1ra83CBMRkAnQi27ehAs87UYzfygVY3xDRHQ3HBW69CL8jCN+8T+ud2adtFi39FcsIpQh+OABibZ+2obO3AtCQlTrfDQdAYG7AGQC0fTpRk+cY+5Ha6MmFRWGQV0pGNH6G7Uj86qwZb//bvTkBXvsq5KZ8hy2EZ+G7e9Kd/nmLdyXbQRf3/GB36qCg/cMDcZ9otp+kVd3b7/rQ0/8=&lt;/diagram&gt;&lt;/mxfile&gt;"><defs/><g><path d="M 190 220 L 323.85 184.15" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="none"/><path d="M 328.92 182.79 L 323.06 187.98 L 323.85 184.15 L 321.25 181.22 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="none"/><ellipse cx="130" cy="230" rx="60" ry="40" fill="#ffe6cc" stroke="#d79b00" pointer-events="none"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 230px; margin-left: 71px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 14px; font-family: &quot;Comic Sans MS&quot;; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: none; font-style: italic; white-space: normal; overflow-wrap: normal;">Entity Behavior</div></div></div></foreignObject><text x="130" y="234" fill="rgb(0, 0, 0)" font-family="Comic Sans MS" font-size="14px" text-anchor="middle" font-style="italic">Entity Behavior</text></switch></g><ellipse cx="110" cy="170" rx="60" ry="40" fill="#ffe6cc" stroke="#d79b00" pointer-events="none"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 170px; margin-left: 51px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 14px; font-family: &quot;Comic Sans MS&quot;; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: none; font-style: italic; white-space: normal; overflow-wrap: normal;">Entity Behavior</div></div></div></foreignObject><text x="110" y="174" fill="rgb(0, 0, 0)" font-family="Comic Sans MS" font-size="14px" text-anchor="middle" font-style="italic">Entity Behavior</text></switch></g><path d="M 330 115 C 330 106.72 352.39 100 380 100 C 393.26 100 405.98 101.58 415.36 104.39 C 424.73 107.21 430 111.02 430 115 L 430 205 C 430 213.28 407.61 220 380 220 C 352.39 220 330 213.28 330 205 Z" fill="#dae8fc" stroke="#6c8ebf" stroke-miterlimit="10" pointer-events="none"/><path d="M 430 115 C 430 123.28 407.61 130 380 130 C 352.39 130 330 123.28 330 115" fill="none" stroke="#6c8ebf" stroke-miterlimit="10" pointer-events="none"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 98px; height: 1px; padding-top: 173px; margin-left: 331px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 16px; font-family: &quot;Comic Sans MS&quot;; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: none; white-space: normal; overflow-wrap: normal;"><i style="font-size: 16px;"><font style="font-size: 16px;">Journal</font></i></div></div></div></foreignObject><text x="380" y="177" fill="rgb(0, 0, 0)" font-family="Comic Sans MS" font-size="16px" text-anchor="middle">Journal</text></switch></g><path d="M 169.99 170.55 L 323.63 171.94" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="none"/><path d="M 328.88 171.99 L 321.85 175.43 L 323.63 171.94 L 321.91 168.43 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="none"/><path d="M 200 40 C 176 40 170 60 189.2 64 C 170 72.8 191.6 92 207.2 84 C 218 100 254 100 266 84 C 290 84 290 68 275 60 C 290 44 266 28 245 36 C 230 24 206 24 200 40 Z" fill="#fff2cc" stroke="#d6b656" stroke-miterlimit="10" pointer-events="none"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 60px; margin-left: 171px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 14px; font-family: &quot;Comic Sans MS&quot;; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: none; white-space: normal; overflow-wrap: normal;"><font style="font-size: 14px;">Write events <br style="font-size: 14px;" />with tags</font> </div></div></div></foreignObject><text x="230" y="64" fill="rgb(0, 0, 0)" font-family="Comic Sans MS" font-size="14px" text-anchor="middle">Write events...</text></switch></g><ellipse cx="590" cy="170" rx="60" ry="40" fill="#d5e8d4" stroke="#82b366" pointer-events="none"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 170px; margin-left: 531px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 14px; font-family: &quot;Comic Sans MS&quot;; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: none; font-style: italic; white-space: normal; overflow-wrap: normal;">Event Processor Stream</div></div></div></foreignObject><text x="590" y="174" fill="rgb(0, 0, 0)" font-family="Comic Sans MS" font-size="14px" text-anchor="middle" font-style="italic">Event Processor S...</text></switch></g><path d="M 470 220 C 446 220 440 240 459.2 244 C 440 252.8 461.6 272 477.2 264 C 488 280 524 280 536 264 C 560 264 560 248 545 240 C 560 224 536 208 515 216 C 500 204 476 204 470 220 Z" fill="#e1d5e7" stroke="#9673a6" stroke-miterlimit="10" pointer-events="none"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 240px; margin-left: 441px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 14px; font-family: &quot;Comic Sans MS&quot;; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: none; white-space: normal; overflow-wrap: normal;"><font style="font-size: 14px;">Read events <br style="font-size: 14px;" />by tag</font> </div></div></div></foreignObject><text x="500" y="244" fill="rgb(0, 0, 0)" font-family="Comic Sans MS" font-size="14px" text-anchor="middle">Read events...</text></switch></g><path d="M 432 169.96 L 523.63 170" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="none"/><path d="M 528.88 170 L 521.88 173.5 L 523.63 170 L 521.88 166.5 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="none"/><path d="M 710 135 C 710 126.72 730.15 120 755 120 C 766.93 120 778.38 121.58 786.82 124.39 C 795.26 127.21 800 131.02 800 135 L 800 195 C 800 203.28 779.85 210 755 210 C 730.15 210 710 203.28 710 195 Z" fill="#b1ddf0" stroke="#10739e" stroke-miterlimit="10" pointer-events="none"/><path d="M 800 135 C 800 143.28 779.85 150 755 150 C 730.15 150 710 143.28 710 135" fill="none" stroke="#10739e" stroke-miterlimit="10" pointer-events="none"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 88px; height: 1px; padding-top: 178px; margin-left: 711px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 16px; font-family: &quot;Comic Sans MS&quot;; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: none; white-space: normal; overflow-wrap: normal;"><i style="font-size: 16px;">Query DB</i></div></div></div></foreignObject><text x="755" y="182" fill="rgb(0, 0, 0)" font-family="Comic Sans MS" font-size="16px" text-anchor="middle">Query DB</text></switch></g><rect x="0" y="330" width="120" height="60" rx="9" ry="9" fill="#f8cecc" stroke="#b85450" pointer-events="none"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 360px; margin-left: 1px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 14px; font-family: &quot;Comic Sans MS&quot;; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: none; white-space: normal; overflow-wrap: normal;">Commands</div></div></div></foreignObject><text x="60" y="364" fill="rgb(0, 0, 0)" font-family="Comic Sans MS" font-size="14px" text-anchor="middle">Commands</text></switch></g><path d="M 60 330 L 100.98 271.46" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="none"/><path d="M 103.99 267.16 L 102.84 274.9 L 100.98 271.46 L 97.1 270.89 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="none"/><rect x="620" y="0" width="120" height="60" rx="9" ry="9" fill="#b0e3e6" stroke="#0e8088" pointer-events="none"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 30px; margin-left: 621px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 14px; font-family: &quot;Comic Sans MS&quot;; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: none; white-space: normal; overflow-wrap: normal;">Queries</div></div></div></foreignObject><text x="680" y="34" fill="rgb(0, 0, 0)" font-family="Comic Sans MS" font-size="14px" text-anchor="middle">Queries</text></switch></g><path d="M 680 60 L 719.51 119.06" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="none"/><path d="M 722.43 123.42 L 715.63 119.55 L 719.51 119.06 L 721.45 115.66 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="none"/><path d="M 650 170 L 703.64 172.23" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="none"/><path d="M 708.88 172.45 L 701.74 175.66 L 703.64 172.23 L 702.03 168.67 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="none"/><ellipse cx="70" cy="110" rx="60" ry="40" fill="#ffe6cc" stroke="#d79b00" pointer-events="none"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 110px; margin-left: 11px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 14px; font-family: &quot;Comic Sans MS&quot;; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: none; font-style: italic; white-space: normal; overflow-wrap: normal;">Entity Behavior</div></div></div></foreignObject><text x="70" y="114" fill="rgb(0, 0, 0)" font-family="Comic Sans MS" font-size="14px" text-anchor="middle" font-style="italic">Entity Behavior</text></switch></g><path d="M 130 110 L 323.82 158.46" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="none"/><path d="M 328.92 159.73 L 321.28 161.43 L 323.82 158.46 L 322.97 154.64 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="none"/></g><switch><g requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"/><a transform="translate(0,-5)" xlink:href="https://www.diagrams.net/doc/faq/svg-export-text-problems" target="_blank"><text text-anchor="middle" font-size="10px" x="50%" y="100%">Text is not SVG - cannot display</text></a></switch></svg>
