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