Skip to content

Latest commit

 

History

History
237 lines (161 loc) · 8.16 KB

readme.md

File metadata and controls

237 lines (161 loc) · 8.16 KB
Raw

NHibernate.Caches Build status

Documentation and examples are available at http://nhibernate.info/. Any feedback or issue can be sent to NHibernate user group (http://groups.google.com/group/nhusers) and will be greatly appreciated.

Up-to-date source code available at GitHub Website

Website: https://github.com/nhibernate/NHibernate-Caches/

What is NHibernate.Caches ?

NHibernate is able to use external caching plugins to minimize the access to the database and improve the performance. The NHibernate Contrib contains several packages to work with different caching servers and frameworks. It's recommended to research for a while before deciding which one is better for you, since some providers require installing additional services (which provides an awesome performance, but might be harder to install in some scenarios).

Notes

Build 5.9.0 for NHibernate 5.2.0

Possible breaking change

To eliminate the need for a JSON serializer custom registration, CoreDistributedCache now uses a simple object[] as the cached value instead of a Tuple<string, object>(keyAsString, value):

  • Upon upgrade, all previously cached entries will be ignored.
  • If the distributed cache remains filled by older releases through other processes, there will be additional cache misses for both older and newer versions.
  • If you are using another serializer than the default binary serializer, you may have to adjust its configuration.

  • Improvement

    • #117 - Avoid custom registration for the Json serializer
    • #115 - Run tests using .NET 6

  • Task

    • #119 - Release 5.9.0
    • #118 - Allow git to handle line endings
    • #116 - Remove Microsoft.Extensions.Caching.SqlConfig.Tools cli
    • #113 - Tell NuGet about the readme file

Build 5.8.0 for NHibernate 5.2.0

Possible breaking change

CoreDistributedCache now uses a Tuple<string, object>(keyAsString, value) as the cached value instead of a Tuple<object, object>(key, value):

  • Upon upgrade, all previously cached entries will be ignored.
  • If the distributed cache remains filled by older releases through other processes, there will be additional cache misses for both older and newer versions.
  • If you are using another serializer than the default binary serializer, you may have to adjust its configuration.
  • Distinguishing different objects which keys have the same string representation and hashcode is no more supported.

NHibernate.Caches.Util.JsonSerializer now uses Newtonsoft.Json 13.0.1, up from 10.0.1.

  • Improvement

    • #106 - Unable to use DistributedCache with JsonCacheSerializer

  • Task

    • #112 - Release 5.8.0
    • #110 - Update Newtonsoft Json.Net to a non-vulnerable version
    • #109 - Automatically generate async code on pull request
    • #108 - Fix AppVeyor build
    • #89 - Fix iconUrl warning

Build 5.7.0 for NHibernate 5.2.0

  • New feature

    • #83 - Add support for custom serializer in CoreDistributedCache
    • #79 - Allow replacing ConfigurationManager for reading values

  • Task

    • #88 - Release 5.7.0
    • #86 - Update SourceLink package to its release version
    • #85 - Remove NuGet download
    • #74 - Fix nuget source for pushing snupkg

Build 5.6.0 for NHibernate 5.2.0

Possible breaking change

The obsolete Microsoft.Extensions.Caching.Redis dependency has been changed for Microsoft.Extensions.Caching.StackExchangeRedis, in NHibernate.Caches.CoreDistributedCache.Redis

  • Bug

    • #66 - Issues with custom Regions with RedisCacheProvider
    • #62 - StackExchangeRedis fails with "too many results to unpack" with 8000 items

  • New feature

    • #69 - "Third Level Cache" for Redis

  • Improvement

    • #71 - Enable batching for StackExchangeRedis by default
    • #70 - Use non deprecated Redis provider
    • #68 - Add static region configuration
    • #64 - Improve StackExchangeRedis LockMany script for DefaultRegionStrategy
    • #60 - Update package format for symbols, license and SourceLink

  • Task

    • #65 - Update AsyncGenerator to 0.14.0

Build 5.5.1 for NHibernate 5.2.0

Re-release in order to have proper release notes in the NuGet packages.

Build 5.5.0 for NHibernate 5.2.0

NHibernate 5.2.0 is targeted by all cache providers.

  • Bug

    • #53 - Disable append-hashcode when library is not built for netFx
    • #32 - Key computing for Memcached leaks hashers

  • New feature

    • #50 - Common cache serializer and json serializer
    • #45 - Add Redis provider with batching support

  • Improvement

    • #52 - Cease using cryptographic hashes

  • Task

    • #56 - Upgrade to NH 5.2.0

Build 5.4.0 for NHibernate 5.1.0

NHibernate 5.1.0 is targeted by all cache providers.

  • Bug

    • #48 - Avoid undue cache misses

  • New feature

    • #47 - Add an option for appending hashcode to key
    • #38 - Add a Core RtMemoryCache

  • Improvement

    • #36 - Push symbols packages

  • Task

    • #46 - Update NHibernate to 5.1.0

Build 5.3.2 for NHibernate 5.0.0/5.1.0

  • Bug
    • #40 NullReferenceException in SysCache2's SysCacheProvider

Build 5.3.1 for NHibernate 5.0.0/5.1.0

  • Bug
    • #37 Fix CoreDistributedCache.Memory package description

Build 5.3.0 for NHibernate 5.0.0/5.1.0

NHibernate 5.1.0 is targeted by new cache providers.

  • Bug

    • #27 Documentation fixes

  • New Feature

    • #25 Add a .Net Core MemoryCache
    • #28 Add a .Net Core DistributedCache

  • Improvement

    • #33 Generate XML comment documentation
    • #34 Build release artifacts on AppVeyor

Build 5.2.0 for NHibernate 5.0.0

  • Bug

    • #19 - Partially configured regions do not fallback on defaults

  • Improvement

    • #20 - Modernize locking in SysCache2
    • #24 - Generates ICache async counter-parts instead of hand coding them

Build 5.1.0 for NHibernate 5.0.0

  • Bug

    • [NHCH-25] - TransactionScope promotes SysCache2 command dependency to a distributed transaction
    • [NHCH-43] - QueryCache CJK language not supported
    • [NHCH-51] - EnyimMemcached cannot be used by many session factories
    • [NHCH-53] - RtMemoryCache accepts invalid priorities

  • New Feature

    • [NHCH-38] - add useSlidingExpiration property to choose between absolute or sliding expiration

  • Improvement

    • [NHCH-50] - Non-compliant absolut expiration
    • [NHCH-52] - Add default expiration support to SysCache2

Build 5.0.0 for NHibernate 5.0.0

  • Breaking changes
    • All cache providers work with .NET 4.6.1

Build 4.0.1GA for NHibernate 4.0.1GA

Build 3.0.0.GA (rev1442 of contrib) for NHibernate 3.0.0CR1

Build 3.0.0.CR (rev1440 of contrib) for NHibernate 3.0.0CR1

Build 3.0.0.Beta (rev1421 of contrib) for NHibernate 3.0.0Beta2

Build 3.0.0.Beta1 (rev1341 of contrib) for NHibernate 3.0.0Alpha3

Build 3.0.0.Alpha2 (rev1318 of contrib) for NHibernate 3.0.0Alpha2

  • Breaking changes
    • All cache providers work with .NET3.5

** Improvement * [NHCH-24] - Strong naming and signing assemblies * [NHCH-26] - NHibernate.Caches.Memcached updated to use Enyim.Caching.Memcached * [NHCH-28] - Remove dependency to any logging framework

Build 3.0.0.Alpha1 (rev1302 of contrib) for NHibernate 3.0.0Alpha1

** Bug * [NHCH-27] - MemCache provider fails to delete item from cache if server is memcached 1.4.4

Build 2.1.2.GA (rev1204 of contrib) for NHibernate 2.1.2GA

Build 2.1.1.GA (rev1104 of contrib) for NHibernate 2.1.1GA

Build 2.1.0.GA (rev930 of contrib) for NHibernate 2.1.0GA

Build 2.1.0.Alpha1 (rev887 of contrib) for NHibernate 2.1.0Beta3

** Improvement * [NHCH-21] - Allow mnemonic values for priority

** Patch * [NHCH-19] - Duplicate expiration property handling in MemCacheClient * [NHCH-22] - Enable read of cache.default_expiration from NH configuration

Build 2.0.0.GA for NHibernate 2.0.1GA

  • In the last release (2.0.0.RC1) there was an error in the documentation about the NH version, this release fixes that minor bug.