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