FFXIVLIB  0.4.1
FFXIVLIB is a library designed to help creating 3rd party tools for FFXIV
 All Classes Namespaces Functions Variables Enumerations Properties Pages
Public Member Functions | List of all members
SQLiteDatabase Class Reference

Public Member Functions

 SQLiteDatabase ()
 Default Constructor for SQLiteDatabase Class. More...
 
 SQLiteDatabase (String inputFile)
 Single Param Constructor for specifying the DB file. More...
 
 SQLiteDatabase (Dictionary< String, String > connectionOpts)
 Single Param Constructor for specifying advanced connection options. More...
 
DataTable GetDataTable (string sql)
 Allows the programmer to run a query against the Database. More...
 
int ExecuteNonQuery (string sql)
 Allows the programmer to interact with the database for purposes other than a query. More...
 
string ExecuteScalar (string sql)
 Allows the programmer to retrieve single items from the DB. More...
 
bool Update (String tableName, Dictionary< String, String > data, String where)
 Allows the programmer to easily update rows in the DB. More...
 
bool Delete (String tableName, String where)
 Allows the programmer to easily delete rows from the DB. More...
 
bool Insert (String tableName, Dictionary< String, String > data)
 Allows the programmer to easily insert into the DB More...
 
bool ClearDb ()
 Allows the programmer to easily delete all data from the DB. More...
 
List< String > GetTables ()
 
bool ClearTable (String table)
 Allows the user to easily clear all data from a specific table. More...
 

Constructor & Destructor Documentation

SQLiteDatabase.SQLiteDatabase ( )

Default Constructor for SQLiteDatabase Class.

SQLiteDatabase.SQLiteDatabase ( String  inputFile)

Single Param Constructor for specifying the DB file.

Parameters
inputFileThe File containing the DB
SQLiteDatabase.SQLiteDatabase ( Dictionary< String, String >  connectionOpts)

Single Param Constructor for specifying advanced connection options.

Parameters
connectionOptsA dictionary containing all desired options and their values

Member Function Documentation

bool SQLiteDatabase.ClearDb ( )

Allows the programmer to easily delete all data from the DB.

Returns
A boolean true or false to signify success or failure.
bool SQLiteDatabase.ClearTable ( String  table)

Allows the user to easily clear all data from a specific table.

Parameters
tableThe name of the table to clear.
Returns
A boolean true or false to signify success or failure.
bool SQLiteDatabase.Delete ( String  tableName,
String  where 
)

Allows the programmer to easily delete rows from the DB.

Parameters
tableNameThe table from which to delete.
whereThe where clause for the delete.
Returns
A boolean true or false to signify success or failure.
int SQLiteDatabase.ExecuteNonQuery ( string  sql)

Allows the programmer to interact with the database for purposes other than a query.

Parameters
sqlThe SQL to be run.
Returns
An Integer containing the number of rows updated.
string SQLiteDatabase.ExecuteScalar ( string  sql)

Allows the programmer to retrieve single items from the DB.

Parameters
sqlThe query to run.
Returns
A string.
DataTable SQLiteDatabase.GetDataTable ( string  sql)

Allows the programmer to run a query against the Database.

Parameters
sqlThe SQL to run
Returns
A DataTable containing the result set.
bool SQLiteDatabase.Insert ( String  tableName,
Dictionary< String, String >  data 
)

Allows the programmer to easily insert into the DB

Parameters
tableNameThe table into which we insert the data.
dataA dictionary containing the column names and data for the insert.
Returns
A boolean true or false to signify success or failure.
bool SQLiteDatabase.Update ( String  tableName,
Dictionary< String, String >  data,
String  where 
)

Allows the programmer to easily update rows in the DB.

Parameters
tableNameThe table to update.
dataA dictionary containing Column names and their new values.
whereThe where clause for the update statement.
Returns
A boolean true or false to signify success or failure.

The documentation for this class was generated from the following file: