{"id":1444,"date":"2022-10-10T18:12:25","date_gmt":"2022-10-11T00:12:25","guid":{"rendered":"https:\/\/www.great-white-software.com\/blog\/?p=1444"},"modified":"2022-10-10T18:14:43","modified_gmt":"2022-10-11T00:14:43","slug":"working-with-databases-in-c","status":"publish","type":"post","link":"https:\/\/www.great-white-software.com\/blog\/2022\/10\/10\/working-with-databases-in-c\/","title":{"rendered":"Working with databases in C#"},"content":{"rendered":"\n

The trek continues !<\/p>\n\n\n\n

One of the common things we need our applications to do is interact with a database. Sometimes its just a local SQLite, or other stand alone db engine like that, or some “Big Iron” database like Oracle, MS SQL Server, PostgreSQL, etc. Or maybe a NoSQL database like Mongo ?
With Xojo there are only a handful of plugins Tod ell with the vast majority of databases. Either you use the ones provided by Xojo. Or the ones from MBS or Valentina, or CubeSQL. There just arent that many vendors or plugins to have to wade through<\/p>\n\n\n\n

In C#, because its widely available on so many platforms, there are tons of NuGet packages to select from. I cant tell you all of them or which specific ones will \/ wont work on macOS. I haven’t tried them all \ud83d\ude42
Typing in “database” to the search field in the package manager gives a scrolling list that is immense.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n

325,832 packages is much like saying “there are 325,832 plugins for Xojo”
Christians good but I dont think even he’s got that many \ud83d\ude1b

So there is a LOT to choose from and databases are no exception. This chapter isn’t a “how to do anything with any database in C#” but how to use one specific NuGet package to use SQLITE. <\/p>\n\n\n\n

So lets get started !<\/p>\n\n\n\n

I’m still adding to my standard “Getting Started project”<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

In order to “add a plugin” in Xojo you’d add it to the IDE’s Plugins, restart and it would be available in every project you opened. VS works differently and each solution can have a different list of packages and even different versions of the same package.<\/p>\n\n\n\n

For our purpose we’re going to add a reference<\/em> to our project to make this package usable in our code.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Select the references<\/em> item and right click (or you can just select the Project<\/em> > Add Reference…<\/em> menu item)<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

For THIS project we’re going to add Mono.Data.SQLite<\/strong> and System.Data<\/strong>
Check the check box next to them and they’ll be added to the list on the right<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Press select & they’ll be added to your project.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Our app doesnt have a lot of code in it – yet – so tying a database into it is a little contrived.
All we have is a window that we have textfields on and it just has a got focus event.
Lets add a listbox to the window so we can put some data into something familiar.<\/p>\n\n\n\n

list = new ListBox( (float)textfield2.Left,\n                    (float)(textfield2.Top + textfield2.Height + 12),\n                    (float)(kDefaultWidth - 20),\n                    (float)(kDefaultHeight - (textfield2.Top + \n                              textfield2.Height + 12 + 12)) );\n            list.LockLeft = true;\n            list.LockTop = true;\n            list.LockRight = true;\n            list.LockBottom = true;\n\nreturn new Control[] { textfield1, textfield2, list };\n<\/code><\/pre>\n\n\n\n
I defined 2 constants for the default height and width of the window so I could reuse those elsewhere. And yes, control locking works just like in Xojo \ud83d\ude42<\/p>\n\n\n\n
\nnamespace getting_started\n{\n\tpublic class MainWindow : Window\n\t{\n\n        const int kDefaultWidth = 600;\n        const int kDefaultHeight = 400;<\/code><\/pre>\n\n\n\n
And I altered my SetUpWindow method to use those constants instead of the hard coded literals.
<\/p>\n\n\n\n
What you should notice is how C# does a CAST – in Xojo its like<\/p>\n\n\n\n
INTEGER( expression you want treated as an integer )\n<\/code><\/pre>\n\n\n\n
almost like a function call. In C# its <\/p>\n\n\n\n
(INTEGER) expression you want treated as an integer \n<\/code><\/pre>\n\n\n\n
so you have to be sure to put brackets around the expression you want to cast. Often I just write<\/p>\n\n\n\n
(INTEGER)( expression you want treated as an integer )<\/code><\/pre>\n\n\n\n
just to be safe. BU the “style gods” and language pedants get upset at this verbosity \ud83d\ude42<\/p>\n\n\n\n
OK so now we have a list to show data in. We could load the data in the control creation method but we’ll add it elsewhere since thats more like what we would do in many cases. I’m going to add a button next to the lower text field, just because that seems a good place, and then hook the database code into the pushbutton push event. I added a declaration of the button with the listbox and other controls :<\/p>\n\n\n\n
        Button pushButton;\n<\/code><\/pre>\n\n\n\n
and added this code to the method creating all the controls<\/p>\n\n\n\n
pushButton = new Button((float)(textfield2.Left + textfield2.Width + 12),\n                        (float)(textfield2.Top),\n                        80,\n                        22);\n\npushButton.Pressed += pushbutton_Pressed;\n\nreturn new Control[] { textfield1, textfield2, list, pushButton };\n<\/code><\/pre>\n\n\n\n
For right now the method for pushbutton_Pressed looks like<\/p>\n\n\n\n
private void pushbutton_Pressed(object sender, EventArgs e)\n{\n            \n\n}<\/code><\/pre>\n\n\n\n
You should still be able to run & the button will just do nothing.<\/p>\n\n\n\n
To use Sqlite in this code we will need to add a using<\/em> statement.<\/p>\n\n\n\n
using Mono.Data.Sqlite;<\/code><\/pre>\n\n\n\n
Typically these are all at the top of whatever source code file you’re working in. I like to group them <\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
The Sqlite package we added uses a form of access to the DB that is very similar to what Xojo has, but its not identical.<\/p>\n\n\n\n
The code we’re going to add will use local variables, but moving those to be application or window wide is a trivial operation so it really won’t matter much.<\/p>\n\n\n\n
First we need to declare a variable to hold the Sqlite_connection<\/em> – this would be analogous to defining a variable for the SQLiteDatabase object in Xojo.<\/p>\n\n\n\n
Mono.Data.Sqlite.SqliteConnection sqlite_conn; \n\/\/ in Xojo var sqlite_conn as SQLiteDatabase\n   <\/code><\/pre>\n\n\n\n
Then we need to create the instance – this will attach to an in memory database. In Xojo this is different – we just dont open a database file<\/p>\n\n\n\n
 sqlite_conn = new SqliteConnection(\"Data Source=:memory:\");\n<\/code><\/pre>\n\n\n\n
Then we actually tell this new connection to OPEN and attach to whatever database we set up as the data source<\/p>\n\n\n\n
sqlite_conn.Open();<\/code><\/pre>\n\n\n\n
About this point you’re wondering Great but how do I check errors ?<\/em> This is one are where .Net and Xojo, now, agree. .Net uses EXCEPTIONS for error handling ( at least with this database although I expect others are similar)<\/p>\n\n\n\n
So in reality our code should look like<\/p>\n\n\n\n
Mono.Data.Sqlite.SqliteConnection sqlite_conn;\n\ntry\n{\n    sqlite_conn = new SqliteConnection(\"Data Source=:memory:\");\n\n    sqlite_conn.Open();\n }\n catch (Mono.Data.Sqlite.SqliteException exc)\n {\n   Console.WriteLine(\"An error occurred {0}\", exc.Message);\n}<\/code><\/pre>\n\n\n\n
All the rest of the code we’ll add will be inside the TRY CATCH block following the opening of the connection.<\/p>\n\n\n\n
The API that .Net uses for many database is ADO. Its a lot like what Xojo uses but has syntax differences. See https:\/\/learn.microsoft.com\/en-us\/sql\/ado\/guide\/ado-programmer-s-guide?view=sql-server-ver16<\/p>\n\n\n\n
About the biggest difference is that ADO seems a tad more low level. In some ways that makes certain thinks possible and in other ways it’s a pain because it means you write more code.<\/p>\n\n\n\n
Onwards !<\/p>\n\n\n\n
In order to RUN any sql command we need a command object<\/em> – an IDbCommand<\/em>. Then we configure that object and then tell it to execute. <\/p>\n\n\n\n
IDbCommand dbcmd = sqlite_conn.CreateCommand();\nstring sql = \"create table employee ( firstname, lastname )\";\ndbcmd.CommandText = sql;\ndbcmd.ExecuteNonQuery();<\/code><\/pre>\n\n\n\n
Just as in Xojo there are several ways to execute sql statements – some that return results, some that return a single result, or ones that return no results at all.  The previous code returns no results hence its a “non-query”.<\/p>\n\n\n\n
And since this is an in memory database we’ll just add a few rows to it.<\/p>\n\n\n\n
sql = \"insert into employee ( firstname, lastname ) values('Norm', 'Palardy')\";\ndbcmd.CommandText = sql;\ndbcmd.ExecuteNonQuery();\n\nsql = \"insert into employee ( firstname, lastname ) values('Joe', 'Smith')\";\ndbcmd.CommandText = sql;\ndbcmd.ExecuteNonQuery();<\/code><\/pre>\n\n\n\n
Now we have a database connection, a table, and some data in it. To read that data we’ll need the ADO equivalent of a Xojo recordset<\/em> or rowset<\/em>. This is an IDataReader<\/em>. Also since the command were going to execute will return a reader well just a different method – just like in Xojo where you’d use SQLSelect<\/em> or SelectSQL<\/em>.<\/p>\n\n\n\n
sql = \"SELECT firstname, lastname FROM employee\";\ndbcmd.CommandText = sql;\nIDataReader reader = dbcmd.ExecuteReader();\n\nwhile (reader.Read())\n{\n     string firstName = reader.GetString(0);\n     string lastName = reader.GetString(1);\n     list.AddRow(firstName + \" \" + lastName);\n}<\/code><\/pre>\n\n\n\n
One thing to notice is that unlike Xojo’s rowset and recordset YOU dont have to remember to say “move to the next row” – and if you’ve ever forgotten that and wondered why your application runs into an infinite loop you’ll appreciate this.<\/p>\n\n\n\n
Reader.Read not only moves to the next row of the returned rows it also returns a boolean value when it succeeds. This way you can move to the next row without having to write any code. Make sure you check out ALL the possible GetXXXXX methods that the reader has – they are extensive. In our simplfusage above we just retrieve, by column position, the strings returned and add that as a single row to the listbox.<\/p>\n\n\n\n
As a good citizen we should ALWAYS dispose of the objects we created.<\/p>\n\n\n\n
  \/\/ clean up\nreader.Dispose();\ndbcmd.Dispose();\nsqlite_conn.Close();<\/code><\/pre>\n\n\n\n
And – were done !
<\/p>\n\n\n\n
Note there are things I have not covered <\/p>\n\n\n\n