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