-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e14e5a0
commit dcfea2b
Showing
4 changed files
with
63 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| # KeyValueRepo | ||
|  | ||
|
|
||
| [](https://github.com/calebjenkins/KeyValueRepo/actions/workflows/dev-ci.yml) | ||
| [](https://github.com/calebjenkins/KeyValueRepo/actions/workflows/main-publish.yml) | ||
| [](https://www.nuget.org/packages/Calebs.KeyValueRepo) | ||
| [](https://www.nuget.org/packages/Calebs.KeyValueRepo) | ||
| [](https://github.com/calebjenkins/KeyValueRepo/actions/workflows/working-branches.yml) | ||
|
|
||
| A generic interface for Key Value storage operations. Ideal for simple key-values that might migrate across in memory, SQL Server or NoSQL - a quick and easy way to create a KeyValue store. | ||
|
|
||
| By default, this library ships with an in-memory implementation. `KeyValueInMemory` which implements the `IKeyValueRepo` interface. | ||
|
|
||
| ## Installing KeyValueRepo | ||
|
|
||
| You should install the KeyValueRepo [with NuGet](https://www.nuget.org/packages/Calebs.KeyValueRepo): | ||
|
|
||
| Install-Package Calebs.KeyValueRepo | ||
|
|
||
| Or via the .NET Core command line interface: | ||
|
|
||
| dotnet add package Calebs.KeyValueRepo | ||
|
|
||
| Either command, from Package Manager Console or .NET Core CLI, will download and install Calebs.KeyValueRepo and all required dependencies. | ||
|
|
||
| ## Contributing | ||
| - PRs should be against the `Develop` branch. | ||
| - Merged PRs to `Develop` will trigger a `[version]-ci-[buildnumber]` deployment to nuget, assuming all unit tests pass. | ||
| - Merged PRs to `Main` will trigger a [version] deployment to nuget, assuming all of the tests pass. | ||
|
|
||
| ## Versioning | ||
| The package `version` is defined in the `KeyValueRepo.csproj` file, using .NET SDK style structure. We follow `semantic versioning` for this package. | ||
|
|
||
|
|
||
| ## Methods in IKeyValueRepo | ||
|
|
||
| - Get<T>(string Id) | ||
| - Get<T>(int Id) => Get<T>(string Id) | ||
| - Note: This method has a _default implementation_ that performs a `ToString()` on the Id and calls the `Get<T>(string Id)` method. | ||
| - GetAll<T>() | ||
| - Update<T>(string Id, T object) | ||
| - Update<T>(int Id, T object) => Update(string Id, T object) | ||
| - Note This method has a _default implementation_ that performs a `ToSTring()` on the int Id and calls the `Update<T>(string Id, T object)` method. | ||
|
|
||
|
|
||
| ## Release History & Development Goals | ||
| - 0.1.0 - initial release (in Memory) | ||
| - 0.2.0 - added SqlLite Implementation | ||
| - ✔ SQLite [Nuget Package](https://www.nuget.org/packages/Calebs.KeyValueRepo.SQLite/) | ||
| ### Future Goals | ||
| --- | ||
| - New Feature: KV Meta Objects | ||
| - New Repo: Sql Server Implementation | ||
| - New Repo: Azure Tables Implementation | ||
| - New Repo: Azure CosmoDB Implementation |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters