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