Use this class library to execute your MS SQL queries in your C# programs easily without hassle.
Do you find yourself writing a handful of codes to execute a single or number of SQL statement(s) in your C# program using System.Data.SqlClient? Do your code somewhat looks like this as follows:
SqlConnection conn = new SqlConnection(SQLConnectionString);
SqlCommand comm = null;
int returnResult;
try
{
comm = conn.CreateCommand();
comm.CommandType = CommandType.Text;
comm.CommandText = Query;
comm.CommandTimeout = SQLTimeout;
try
{
conn.Open();
returnResult = comm.ExecuteNonQuery();
}
catch
{
conn.Close();
throw new SqlException();
}
}
catch (Exception ex)
{
throw new Exception(ex.Message.ToString());
}
finally
{
conn.Close(); // Always remember to close connection to database or else it would lead to memory leakage
}
And don't even mention that what headache this code can cause to you in case you mess up or forget a single line of code from the above.
But do not worry, there is an easy solution.
Use EasySQL class library to execute any (or list of) SQL statement(s) without hassle.
Let me show you how you can write the aforementioned code using EasySQL Class as follows:
EasySQL thisSQL = new EasySQL(SQLConnectionString);
thisSQL.Execute(Query);
That's it. Nothing else. You don't have to worry about opening or closing database connections or worry about other small stuffs, so that you can devote more in developing your solution effectively rather than fighting to execute database queries.
IsConnected(): bool: Returns true or false whether connection to database is successful or not
GetConnectionString(): String: Returns the connection string which is set/used
GetTimeout(): Int: Returns the connection time out
Execute(String): Int: Executes the query and returns the number of rows affected
Execute(String, out DataSet): Int: Executes the query to fetch the data in dataset and returns the number of rows affected
Execute(String, out DataTable): Int: Executes the query to fetch the data in datatable and returns the number of rows affected
Execute(String, Dictionary<String, String>): Int: Executes the query with parameters and returns the number of rows affected
Execute(String, Dictionary<String, String>, out DataSet): Int: Executes the query with parameters to fetch the data in dataset and returns the number of rows affected
Execute(String, Dictionary<String, String>, out DataTable): Int: Executes the query with parameters to fetch the data in datatable and returns the number of rows affected
ExecuteProcedure(String): Int: Excutes the stored procedure and returns the number of rows affected
ExecuteProcedure(String, out DataSet): Int: Excutes the stored procedure to fetch data in dataset and returns the number of rows affected
ExecuteProcedure(String, out DataTable): Int: Excutes the stored procedure to fetch data in datatable and returns the number of rows affected
Execute(String, SqlCredential): Int: Excutes the query using SqlCredential for elevated security and returns the number of rows affected
Execute(String, SqlCredential, out DataSet): Int: Executes the query using SqlCredential for elevated security to fetch the data in dataset and returns the number of rows affected
Execute(String, SqlCredential, out DataTable): Int: Executes the query using SqlCredential for elevated security to fetch the data in datatable and returns the number of rows affected
Execute(String, Dictionary<String, String>, SqlCredential): Int: Excutes the query with parameters using SqlCredential for elevated security and returns the number of rows affected
Execute(String, Dictionary<String, String>, SqlCredential, out DataSet): Int: Executes the query with parameters using SqlCredential for elevated security to fetch the data in dataset and returns the number of rows affected
Execute(String, Dictionary<String, String>, SqlCredential, out DataTable): Int: Executes the query with parameters using SqlCredential for elevated security to fetch the data in datatable and returns the number of rows affected
ExecuteProcedure(String, SqlCredential): Int: Executes the stored procedure using SqlCredential for elevated security and returns the number of rows affected
ExecuteProcedure(String, SqlCredential, out DataSet): Int: Executes the stored procedure using SqlCredential for elevated security to fetch data in dataset and returns the number of rows affected
ExecuteProcedure(String, SqlCredential, out DataTable): Int: Executes the stored procedure using SqlCredential for elevated security to fetch data in datatable and returns the number of rows affected
Let's insert a new record of city in our CITIES table as follows:
private void InsertCityRecord(string connectionString)
{
string query = "Insert Into [CITIES] (CityName, Country) VALUES('Kolkata', 'India')";
EasySQL thisSQL = new EasySQL(connectionString);
thisSQL.Execute(query);
}
Or we can fetch user credentials from a form and use that to query our database as follows:
private void runUserQuery()
{
// Fetch User input
System.Windows.Controls.TextBox txtUserId = new System.Windows.Controls.TextBox();
System.Windows.Controls.PasswordBox txtPwd = new System.Windows.Controls.PasswordBox();
// Read config for connection string
Configuration config = Configuration.WebConfigurationManager.OpenWebConfiguration(Null);
ConnectionStringSettings connString = config.ConnectionStrings.ConnectionString[“MyConnString”];
// Create sql credential
SecureString pwd = txtPwd.SecurePassword;
pwd.MakeReadOnly();
SqlCredential cred = new SqlCredential(txtUserId.Text, pwd);
// Execute using EasySQL
EasySQL thisSQL = new EasySQL(connString);
thisSQL.ExecuteProcedure(storedProcedureName, cred);
}
Or we can also execute a list of queries as follows:
private void runListOfQueries(List<string> queries, string connectionString)
{
// Initiate EasySQL
EasySQL thisSQL = new EasySQL(connectionString);
// Iterate over list of queries and execute one by one
foreach(string query in queries)
{
thisSQL.Execute(query);
}
}
Let's assume we have a table in the database named, Customers, with the following fields: Name: varchar, Email: varchar, Age: int, Adult: varchar, IsBritish: boolean. You would now like to query the table using EasySQL class in the following ways:
// Example 1::
// Connection string to your database
string connectionString = "Data Source=ServerName; Initial Catalog = DatabaseName; User ID = UserName; Password=Password";
// initiate the EasySQL object
EasySQL.EasySQL thisSQL = new EasySQL.EasySQL(connectionString, 300);
// Your required query to return the names and associated emails of customers
string query = "Select Name, Email from Customers Where Age = @age ";
// Required parameters
Dictionary<string, string> param = new Dictionary<string, string>();
param.Add("@age", "26");
// Data table which will hold returned result of the query
DataTable dt = new DataTable();
try
{
// Execute the query inside a try/catch to catch exceptions as they happen
thisSQL.Execute(query, param, out dt);
}
catch (Exception ex) { throw new Exception(ex.Message); }
// Read the names and associated emails from the data table
if (dt.Rows.Count > 0)
{
foreach (DataRow dr in dt.Rows)
{
var name = dr["Name"].ToString();
var email = dr["Email"].ToString();
}
}
// Example 2::
// The same aforementioned query without any parameter-->
string connectionString = "Data Source=ServerName; Initial Catalog = DatabaseName; User ID = UserName; Password=Password";
EasySQL.EasySQL thisSQL = new EasySQL.EasySQL(connectionString, 300);
string query = "Select Name, Email from Customers";
DataTable dt = new DataTable();
try
{
thisSQL.Execute(query, out dt);
}
catch (Exception ex) { throw new Exception(ex.Message); }
if (dt.Rows.Count > 0)
{
foreach (DataRow dr in dt.Rows)
{
var name = dr["Name"].ToString();
var email = dr["Email"].ToString();
}
}
// Example 3::
// And an update query on your customer database as follows -->
string connectionString = "Data Source=ServerName; Initial Catalog = DatabaseName; User ID = UserName; Password=Password";
EasySQL.EasySQL thisSQL = new EasySQL.EasySQL(connectionString, 300);
string query = "Update Customers Set Adult = @adult Where Age = @age ";
Dictionary<string, string> param = new Dictionary<string, string>();
param.Add("@adult", "true");
param.Add("@age", "26");
try
{
int rowsAffected = thisSQL.Execute(query, param);
}
catch (Exception ex) { throw new Exception(ex.Message); }
// Example 4::
// And another query to fetch all customers' names who are British -->
string connectionString = "Data Source=ServerName; Initial Catalog = DatabaseName; User ID = UserName; Password=Password";
EasySQL.EasySQL thisSQL = new EasySQL.EasySQL(connectionString, 300);
string query = "Select Name from Customers where IsBritish = @british ";
Dictionary<string, string> param = new Dictionary<string, string>();
param.Add("@british", "1"); // For boolean the value to be passed is 1 (true) or 0 (false).
DataTable dt = new DataTable();
try
{
int rowsAffected = thisSQL.Execute(query, param, out dt);
}
catch (Exception ex) { throw new Exception(ex.Message); }
if (dt.Rows.Count > 0)
{
foreach (DataRow dr in dt.Rows)
{
var name = dr["Name"].ToString();
}
}
The source code of the EasySQL Class library is available to download from TechNet Gallery and GitHub.
This article is also available from TechNet Wiki here: https://social.technet.microsoft.com/wiki/contents/articles/48290.using-easysql-class-to-execute-ms-sql-and-stored-procedures-easily-in-c.aspx