Skip to main content

Easy way to parse SQL data reader objects

Many a times, I have seen that people end up writing lot of codes to read from SQL data reader or there is no fail safe mechanism to handle, if parse fails out.

In this article, I will try to cover up above issue and implement uniform way to handle things with fail safe mechanism using TryParse approach. Mainly, I will extend inbuilt try parse mechanism comes with .Net. Int.TryParse and similar type of methods was introduced in 2.0 Framework, so the code should be compatible with 2.0 or higher framework.

Let's directly dive into usage since we have just single function DbTryParse. I will be explaining function on later stage.
We can use with fail safe mechanism where some values are not properly parsed then row will get skipped or in normal way, we define some default value and move ahead with other rows.

 int id;  
 string val;  
 double dbl;  
 reader["id"].DbTryParse(out id, int.TryParse, 89);  
 reader["val"].DbTryParse(out val, "NA");  
 reader["doubleTest"].DbTryParse(out dbl, double.TryParse);  

I have tried with integer, string and double in similar way other types of variable can be used as well.
In this, I am reading integer Id column and sending logic for parsing with int.TryParse. If parse fails then it will set 100 as a default, this is optional parameter. Check out double parsing where we are not setting the default value.

Since we do not have inbuilt function like TryParse for string and it's a reference type. There is no need of handler and it is implemented in different way that we will see it later.

 reader["val"].DbTryParse(out val, "NA");  

If we want to skip rows on failure of any parse, then we could use:

 if (reader["id"].DbTryParse(out id, int.TryParse) &&  
 reader["val"].DbTryParse(out val) &&  
 reader["doubleTest"].DbTryParse(out dbl, double.TryParse))  
 {  
     Console.WriteLine("Parsing successful");  
 }  
 else  
 {  
     Console.WriteLine("Parsing failed.");  
 }  

That is all we need for parsing. The single DbTryParse is taking care of every possible parses.

Let's look into the implementation part. If we see all TryParse from .Net they accept string as first parameter and then the out parameter to parse value. For that a TryParseHandler<T> delegate wrapper is created. The generic parse functions are restricted with struct type which takes care of value type. The same function is overloaded to handle string type.

Here are codes:

   public static class CommonExtensionMethods  
   {  
     /// <summary>  
     /// Try parse handler  
     /// </summary>  
     /// <typeparam name="T">The result type</typeparam>  
     /// <param name="value">The string literal.</param>  
     /// <param name="result">The result of typecasting.</param>  
     /// <returns>True, if typecasting is successful, else false.</returns>  
     public delegate bool TryParseHandler<T>(string value, out T result);  
     /// <summary>  
     /// Generic try parse.  
     /// </summary>  
     /// <typeparam name="T">Type of the value</typeparam>  
     /// <param name="value">The string literal.</param>  
     /// <param name="parsedValue">The parsed value.</param>  
     /// <param name="handler">The type casting handler.</param>  
     /// <param name="defaultValue">The default value. This value will be set in case of failed parsing.</param>  
     /// <returns>Parsed object</returns>  
     /// <exception cref="System.ArgumentNullException">handler</exception>  
     public static bool TryParse<T>(this string value, out T parsedValue, TryParseHandler<T> handler,  
       T defaultValue = default(T))  
       where T : struct  
     {  
       if (handler == null)  
       {  
         throw new ArgumentNullException("handler");  
       }  
       if (String.IsNullOrEmpty(value))  
       {  
         parsedValue = defaultValue;  
         return false;  
       }  
       return handler(value, out parsedValue);  
     }  
     /// <summary>  
     /// Generic try parse for databases object.  
     /// </summary>  
     /// <typeparam name="T">The type of object for parsing value</typeparam>  
     /// <param name="val">The value.</param>  
     /// <param name="parsedValue">The parsed value.</param>  
     /// <param name="handler">The parsing handler.</param>  
     /// <param name="defaultValue">The default value. This value will be set in case of failed parsing.</param>  
     /// <returns>  
     /// Parsed object  
     /// </returns>  
     public static bool DbTryParse<T>(this object val, out T parsedValue, TryParseHandler<T> handler  
       , T defaultValue = default(T))  
       where T : struct  
     {  
       if (val == DBNull.Value)  
       {  
         parsedValue = defaultValue;  
         return false;  
       }  
       return Convert.ToString(val).TryParse(out parsedValue, handler, defaultValue);  
     }  
     /// <summary>  
     /// Databases object parsing to string.  
     /// </summary>  
     /// <param name="val">The value.</param>  
     /// <param name="parsedValue">The parsed value.</param>  
     /// <param name="defaultValue">The default value. This value will be set in case of failed parsing.</param>  
     /// <returns>String representation of parsed object</returns>  
     public static bool DbTryParse(this object val, out string parsedValue  
       , string defaultValue = null)  
     {  
       if (val == DBNull.Value)  
       {  
         parsedValue = defaultValue;  
         return false;  
       }  
       parsedValue = Convert.ToString(val) ?? defaultValue;  
       return parsedValue == defaultValue ? false : true;  
     }  
     /// <summary>  
     /// Databases object parsing to string.  
     /// </summary>  
     /// <param name="val">The value.</param>  
     /// <param name="defaultValue">The default value. This value will be set in case of failed parsing.</param>  
     /// <returns>String representation of given object</returns>  
     public static string DbParse(this object val, string defaultValue = null)  
     {  
       return val == DBNull.Value ? defaultValue : Convert.ToString(val) ?? defaultValue;  
     }  
   }  

Source: http://www.mindfiresolutions.com/Database-Reader-Object-Parsing-in-NET-2673.php

Popular posts from this blog

Handling JSON DateTime format on Asp.Net Core

This is a very simple trick to handle JSON date format on AspNet Core by global settings. This can be applicable for the older version as well.

In a newer version by default, .Net depends upon Newtonsoft to process any JSON data. Newtonsoft depends upon Newtonsoft.Json.Converters.IsoDateTimeConverter class for processing date which in turns adds timezone for JSON data format.

There is a global setting available for same that can be adjusted according to requirement. So, for example, we want to set default formatting to US format, we just need this code.


services.AddMvc() .AddJsonOptions(options => { options.SerializerSettings.DateTimeZoneHandling = "MM/dd/yyyy HH:mm:ss"; });



Elegantly dealing with TimeZones in MVC Core / WebApi

In any new application handling TimeZone/DateTime is mostly least priority and generally, if someone is concerned then it would be handled by using DateTime.UtcNow on codes while creating current dates and converting incoming Date to UTC to save on servers.
Basically, the process is followed by saving DateTime to UTC format in a database and keep converting data to native format based on user region or single region in the application's presentation layer.
The above is tedious work and have to be followed religiously. If any developer misses out the manual conversion, then that area of code/view would not work.
With newer frameworks, there are flexible ways to deal/intercept incoming or outgoing calls to simplify conversion of TimeZones.
These are steps/process to achieve it. 1. Central code for storing user's state about TimeZone. Also, central code for conversion logic based on TimeZones. 2. Dependency injection for the above class to be able to use globally. 3. Creating Mo…

Global exception handling and custom logging in AspNet Core with MongoDB

In this, we would be looking into logging and global exception handling in the AspNet Core application with proper registration of logger and global exception handling.

Custom logging
The first step is to create a data model that we want to save into DB.

Error log Data model
These are few properties to do logging which could be extended or reduced based on need.

public class ErrorLog { /// <summary> /// Gets or sets the Error log identifier. /// </summary> /// <value> /// The Error log identifier. /// </value> [BsonRepresentation(BsonType.ObjectId)] public ObjectId Id { get; set; /// <summary> /// Gets or sets the date. /// </summary> /// <value> /// The date. /// </value> public DateTime Date { get; set; } /// <summary> /// Gets or sets the thread. /// </summary> /// <v…

LDAP with ASP.Net Identity Core in MVC with project.json

Lightweight Directory Access Protocol (LDAP), the name itself explain it. An application protocol used over an IP network to access the distributed directory information service.

The first and foremost thing is to add references for consuming LDAP. This has to be done by adding reference from Global Assembly Cache (GAC) into project.json

"frameworks": { "net461": { "frameworkAssemblies": { "System.DirectoryServices": "4.0.0.0", "System.DirectoryServices.AccountManagement": "4.0.0.0" } } },
These System.DirectoryServices and System.DirectoryServices.AccountManagement references are used to consume LDAP functionality.

It is always better to have an abstraction for irrelevant items in consuming part. For an example, the application does not need to know about PrincipalContext or any other dependent items from those two references to make it extensible. So, we can begin with some bas…

Unit Of Work injection through Asp.Net Core Dependency Injection

This article is not directly related to UnitOfWork but leveraging Asp.Net Core Dependency Injection to consume Unit Of Work.

In one of the previous article about project architecture, I was not very satisfied with the approach for Unit Of Work implementation for initialization of repository even if with some advantage.

Here is old code for UnitOfWork.

public sealed partial class MyProjectUnitOfWork : UnitOfWork<DbContext>, IMyProjectUnitOfWork { public MyProjectUnitOfWork(IContextFactory<DbContext> contextFactory) : base(contextFactory) { } /// <summary> /// BookRepository holder /// </summary> private MyProject.DB.Repository.BookRepository _bookRepository; /// <summary> /// Gets the BookRepository repository. /// </summary> /// <value> /// The BookRepository repository. /// </value> MyProject.Interface.Repository.IBoo…

Architecture solution composting Repository Pattern, Unit Of Work, Dependency Injection, Factory Pattern and others

Project architecture is like garden, we plant the things in certain order and eventually they grow in similar manner. If things are planted well then they will all look(work) great and easier to manage. If they grow as cumbersome it would difficult to maintain and with time more problems would be happening in maintenance.

There is no any fixed or known approach to decide project architecture and specially with Agile Methodology. In Agile Methodology, we cannot predict how our end products will look like similarly we cannot say a certain architecture will fit well for entire development lifespan for project. So, the best thing is to modify the architecture as per our application growth. I understand that it sounds good but will be far more problematic with actual development. If it is left as it is then more problems will arise with time. Just think about moving plant vs a full grown tree.

Coming to technical side, In this article, I will be explaining about the various techniques tha…

Client side Validation for data driven view engine

The prerequisite for this is to have a designed database driven view engine. This can be a good guidance to implement DB driven view engine Data Driven Custom View Engine in ASP.NET MVC (http://www.dotnetcurry.com/aspnet-mvc/946/data-driven-custom-view-engine-aspnet-mvc).

If we talk about the concept then we can say for DB driven view engine a dynamic form/screen table would require along with the associate attribute set for controls. The controls, Attribute set can have constraints like Required, MaxLength, RegEx etc. similar to available DataAnnotation implementation, just that it has to come through DB.

The jQuery unobtrusive validation is all about adding certain HTML 5 data attributes. So, if we can find rules of the controls (required, max length etc) and set it to HTML attribute from view engine then we are done.

While designing DB driven view engine, there should be a place where we need to loop through available controls to identify it's type and write as HTML/element. A…

Configuring Ninject, Asp.Net Identity UserManager, DataProtectorTokenProvider with Owin

It can be bit tricky to configure both Ninject and Asp.Net Identity UserManager if some value is expected from DI to configure UserManager. We will look into configuring both and also use OwinContext to get UserManager.

As usual, all configuration need to be done on Startup.cs. It is just a convention but can be used with different name, the important thing is to decorate class with following attribute to make it Owin start-up:

[assembly: OwinStartup(typeof(MyProject.Web.Startup))]
Ninject configuration

Configuring Ninject kernel through method which would be used to register under Owin.

Startup.cs
public IKernel CreateKernel() { var kernel = new StandardKernel(); try { //kernel.Bind<IHttpModule>().To<HttpApplicationInitializationHttpModule>(); // TODO: Put any other injection which are required. return kernel; } catch { kernel.Dispose(); throw; }…

OpenId Authentication with AspNet Identity Core

This is a very simple trick to make AspNet Identity work with OpenId Authentication. More of all both approach is completely separate to each other, there is no any connecting point.

I am using Microsoft.AspNetCore.Authentication.OpenIdConnect package to configure but it should work with any other.

Configuring under Startup.cs with IAppBuilder
app.UseCookieAuthentication(new CookieAuthenticationOptions { AuthenticationScheme = CookieAuthenticationDefaults.AuthenticationScheme, LoginPath = new PathString("/Account/Login"), CookieName = "MyProjectName", }) .UseIdentity() .UseOpenIdConnectAuthentication(new OpenIdConnectOptions { ClientId = "<AzureAdClientId>", Authority = String.Format("https://login.microsoftonline.com/{0}", "<AzureAdTenant>"), ResponseType = OpenIdConnectResponseType.IdToken, PostLogoutRedirectUri = "<my website url>", Au…

Kendo MVC Grid DataSourceRequest with AutoMapper

Kendo Grid does not work directly with AutoMapper but could be managed by simple trick using mapping through ToDataSourceResult. The solution works fine until different filters are applied.
The problems occurs because passed filters refer to view model properties where as database model properties are required after AutoMapper is implemented.
So, the plan is to intercept DataSourceRequest  and modify names based on database model. To do that we are going to create implementation of CustomModelBinderAttribute to catch calls and have our own implementation of DataSourceRequestAttribute from Kendo MVC. I will be using same source code from Kendo but will replace column names for different criteria for sort, filters, group etc.
Let's first look into how that will be implemented.
public ActionResult GetRoles([MyDataSourceRequest(GridId.RolesUserGrid)] DataSourceRequest request) { if (request == null) { throw new ArgumentNullException("reque…