LiteDB.Helper 1.0.0.2

This a simple helper class library for LiteDB. If you find it useful, consider donating. 😃

• Helper (string file, string password = "")
  • The file is the actual database file.
  • The password is optional and is used for encrypted databases.

• Exception TestConnection()
  • This is used to test the connection to the database(ex: to know whether the password is correct or not).
  • The way it works is it returns an exception if the connection failed, and NULL if it succeeds.

• ChangePassword(string password = "")
  • Allows you to change the database password, a connection must be active for this to work.
  • The password is optional which allows you to remove the encryption.
  • Returns nothing (Void).

• Insert<T>(T collection)
  • Inserts a single record.
  • Example: helper.Insert(new Person() { FirstName = textBoxFirstName.Text, LastName = textBoxLastName.Text });
  • Returns nothing (Void).

• Insert<T>(List<T> collections)
  • Inserts multiple records (List<T>).
  • Example: helper.Insert(People());
  • Returns nothing (Void).

• Update<T>(T collection, int id)
  • Updates a single record using the Primary Key value.
  • Example: helper.Update(new Person() { FirstName = textBoxFirstName.Text, LastName = textBoxLastName.Text }, id: 1);
  • Returns True on success, False otherwise.

• Delete<T>(T collection, int id)
  • Deletes a single record using the Primary Key value.
  • Example: helper.Delete(new Person(), id: 1);
  • Returns True on success, False otherwise.

• Find<T>(T collection)
  • Gets all data from a single document (table).
  • Example: helper.Find(new Person());
  • Returns List<T>.

• Find<T>(T collection, string predicate)
  • Gets all data from a single document (table) based on a predicate.
  • Example: helper.Find(new Person(), "$.FirstName = "John"");
  • Returns List<T>.

• Find<T>(T collection, int id)
  • Gets a single record based on the Primary Key value.
  • Example: helper.Find(new Person(), id: 1);
  • Returns T.