From 12b51011c894f46b24338500becf859484ba9b08 Mon Sep 17 00:00:00 2001 From: "Daniel J. Summers" Date: Wed, 25 May 2022 18:19:06 -0400 Subject: [PATCH] Update deps + Add docs = RC1 --- README.md | 14 ++++++ src/RethinkDB.DistributedCache/Cache.fs | 2 +- src/RethinkDB.DistributedCache/README.md | 40 ++++++++++++++++++ .../RethinkDB.DistributedCache.fsproj | 26 +++++++----- src/RethinkDB.DistributedCache/logo.png | Bin 0 -> 5034 bytes 5 files changed, 70 insertions(+), 12 deletions(-) create mode 100644 README.md create mode 100644 src/RethinkDB.DistributedCache/README.md create mode 100644 src/RethinkDB.DistributedCache/logo.png diff --git a/README.md b/README.md new file mode 100644 index 0000000..36843fa --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# RethinkDB.DistributedCache + +[![Nuget (with prereleases)][pkg-img]][pkg-url] + +This library provides an ASP.NET Core-capable distributed cache backed by RethinkDB. + +For a quick start, see [the library's README][lib]. + +For a slightly longer read, see [the full library documentation][proj]. + +[pkg-img]: https://img.shields.io/nuget/vpre/RethinkDB.DistributedCache +[pkg-url]: https://www.nuget.org/packages/RethinkDB.DistributedCache/ +[lib]: ./tree/main/src/RethinkDB.DistributedCache/README.md +[proj]: https://bitbadger.solutions/open-source/rethinkdb-distributedcache/ diff --git a/src/RethinkDB.DistributedCache/Cache.fs b/src/RethinkDB.DistributedCache/Cache.fs index cfeb017..a7a3482 100644 --- a/src/RethinkDB.DistributedCache/Cache.fs +++ b/src/RethinkDB.DistributedCache/Cache.fs @@ -103,7 +103,7 @@ module Entry = let get cacheOpts log (key : string) (cancelToken : CancellationToken) = backgroundTask { let table = table cacheOpts let debug = debug cacheOpts log - debug <| fun () -> $"Retriving cache entry {key}" + debug <| fun () -> $"Retrieving cache entry {key}" match! rethink { withTable table get key diff --git a/src/RethinkDB.DistributedCache/README.md b/src/RethinkDB.DistributedCache/README.md new file mode 100644 index 0000000..c9c597a --- /dev/null +++ b/src/RethinkDB.DistributedCache/README.md @@ -0,0 +1,40 @@ +# RethinkDB.DistributedCache + +This package provides an [ASP.NET Core cache implementation][cache] backed by [RethinkDB][]. + +## Quick Start + +### C# + +```csharp +using RethinkDB.DistributedCache; + +IConnection conn = yourRethinkDBConnection; // set up connection first + +// within ASP.NET Core service configuration +builder.Services.AddDistributedRethinkDBCache(opts => opts.Connection = conn); + +// it will be used by other processes, such as sessions +``` + +### F# + +```fsharp +open RethinkDB.DistributedCache + +let conn = yourRethinkDBConnection // set up connection first + +// within ASP.NET Core service configuration +let _ = builder.Services.AddDistributedRethinkDBCache(fun opts -> + opts.Connection <- conn) + +// it will be used by other processes, such as sessions +``` + +## More Information + +More information and details can be found at the [project site][]. + +[cache]: https://docs.microsoft.com/en-us/aspnet/core/performance/caching/distributed +[RethinkDB]: https://www.rethinkdb.com +[project site]: https://bitbadger.solutions/open-source/rethinkdb-distributedcache/ diff --git a/src/RethinkDB.DistributedCache/RethinkDB.DistributedCache.fsproj b/src/RethinkDB.DistributedCache/RethinkDB.DistributedCache.fsproj index ad60837..1b72ae1 100644 --- a/src/RethinkDB.DistributedCache/RethinkDB.DistributedCache.fsproj +++ b/src/RethinkDB.DistributedCache/RethinkDB.DistributedCache.fsproj @@ -2,27 +2,29 @@ net6.0;netstandard2.0 + An IDistributedCache implementation utilizing RethinkDB for storage true - 0.9.0 - danieljsummers - https://github.com/danieljsummers/RethinkDB.DistributedCache + Daniel J. Summers,Bit Badger Solutions + https://github.com/bit-badger/RethinkDB.DistributedCache + git + https://bitbadger.solutions/open-source/rethinkdb-distributedcache/ + logo.png + README.md false - https://github.com/danieljsummers/RethinkDB.DistributedCache - Git MIT License MIT - RethinkDB IDistributedCache ASP.NET Core - An IDistributedCache implementation utilizing RethinkDB for storage - alpha05 - Provider now stores successfully; do not use an earlier version + RethinkDB IDistributedCache aspnetcore + 1.0.0 + rc1 + Release Candidate; repackaged with more stable underlying driver and documentation - - + + @@ -31,6 +33,8 @@ + + diff --git a/src/RethinkDB.DistributedCache/logo.png b/src/RethinkDB.DistributedCache/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..8dba85b8daffe88b9f2b2bff07a2724d42449f8f GIT binary patch literal 5034 zcmZ`-c{J2t*#FumS%%P%gvgSF#2{rES<1d;UuF=IEMuEU*1=>aG-S!XWiLzC#xfb9 zERD4(Yj(!YJHLP5^S*!Fd(XMgbI!fzxu5%ap63%|pr^^q$ioN#0JF9h%!smv{x?9> zl=-nW84CbZysql%2HNWC{4cycon76X06;VeZg2m)Uz>2tncd#LZ}6rVqqn~i8jUfs zZ}0Btj+d#ff)M&Z&8WaXVf(vaGRw!TM1B|kW2VHl#P}XP zHAnR|I;sW4b#@zFT2bvvQL5qRdQ42YQjuuEE=B>I1bq*ViRtkpu;XDI1S0W;`l|?k zPqMR&l)I;sed4D`u(3r)N5^be$H%po-mZq+KitIl?+*qfD`X{@nUD(BDa-VHNT&(eKc|IumR(eJrJwIFDbw4oPV`e6r# z(c$-iUTXN7OLWw0pO(>cj%Bf z&8CGDaKD_X!zGRCph5ZL}tQlhR4t<`z zCt(r> zQd(8E?R#TsTSWnm*-0N8Q$F4g{48XH31;CW~EHrBKcGG^tqH5fg7G`6y~KNfm5)n57^SJb5Y(pp;pu42j`|95xc0V zLZ#jf%Ki9hZf0VDi=9`7KF0d!h|%T>a@9$!w(|x4NpD$qpQ#h!i8;XMCITyN&lvWv zC635SbNw~Td8@qezF&+5DCB@!n;OaVe$!g)|hqRYsz-nkIRD3_64pN9G8635sLXdy^lKM>sP@^S@RUlBFtA%M=+TL`_ zwY7dVkeE|i&67vZ%3*!Od=J#L#`juW2KkWv!j?C>6`E=rNe11rqn3(EIt^b*3@m(8 zb)K_d(rJ#ZEZO@%tU=iYR5dyy&~I@Kofv5~5W`%~@kaUjSfy)UqVJ9HwqRDqf0%Hv zVtmS=vrllS(E#M%ZoyRzUci)j+{CoM_VJlqDSreDvnp0PT4wq?Yh%OO)0xxB%XSsS zj}G|8>fikcDKJP>=RO1iXBQ}PJtLm(E6eZC$3B%^h1&A4(a{6VpM(;~?HNAf#kXN% zbyr1Jq1iNX0lB; zu+D1#jiAl`-i`J}b3eIN;n4gU*3iut>RP+O7%&b3$AEuhiH+F=1baVXte>n@x3MW7I!T0I7S z1hSsx=?~>(HC9e8W*zL58ctdOc`8P z-glAr9+nN{?iZr4wxA0-%%R|jL~!!s;?>oavz>L6+H0Wj2NDqtNa46{+YBh|yR(bx z0&27*6LI8vZl`foi!B~8Wk*d2f8Eji=8B)3{LR?kgXs^&XaK+-Gs^98GEq)gnkLp) zOx>nhv=;nO*%o|?dqZVGb{3cP0=l$KiIv2(ZcRwwH`=c9t^UP#P$(a3uUAPA6#(!@ z_{pJ`=`NS#C66oc!*JBuw-p+E@K>P zO$iQn1Q*J(v%K2>cIThF-2U^AFD@62ER$hj_SW+ znE1L|8S~_moG2SF`dX8=-<#vB&|w#i9&#_Pe+i+mjGO4Uox{xwtMxz!l?sR_DsvEC z7fBP!W@MV+NB7^M0LVcw?VC@*6T{T!oM|((&}=>cstI17Y)bg7Yzz`8te4@6`|3DD zdoh~}h;VHW9@hgoJjb)EWgxNZcN@}bGD!XFFPCY+XANYSBfiliHeX5}h$ro?63xY0 z3N8w>Ns=eiZ)feVn@-7SLKi^=KJ+ZKx&PuN6Ja4E=atsWiXYJHb~ck9eI0eT@Y^?H z3VNu}mE@sDcMI}NOO@3cNUdA;T@=%@#ca2?kM(7pLM9c=U2vY}dz2X-fwr0wVF1(u z{-W7Hfq$X_VWvN`P-RqZLMqEOkt)r%@5R~Tv_g|RyZsM+wHq4F{O$FIEYI{ za~ZMx(b>`W(Veb5gZs8i?sBNp29jXeNUz9y7>-(+G&{cOwMyrhj*kloi2p-?rg~N2@J%+{r|XJ5s4Vm}D;2mTFZ$LwU$OTVbAZhVKn!XaNd8N1C)-6JcmOD3mBjgUe&CR_C z2#Y}S-*b!lgS%`-8N*0?txS{yvC+XI$^m`I1((oHhM~1+xGXxW#xIvoHNt*pU3>Fo zpU?tXtco8=`H)Y6@56U;p6k8?aagS_`G;D}(HbF$MJ8c%UyUBc@u;Xq@FTEsC#M&)qV(G5aXas_ zB#30;n+HU3F957IElU&YeOUN5{>mM4S5Y2qN_|nxu1>oZgNiGS3TQdX>#I|@iyrnz zvH5LGV$tf2rkA%3M@==DbIWZe4uf61(Dw#&8UtEuT=b`9p*PcGAKIA0g6D~~brz$w zJ=dnCWSVov>Jf_BS~pUbQ&$t>rZY^hRRwMzMsg-)FfiX|;oP{=p-^32X{t0*6yBK& z(-MU+iN0Pb(*ezwKeF}L{p5oAnm-&_Ey07_5)MY~6K+20x8f87A`BjmyXfX92K~`u z6Vn5!f*mm$4ymE}2w(W{?{RT&`b~5q8X>;-y|tL{Xwb85(&fPoPIG_gva6w(-(VFwvzv~y7Dlft*q>8_Z$a( zD0l!NGke9GpkMt(F|GHZB&^R1`*|m)wnES{j`NXHynfe{tf1+=+2zq*sllllcTCL- zXzTOt;@jsNc7kP=LUmiE%ql&}Cg!GtSlLOh+A6c6Cs~82t;jVce|qZIju5n-2L)tF z=E^}meMy&Xe)AZ1DZCXbZD>19a(SN=W5R^{F2<^Ymi8n5D6M%a`wkh?QJDJhdXl`E z#H*d`H0gHyLf8nv-w8vZvS)h>r6uy8ZzU05QNd;8c@Qryq z{>qQ`_Nvv-+)}u(&bhHQ;`_km!WW`{HXa)YQgRQAk6@W1YDE^9x--RHIIQ*OYx~J^ zitf7;CyE&WAoHn3Hh!Iv=BJyn9~Rghg}n`#yRpZ+#vybcKxr%#kFf8xYm{d!D=$Sd zZ+*aMnCyio+z&$bvtNswc*_A8wl?bz+1`2Hsy)=L-3z%$OP%nbJvVTJZ>VhdYEd#Z z&{M1ODB&9F=i%(L5gE(p^jIH_^!>Hj^Q99Pnp&*V>usUZA3$h)&{SQqUW#z$owqLH z>2%d?hYQ4KW|}*3i?=Ftz<`<-9zi&c_7OQbxMuvkPMVVD`lte)&fL?*2N)Mslv7-m zpdt20d-B-fiKki4>yw|Zr)#xS1%8D zZnrbhDNomk=>jV5nXaWZ1(Mh9yFalUmGbr)VN)B)B5#iF@JGy~Jrj4Jgrb9r^siBD zRM4#_FA%zHg8X}2&eh%^%d@p^U1&tlkM#{d+G`0s(I0t!LktM@lDs)ku(P<~x%GVG zODYvG{{fG9o+IU8(0762bP)-F6)%K zT5ZAd12<;&$E$+je`701e~f#$ki6!9c@A!{bwTho3tbSAhTVwrkdv{NjhEQo8%$1* zO>Uw7eLj2@LfWISY{>bP&oNn{0EI+~LWCffwAH|w>3A8UY2>{}?7mo!nO`$!$0B^^ zLHm-RP^jgA>>$PgeJ8b>l9@H?x#4XnGDqjoXT2zzM6V*zfvZj5?$y;uYgS0YC3qRD ziJQw9rSrSzmG+n#=<6#$ZdCWM7K}Mk&@IBtZ~Esr<|;A}=fNP`q=(ZET59q+-(1*k z>Ke{iauV#^H}Jk4kvj4+BrxJT*`|e8$3_W)d!jG2;^y{hXU7hbj;ycOj7Ur$CV0B> zJn;M1Wp3Mlb$mulM@&G7D~2L)z}I46&rnK$%J?2a963qX4eITni?KbB`+GTl1W^CDa?i`~f}zRqCU{kCT8 z@-6G0aHgJ8YV+8R((kLnY6y)55oZin5c_&bani8?k)o==#5_vMQ=Alfgml6*+bq1_p2Ru@0eJ8>J$A2I6Lx?JQ%LN;-{_KY*)VWLF~d7N$I(>AIt+r3Eg z$NS68IVhWKB(_LEeZ7rT^;F0^?CzI~?O; z%^%td#{$u)isS9^doC7^jvCQqSW?)jrA1~6Qmzos^|F6#SzeJd$S6J;| V?UU{-C<@5|+8TPWDmDAC{{bp5nHK;6 literal 0 HcmV?d00001