P41.NoSQLite 0.3.0-beta.40

NoSQLite

A C# library built using SQLitePCL.raw to use SQLite as a NoSQL database.

The library aims to provide simple low level methods that are used to create your own data access layers. For now the library uses a single connection class which creates/uses tables that have a single column called documents. In reality it should work for other tables with more columns as long as they contain one column called documents but no tests have been made or run for this use case.

Getting Started

Install some version of SQLitePCL.raw to create your sqlite3 object.

Connection

Using your sqlite3 db create a new instances of the NoSQLiteConnection and optionally pass a JsonSerializerOptions object.

Tables

You get a table using connection.GetTable({TableName})

At the table level the following methods are supported: | Method | Description | |- |- | | Count/CountLong | Returns the number of rows in the table. | | All | Returns all rows in the table. Deserialized to T | | Clear | Clears the table. | | Exists | Check if a document exists. | | Find | Returns the document if it exists or throws. | | Add | Adds a document. | | Update | Updates a document (replace). | | Delete | Deletes a document. | | IndexExists | Check if an index exists. | | CreateIndex | Creates an index if it does not exists using "{TableName}_{IndexName}" (can also set unique flag). | | DeleteIndex | Deletes an index if it does exist. |

Documents

At the document level the following methods are supported: | Method | Description | |- |- | | FindProperty | Finds a document by key and returns a property value. | | Insert | Inserts a property value into a document by key. Overwrite NO, Create YES. | | Replace | Replaces a property value in a document by key. Overwrite YES, Create NO. | | Set | Sets a property value in a document by key. Overwrite YES, Create YES. |

Examples

• For connection creation look at the TestBase Before and After methods of the _setup.cs file.
• For CRUD examples look at the CRUD method of the Table.cs file.
• For INDEX examples look at the Index and Index_Unique methods of the Table.cs file.

Build

To build this project .NET 10 is needed.

Contribute

Contributions are welcome and appreciated, before you create a pull request please open a GitHub Issue to discuss what needs changing and or fixing if the issue doesn't exist!