2 .. Copyright (c) 2019 AT&T Intellectual Property.
3 .. Copyright (c) 2019-2022 Nokia.
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
9 .. https://creativecommons.org/licenses/by/4.0/
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.
15 .. See the License for the specific language governing permissions and
16 .. limitations under the License.
24 This document provides the release notes of the ricsdl library.
38 * Bump Python version to 3.9.
42 * correcting whitespaces
46 * Bump Python version to 3.8.
50 * Enable redis/sentinel port and sentinel master name configuration
54 * Bump Redis client version to 4.1.1 and replace deprecated Redis client '_compat'
55 module with 'utils' module.
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.
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.
70 * Pack all the events in a channel to one DB notification to be in line with SDL Golang.
74 * Add DB backend instance selection based on namespace value to balance DB load.
78 * Take DBAAS multi-channel publishing Redis modules into use.
82 * Add support for notifications
86 * Enhance SDL API set() function argument validation to cover also dictionary items.
90 * Add a new SDL storage API function `is_active()` to check healthiness of SDL instance.
98 * Add a fake database backend implementation to be used only for testing
99 purposes when the real DBAAS database service is not available.
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
110 * Take Hiredis package into use in Redis database backend.
111 * Add unit tests for configuration handling.
127 This is the first version of this package.
128 It implements RIC Shared Data Layer (SDL) library.
135 This is the first version of this package.
152 Software Deliverables
153 +++++++++++++++++++++
155 This version provides Python package ricsdl.
156 It can be retrieved from pypi.org.
160 Documentation Deliverables
161 ++++++++++++++++++++++++++
167 Known Limitations, Issues and Workarounds
168 -----------------------------------------