Catch.Catcher 0.1.6

<p align="center"> <img width="192" height="192" src="catcherlogo.png"/> </p>

Catcher

CosmosDB Based with MongoDB Interface, with generic DAO Design Pattern for .NET Framework with C# Language.

We're sorry that version before 0.1.4 are have many API changes through the version. After 0.1.4, there will be consistency in the framework API.

Changelog

for changelog check here

Features

• Factory pattern
• Automatic query generator
• Automatic Dao creator
• Can search most similiar(not necessary equal) object
• Automatic connection creator
• Using attributes to exposed metadata

Requirements

• .NET standard 1.5 and higher

Installation

Visual Studio NuGet Package Manager

You can use default NuGet Package Manager in visual studio and search "Catch.Cather" and install it, as easy as that. Don't forget to resolve double dependency if you have one.

Package Manager

Execute this line in your package manager terminal inside your project :

Install-Package Catch.Catcher -Version 0.1.6

.NET CLI

Execute this line in your .NET CLI inside your project :

dotnet add package Catch.Catcher --version 0.1.6

Manually

1. Clone this repository.
2. Added to your project.
3. Congratulation!

Usage example

Initialize Framework

You need to inject your config once before you can use this framework.

1. Create Configuration Provider.

using Catcher.DB.DAO;

namespace YourNameSpace
{
    public class ConfigurationProvider : IConfigurationProvider
    {
        public string DBName => "YOUR_DB_NAME";

        public string DBHost => "www.your.db.host.com";

        public int DBPort => 1234;

        //insert DBUserName and DBPassword null if your db don't have credential
        public string DBUserName => "yourUserName";
        
        public string DBPassword => "y0UR_p4$sW0Rd";

        public bool IsUseSsl => true;

    }
}

2. Inject Your Configuration Provider.

//this context will stored your configuration as long as your program start
DaoConfigurationContext.Provider = new ConfigurationProvider();

Create Dto

All you need to do is create model class which extends our Dto abstract class and put DtoClass Attribute above your class. Keep in mind that Dto is using Bson library from mongoDB, so you can manipulate field name using BsonElement attribute. Don't forget to add "?" at primitive property (int, float, double, long, bool, decimal*) so its default value is null.

using Catcher.DB.DTO;

namespace YourProject.Model
{
    [DtoClass("NAME_OF_YOUR_DB", "NAME_OF_YOUR_COLLECTION")]
    public class Tag : Dto
    {   
        public string TagName { get; set; }
        public int? View { get; set; }
    }
}

If your model have unique field other than default object id, then you can put DtoUniqueField attribute on your property. The acceptable type for unique field type is : string, int, MongoDBRef, ObjectId. Remember, this field cannot be null! when you want to insert it to the database. You can have more than one unique field.

using Catcher.DB.DTO;

namespace YourProject.Model
{
    [DtoClass("NAME_OF_YOUR_DB", "NAME_OF_YOUR_COLLECTION")]
    public class User : Dto
    {   
        [DtoUniqueField]
        public string UserName { get; set; }
        public string Password { get; set; }
    }
}

If your model have composite id just put DtoCompositeField attribute on your property. Obviously, minimum number of composite property is two. The acceptable type for composite field type is : string, int, MongoDBRef, ObjectId. Remember, this field cannot be null! when you want to insert it to the database.

using Catcher.DB.DTO;

namespace YourProject.Model
{
    [DtoClass("NAME_OF_YOUR_DB", "NAME_OF_YOUR_COLLECTION")]
    public class Item : Dto
    {   
        [DtoCompositeField]
        public MongoDBRef user { get; set; }
        [DtoCompositeField]
        public string itemName { get; set; }
    }
}

What Dto can do

//Dto at default have getter setter for ID
ObjectId id = user.ID;

//get MongoDBRef to user
MongoDBRef ref = user.ToDBRef<User>();

//get object from MongoDBRef
User userFromRef = ref.GetObject<User>();

Get Dao

To get Dao for your specific Dto, you can get it from DaoContext class. It will only create one Dao object for every Dto class and reuse it.

//import this namespace
using Catcher.DB.DAO;

IDao<User> dao = DaoContext.GetDao<User>();

Using Dao

Here are some of Dao can do :

//inserting. Any null property will be ignored
dao.Insert(user);

//Deleting user. It will search by its objectId first and unique id / composite id if you did not provide one
dao.Delete(user);

Find using Dao

Here are some of method to find object in the database :

//Find by object id
User user = dao.Find.ByObjectID(id);

//Find object that looks like (not necessary equal) your object
IList<User> usersLike = dao.Find.WhenLike(user);

//Find object that equal with your object (except its ObjectId and unique field name) and ignore it's null property
IList<User> usersLike = dao.Find.WhenEqual(user, true);

Contribute

We would love you for the contribution to Catcher, just contact me to nayanda@catch.co.id