docs/release-notes.rst

   1 ..
   2 ..  Copyright (c) 2019 AT&T Intellectual Property.
   3 ..  Copyright (c) 2019-2022 Nokia.
   4 ..
   5 ..  Licensed under the Creative Commons Attribution 4.0 International
   6 ..  Public License (the "License"); you may not use this file except
   7 ..  in compliance with the License. You may obtain a copy of the License at
   8 ..
   9 ..    https://creativecommons.org/licenses/by/4.0/
  10 ..
  11 ..  Unless required by applicable law or agreed to in writing, documentation
  12 ..  distributed under the License is distributed on an "AS IS" BASIS,
  13 ..  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 ..
  15 ..  See the License for the specific language governing permissions and
  16 ..  limitations under the License.
  17 ..
  18
  19
  20 Release Notes
  21 =============
  22
  23
  24 This document provides the release notes of the ricsdl library.
  25
  26 .. contents::
  27    :depth: 3
  28    :local:
  29
  30
  31
  32
  33 Version history
  34 ---------------
  35
  36 [3.1.0] - 2022-03-14
  37
  38 * Enable redis/sentinel port and sentinel master name configuration
  39
  40 [3.0.2] - 2022-01-20
  41
  42 * Bump Redis client version to 4.1.1 and replace deprecated Redis client '_compat'
  43   module with 'utils' module.
  44
  45 [3.0.1] - 2021-11-18
  46
  47 * Add specific package versions for required dependencies: redis==3.5.3 and
  48 * hiredis==2.0.0. Package ricsdl is not compatible with new redis 4.x.y versions.
  49
  50 [3.0.0] - 2021-06-10
  51
  52 * Simplify v2.3.0 notification callback and handle_events API to return received
  53   event(s) only as a list type. Earlier single event was returned as a string type.
  54   Notification callback and handle_events API changes are not backward compatible.
  55
  56 [2.3.0] - 2021-06-09
  57
  58 * Pack all the events in a channel to one DB notification to be in line with SDL Golang.
  59
  60 [2.2.0] - 2021-05-11
  61
  62 * Add DB backend instance selection based on namespace value to balance DB load.
  63
  64 [2.1.1] - 2021-03-09
  65
  66 * Take DBAAS multi-channel publishing Redis modules into use.
  67
  68 [2.1.0] - 2020-08-26
  69
  70 * Add support for notifications
  71
  72 [2.0.4] - 2020-05-13
  73
  74 * Enhance SDL API set() function argument validation to cover also dictionary items.
  75
  76 [2.0.3] - 2020-01-22
  77
  78 * Add a new SDL storage API function `is_active()` to check healthiness of SDL instance.
  79
  80 [2.0.2] - 2020-01-14
  81
  82 * Version bump.
  83
  84 [2.0.1] - 2020-01-13
  85
  86 * Add a fake database backend implementation to be used only for testing
  87   purposes when the real DBAAS database service is not available.
  88
  89 [2.0.0] - 2020-01-03
  90
  91 * Change find_keys() and find_and_get() API functions to support glob-style
  92   regular expression in a key search pattern. API backward incompatible change.
  93 * Remove 'atomic' parameter of find_and_get() API function. API backward
  94   incompatible change.
  95
  96 [1.0.2] - 2019-12-18
  97
  98 * Take Hiredis package into use in Redis database backend.
  99 * Add unit tests for configuration handling.
 100
 101 [1.0.1] - 2019-12-06
 102
 103 * Version bump.
 104
 105 [1.0.0] - 2019-12-05
 106
 107 * First version.
 108
 109
 110
 111
 112 Summary
 113 -------
 114
 115 This is the first version of this package.
 116 It implements RIC Shared Data Layer (SDL) library.
 117
 118
 119
 120
 121 Release Data
 122 ------------
 123 This is the first version of this package.
 124
 125
 126
 127
 128
 129 Feature Additions
 130 ^^^^^^^^^^^^^^^^^
 131
 132
 133 Bug Corrections
 134 ^^^^^^^^^^^^^^^
 135
 136
 137 Deliverables
 138 ^^^^^^^^^^^^
 139
 140 Software Deliverables
 141 +++++++++++++++++++++
 142
 143 This version provides Python package ricsdl.
 144 It can be retrieved from pypi.org.
 145
 146
 147
 148 Documentation Deliverables
 149 ++++++++++++++++++++++++++
 150
 151
 152
 153
 154
 155 Known Limitations, Issues and Workarounds
 156 -----------------------------------------
 157
 158 System Limitations
 159 ^^^^^^^^^^^^^^^^^^
 160
 161
 162
 163 Known Issues
 164 ^^^^^^^^^^^^
 165
 166 Workarounds
 167 ^^^^^^^^^^^
 168
 169
 170
 171
 172
 173 References
 174 ----------