Light weight package to quickly and easily manage, load, update and save key-value type database
The sample use cases of this package is loading configuration file, language file, preference setting in an application. More use cases can be seen here.
The package does not do any Input and Output operation as there are several way to read and write to file and the methods has their strength and weakness therefore the developer has to find the efficient way to load and save locally.
Package name is KeyValueDB.
Using Package-Manager:
Install-Package KeyValueDB -Version 1.2.0Using .NET CLI:
dotnet add package KeyValueDB --version 1.2.0Using Pakage Reference:
<PackageReference Include="KeyValueDB" Version="1.2.0" />Using Packet CLI:
paket add KeyValueDB --version 1.2.0The following example load, update, read and remove a simple key value object
using System;
using Io.Github.Thecarisma;
namespace Sample
{
class Test
{
public static void Main(string[] args)
{
//initialize the key-value
KeyValueDB keyValueDB = new KeyValueDB("Greet=Hello World,Project=KeyValueDB", true, '=', ',', false);
//get an object
Console.WriteLine(keyValueDB.Get("Greet"));
//remove an object
keyValueDB.Remove("Greet");
//add an object
keyValueDB.Add("What", "i don't know what to write here");
//print all the objects
foreach (var kvo in keyValueDB) {
Console.WriteLine(kvo);
}
}
}
}kvp - Key Value Pair
kvdb - Key value Database
pss - Possibly
kvo - Key Value Object
Only string type is used as the key and value of the kvo. A kvo can be used to replace or set the value for a key.
You can use the package to update and create an existing key value database. This library does not read the database from a file which means you have to find a way to read a string from the file.
Create a new keyValueDB. The default seperator between the key and value is = and the delimeter between the kvp is \n(newline).
KeyValueDB keyValueDB = new KeyValueDB();To load existing KeyValueDB
KeyValueDB keyValueDB = new KeyValueDB(
"Greet=Hello World,Project=KeyValueDB", //pss read string from file
true, //case sensitive is true
'=', //the seperator from key and value
',', //the delimeter for the key-value-pair
false //error tolerance if true no exception is thrown
);The only accepted type that can be inserted is a valid KeyValueObject and String. The method Add can be used to add a new kvp into the object.
Add a kvp with it key and value
keyValueDB.Add("Greet", "Hello World");Add a kvp using the KeyValueObject class.
KeyValueObject keyValueObject = new KeyValueObject("Greet", "Hello World");
keyValueDB.Add(keyValueObject);There are several way to find and get a value from the kvdb object. The value or the KeyValueObject can be gotten using the methods below
You can get the kvo using either the key or index. If the corresponding kvo is not found, an empty kvo is added to the db and then returned but not in the case when requested with the integer index. If a fallback kvo is sent as second parameter then when the request kvo is not found the fallback second parameter is added to the kvdb and then returned.
Get the kvo using it integer index
keyValueDB.GetKeyValueObject(0);
//Io.Github.Thecarisma.KeyValueObject@55915408:Key=Greet,Value=Hello WorldGet the kvo using it key
keyValueDB.GetKeyValueObject("Greet");
//Io.Github.Thecarisma.KeyValueObject@55915408:Key=Greet,Value=Hello WorldGet the kvo using it key with fallback kvo
KeyValueObject keyValueObject = new KeyValueObject("Name", "Adewale Azeez");
keyValueDB.GetKeyValueObject("Name", keyValueObject);
//Io.Github.Thecarisma.KeyValueObject@55915408:Key=Name,Value=Adewale AzeezGet a kvo by checking the kvdb for the kvo object that contains a part of the key. If a fallback kvo is sent as second parameter then when the request kvo is not found the fallback second parameter is added to the kvdb and then returned.
Get a similar kvo using it key part
keyValueDB.GetLikeKeyValueObject("eet");
//Io.Github.Thecarisma.KeyValueObject@55915408:Key=Greet,Value=Hello WorldGet a similar kvo using it key part with fallback kvo
KeyValueObject keyValueObject = new KeyValueObject("Name", "Adewale Azeez");
keyValueDB.getKeyValueObject("Nam", keyValueObject);
//Io.Github.Thecarisma.KeyValueObject@55915408:Key=Name,Value=Adewale AzeezYou can get a kvdb value using either the key or index. If the corresponding value is not found, an empty string is added to the db and then returned but not in the case when requested with the integer index.
If a fallback kvo is sent as second parameter then when the request key is not found the fallback second parameter is added to the kvdb and then value is returned. If a string value is sent as the second value it is returned if the key is not found in the kvdb.
Get a value using it integer index
keyValueDB.Get(0);
//"Hello World"Get the value using it key
keyValueDB.Get("Greet");
//"Hello World"Get the kvo using it key with fallback value
keyValueDB.Get("Licence", "The MIT Licence");
//"The MIT Licence"Get the kvo using it key with fallback kvo
KeyValueObject keyValueObject = new KeyValueObject("Licence", "The MIT Licence");
keyValueDB.Get("Name", keyValueObject);
//"The MIT Licence"Get a value by checking the kvdb for the kvo object that contains a part of the key.
If a fallback kvo is sent as second parameter then when the request key is not found the fallback second parameter is added to the kvdb and then value is returned.
Get a value using it key part
keyValueDB.GetLike("eet");
//"Hello World"Get a value using it key part with fallback kvo
KeyValueObject keyValueObject = new KeyValueObject("Licence", "The MIT Licence");
keyValueDB.GetLike("Li", keyValueObject);
//"The MIT Licence"There are various way to update a kvp in the kvdb, the value can be changed directly or set to a new KeyValueObject. If you try to set a kvo that does not exist in the kvdb using it key, it is added to the kvdb.
The Set method is used to change the value of the kvo using the index of the kvo or a kvo key.
Set a kvo value using it index
keyValueDB.Set(0, "Hello World from thecarisma");
//Io.Github.Thecarisma.KeyValueObject@55915408:Key=Greet,Value=Hello World from thecarismaSet a kvo value using it key
keyValueDB.Set("Greet", "Hello World from thecarisma");
//Io.Github.Thecarisma.KeyValueObject@55915408:Key=Greet,Value=Hello World from thecarismaCompletely change a KeyValueObject in the kvdb using either it index or it key. The kvo is completly replaced which means unique fields like the hashcode of the kvo changes. When the kvo is set using it key if the corresponding kvo does not exist it is added into the kvdb. Note that this method completly changes the kvo so it can be used to replace a kvo.
Set a kvo using it index
KeyValueObject keyValueObject = new KeyValueObject("Licence", "The MIT Licence");
keyValueDB.SetKeyValueObject(0, keyValueObject);
//Io.Github.Thecarisma.KeyValueObject@55915408:Key=Licence,Value=The MIT LicenceSet a kvo value using it key
KeyValueObject keyValueObject = new KeyValueObject("Licence", "The MIT Licence");
keyValueDB.SetKeyValueObject("Greet", keyValueObject);
//Io.Github.Thecarisma.KeyValueObject@55915408:Key=Licence,Value=The MIT LicenceA new kvp can be inserted by invoking the Add method. The kvp can be added using it key and value or by directly adding the KeyValueObject to the kvdb.
Add a new kvp using the key and value
keyValueDB.Add("Key", "This is the value");Add a new kvp using a new KeyValueObject
KeyValueObject keyValueObject = new KeyValueObject("Key", "This is the value");
keyValueDB.Add(keyValueObject);Remove a kvp completely from the kvdb using either it key of the integer index. The kvp that was removed is returned from the method. If the index does not exist out of bound error occur and if a kvo with the key is not present nothing is done but an empty kvo is returned.
Remove a kvp using integer index
keyValueDB.Remove(0);
//removes the first kvp in the kvdb
//Io.Github.Thecarisma.KeyValueObject@55915408:Key=Greet,Value=Hello WorldRemove a kvp using it key
keyValueDB.Remove("Greet");
//removes the first kvp in the kvdb
//Io.Github.Thecarisma.KeyValueObject@55915408:Key=Greet,Value=Hello WorldGet the size of the kvo in the kvdb.
keyValueDB.Size();
//4Remove all the elements and kvo from the kvdb
keyValueDB.Clear();
//keyValueDB.Size() = 0Check whether the kvdb contains any kvo in it.
keyValueDB.IsEmpty();
//FalseThe kvp collection kvdb can be inspected as a string using the ToString method. The returned value can be saved locally by writing to a persistent storage or to a plain text file. The output of the ToString method is determined by the kvos, the seperator and the delimeter.
keyValueDB.ToString();
// "Greet=Hello World,Project=KeyValueDB,Project=KeyValueDB,Licence=The MIT Licence"The KeyValueDB object can be iterated natively using the foreach..in loop expression.
foreach (var kvo in keyValueDB) {
//operate on the KeyValueObject
}KeyValueObject class contains the key and value field and the fields setter and getter. The KeyValueObject is the main internal type used in the KeyValueDB class.
In KeyValueDB the key value pair is stored in List<KeyValueObject> type, all search,
updating and removal is done on the keyValueObjects in the class. The string sent as
first parameter if parsed into valid key value using the separator and delimiter fields. The
ToString method also parse the keyValueObjects content into a valid string with regards to the
separator and delimeter.
Before you begin contribution please read the contribution guide at CONTRIBUTING GUIDE
You can open issue or file a request that only address problems in this implementation on this repo, if the issue address the concepts of the package then create an issue or rfc here
You can support some of this community as they make big impact in the developement of people to get started with software engineering.
MIT License Copyright (c) 2020 Adewale Azeez - keyvaluedb