docs/release-notes.rst

   1 ..
   2 ..  Copyright (c) 2019 AT&T Intellectual Property.
   3 ..  Copyright (c) 2019 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.0.2] - 2022-01-20
  37
  38 * Bump Redis client version to 4.1.1 and replace deprecated Redis client '_compat'
  39   module with 'utils' module.
  40
  41 [3.0.1] - 2021-11-18
  42
  43 * Add specific package versions for required dependencies: redis==3.5.3 and
  44 * hiredis==2.0.0. Package ricsdl is not compatible with new redis 4.x.y versions.
  45
  46 [3.0.0] - 2021-06-10
  47
  48 * Simplify v2.3.0 notification callback and handle_events API to return received
  49   event(s) only as a list type. Earlier single event was returned as a string type.
  50   Notification callback and handle_events API changes are not backward compatible.
  51
  52 [2.3.0] - 2021-06-09
  53
  54 * Pack all the events in a channel to one DB notification to be in line with SDL Golang.
  55
  56 [2.2.0] - 2021-05-11
  57
  58 * Add DB backend instance selection based on namespace value to balance DB load.
  59
  60 [2.1.1] - 2021-03-09
  61
  62 * Take DBAAS multi-channel publishing Redis modules into use.
  63
  64 [2.1.0] - 2020-08-26
  65
  66 * Add support for notifications
  67
  68 [2.0.4] - 2020-05-13
  69
  70 * Enhance SDL API set() function argument validation to cover also dictionary items.
  71
  72 [2.0.3] - 2020-01-22
  73
  74 * Add a new SDL storage API function `is_active()` to check healthiness of SDL instance.
  75
  76 [2.0.2] - 2020-01-14
  77
  78 * Version bump.
  79
  80 [2.0.1] - 2020-01-13
  81
  82 * Add a fake database backend implementation to be used only for testing
  83   purposes when the real DBAAS database service is not available.
  84
  85 [2.0.0] - 2020-01-03
  86
  87 * Change find_keys() and find_and_get() API functions to support glob-style
  88   regular expression in a key search pattern. API backward incompatible change.
  89 * Remove 'atomic' parameter of find_and_get() API function. API backward
  90   incompatible change.
  91
  92 [1.0.2] - 2019-12-18
  93
  94 * Take Hiredis package into use in Redis database backend.
  95 * Add unit tests for configuration handling.
  96
  97 [1.0.1] - 2019-12-06
  98
  99 * Version bump.
 100
 101 [1.0.0] - 2019-12-05
 102
 103 * First version.
 104
 105
 106
 107
 108 Summary
 109 -------
 110
 111 This is the first version of this package.
 112 It implements RIC Shared Data Layer (SDL) library.
 113
 114
 115
 116
 117 Release Data
 118 ------------
 119 This is the first version of this package.
 120
 121
 122
 123
 124
 125 Feature Additions
 126 ^^^^^^^^^^^^^^^^^
 127
 128
 129 Bug Corrections
 130 ^^^^^^^^^^^^^^^
 131
 132
 133 Deliverables
 134 ^^^^^^^^^^^^
 135
 136 Software Deliverables
 137 +++++++++++++++++++++
 138
 139 This version provides Python package ricsdl.
 140 It can be retrieved from pypi.org.
 141
 142
 143
 144 Documentation Deliverables
 145 ++++++++++++++++++++++++++
 146
 147
 148
 149
 150
 151 Known Limitations, Issues and Workarounds
 152 -----------------------------------------
 153
 154 System Limitations
 155 ^^^^^^^^^^^^^^^^^^
 156
 157
 158
 159 Known Issues
 160 ^^^^^^^^^^^^
 161
 162 Workarounds
 163 ^^^^^^^^^^^
 164
 165
 166
 167
 168
 169 References
 170 ----------