C# Class CinderellaLauncher.DatabaseIO

Show file Open project: ThomasMoreCollege/CinderellaMGS Class Usage Examples

Public Methods

Method Description
CheckForRows ( string sqlStatement ) : bool

This method allowed you to determine if an sql statement will return any rows.
CloseConnection ( ) : void

Closes the connection if it is open.
DatabaseIO ( ) : System
ExecuteQuery ( string sqlStatement ) : int

Method will execute a non query SQL statement and return the number of rows affected.
GetConnection ( ) : SqlConnection

Creates the SQLConnection object "conn" which is used throughout the rest of the databaseIO methods.
GetRows ( string sqlStatement ) : int

This method will allow you to determine how many rows will be returned from an sql query.
ReturnFirstCellInt ( string sqlStatement ) : int
ReturnFirstCellString ( string sqlStatement ) : string
checkConnection ( ) : bool

This method will check for a valid connection string and try opening a new connection.
getAggDataString ( string sqlComm, string tableName ) : string

Method used when executing an sql query that is retrieving aggregate data.
getDataSet ( string sqlComm, string tableName ) : DataSet

This method will allow you to retrieve a dataset containing the data from the executed query.

Private Methods

Method Description
errorCheck ( Exception errorMessage ) : void

Method is used to help centralize and customize database error messages.

Method Details

CheckForRows() public method

This method allowed you to determine if an sql statement will return any rows.
public CheckForRows ( string sqlStatement ) : bool
sqlStatement string SQL Query to use
return bool

CloseConnection() public method

Closes the connection if it is open.
public CloseConnection ( ) : void
return void

DatabaseIO() public method

public DatabaseIO ( ) : System
return System

ExecuteQuery() public method

Method will execute a non query SQL statement and return the number of rows affected.
public ExecuteQuery ( string sqlStatement ) : int
sqlStatement string SQL Query to be executed.
return int

GetConnection() public method

Creates the SQLConnection object "conn" which is used throughout the rest of the databaseIO methods.
public GetConnection ( ) : SqlConnection
return System.Data.SqlClient.SqlConnection

GetRows() public method

This method will allow you to determine how many rows will be returned from an sql query.
public GetRows ( string sqlStatement ) : int
sqlStatement string SQL Query to use
return int

ReturnFirstCellInt() public method

public ReturnFirstCellInt ( string sqlStatement ) : int
sqlStatement string
return int

ReturnFirstCellString() public method

public ReturnFirstCellString ( string sqlStatement ) : string
sqlStatement string
return string

checkConnection() public method

This method will check for a valid connection string and try opening a new connection.
public checkConnection ( ) : bool
return bool

getAggDataString() public method

Method used when executing an sql query that is retrieving aggregate data.
public getAggDataString ( string sqlComm, string tableName ) : string
sqlComm string SQL Aggregate Query
tableName string The specific table within the dataset.
return string

getDataSet() public method

This method will allow you to retrieve a dataset containing the data from the executed query.
public getDataSet ( string sqlComm, string tableName ) : DataSet
sqlComm string The SQL query you are using to retrieve the dataset
tableName string The specific table within the dataset.
return System.Data.DataSet