2 Copyright (c) 2021 AT&T Intellectual Property.
3 Copyright (c) 2018-2021 Nokia.
5 Licensed under the Apache License, Version 2.0 (the "License");
6 you may not use this file except in compliance with the License.
7 You may obtain a copy of the License at
9 http://www.apache.org/licenses/LICENSE-2.0
11 Unless required by applicable law or agreed to in writing, software
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 See the License for the specific language governing permissions and
15 limitations under the License.
19 * This source code is part of the near-RT RIC (RAN Intelligent Controller)
20 * platform project (RICP).
27 "gerrit.o-ran-sc.org/r/ric-plt/sdlgo/internal/sdlgoredis"
31 //iDatabase is an interface towards database backend, for the time being
32 //sdlgoredis.DB implements this interface.
33 type iDatabase interface {
34 Info() (*sdlgoredis.DbInfo, error)
35 State() (*sdlgoredis.DbState, error)
36 Keys(pattern string) ([]string, error)
37 Statistics() (*sdlgoredis.DbStatistics, error)
40 //Database struct is a holder for the internal database instances.
41 type Database struct {
45 //DbCreateCb callback function type to create a new database
46 type DbCreateCb func() *Database
48 //iSyncStorage is an interface towards SDL SyncStorage API
49 type ISyncStorage interface {
50 Get(ns string, keys []string) (map[string]interface{}, error)
51 ListKeys(ns string, pattern string) ([]string, error)
52 Set(ns string, pairs ...interface{}) error
53 Remove(ns string, keys []string) error
56 //SyncStorageCreateCb callback function type to create a new SyncStorageInterface
57 type SyncStorageCreateCb func() ISyncStorage
59 //keysArgs struct is used for keys command arguments.
60 type keysArgs struct {
65 //NewKeysArgs constructs a new keysArgs struct.
66 func NewKeysArgs(ns string, pattern string) keysArgs {
73 //Validate command arguments in keysArgs.
74 func (k keysArgs) Validate() error {
75 if strings.Contains(k.ns, "*") {
76 return fmt.Errorf("Invalid character (*) in given %s namespace argument.", k.ns)
81 //nsMap is a map having SDL DB cluster address as a key and namespace map of type nsKeyMap as a value
82 type nsMap map[string]nsKeyMap
84 //nsKeyMap is a map having namespace as a key and DB key count as a value
85 type nsKeyMap map[string]uint32
87 //SdlCliApp constant defines the name of the SDL CLI application
88 const SdlCliApp = "sdlcli"