Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
swdev:howto:create_database_using_firebird [2010/10/20 08:55]
smayr
swdev:howto:create_database_using_firebird [2011/02/25 16:17] (current)
smayr [Run an embedded SQL Script against Firebird]
Line 1: Line 1:
 == Create Database Using Firebird == == Create Database Using Firebird ==
- 
 === Patient table === === Patient table ===
 +
 +Supports the following features:
 +  * Generator with Triggers.
 +  * Primary Key.
 +  * Indices.
 +
 <code sql> <code sql>
 /******************************************************************************/ /******************************************************************************/
Line 69: Line 74:
 /******************************************************************************/ /******************************************************************************/
 ALTER TABLE patient ADD CONSTRAINT pk_patient PRIMARY KEY (patientno); ALTER TABLE patient ADD CONSTRAINT pk_patient PRIMARY KEY (patientno);
- 
  
 /******************************************************************************/ /******************************************************************************/
 /*                                  Indices                                   */ /*                                  Indices                                   */
 /******************************************************************************/ /******************************************************************************/
-CREATE INDEX firstnamex ON patient (firstname);+CREATE INDEX firstnamex   ON patient (firstname);
 CREATE INDEX lastfirstnmx ON patient (lastname, firstname); CREATE INDEX lastfirstnmx ON patient (lastname, firstname);
-CREATE INDEX lastnamex ON patient (lastname); +CREATE INDEX lastnamex    ON patient (lastname); 
-CREATE INDEX leftserialx ON patient (leftserial); +CREATE INDEX leftserialx  ON patient (leftserial); 
-CREATE INDEX patientidx ON patient (patientid);+CREATE INDEX patientidx   ON patient (patientid);
 CREATE INDEX rightserialx ON patient (rightserial); CREATE INDEX rightserialx ON patient (rightserial);
  
Line 105: Line 109:
 /******************************************************************************/ /******************************************************************************/
 </code> </code>
- 
 === Fitting table === === Fitting table ===
 <code sql> <code sql>
- 
 /******************************************************************************/ /******************************************************************************/
 /*                 Generated by IBExpert 10/19/2010 16:38:37                  */ /*                 Generated by IBExpert 10/19/2010 16:38:37                  */
 /******************************************************************************/ /******************************************************************************/
- 
 SET NAMES none; SET NAMES none;
- 
- 
  
 /******************************************************************************/ /******************************************************************************/
 /*                                   Tables                                   */ /*                                   Tables                                   */
 /******************************************************************************/ /******************************************************************************/
- 
- 
- 
 CREATE TABLE fitting ( CREATE TABLE fitting (
     patientno           INTEGER NOT NULL,     patientno           INTEGER NOT NULL,
Line 140: Line 136:
     prescriptiontype    SMALLINT DEFAULT 0     prescriptiontype    SMALLINT DEFAULT 0
 ); );
- 
- 
- 
  
 /******************************************************************************/ /******************************************************************************/
 /*                                Primary Keys                                */ /*                                Primary Keys                                */
 /******************************************************************************/ /******************************************************************************/
- 
 ALTER TABLE fitting ADD CONSTRAINT pk_fitting  ALTER TABLE fitting ADD CONSTRAINT pk_fitting 
   PRIMARY KEY (patientno, fittingdate, ear, instrumentid);   PRIMARY KEY (patientno, fittingdate, ear, instrumentid);
- 
  
 /******************************************************************************/ /******************************************************************************/
 /*                                Foreign Keys                                */ /*                                Foreign Keys                                */
 /******************************************************************************/ /******************************************************************************/
- +ALTER TABLE fitting ADD CONSTRAINT fk_fitting_patient  
-ALTER TABLE fitting ADD CONSTRAINT fk_fitting_patient FOREIGN KEY (patientno)  +  FOREIGN KEY (patientno)  
-  REFERENCES patient (patientno) ON DELETE CASCADE ON UPDATE CASCADE; +  REFERENCES patient (patientno)  
 +  ON DELETE CASCADE ON UPDATE CASCADE;
  
 /******************************************************************************/ /******************************************************************************/
Line 164: Line 155:
 /******************************************************************************/ /******************************************************************************/
 </code> </code>
 +
 === Product table === === Product table ===
  
Line 274: Line 266:
 /******************************************************************************/ /******************************************************************************/
 </code> </code>
- 
-=== StylePhotos table === 
- 
-Supports the following features: 
-  * Image data BLOB. 
- 
-<code sql> 
-/******************************************************************************/ 
-/*                 Generated by IBExpert 10/19/2010 16:43:46                  */ 
-/******************************************************************************/ 
-SET NAMES none; 
- 
-/******************************************************************************/ 
-/*                                   Tables                                   */ 
-/******************************************************************************/ 
-CREATE TABLE stylephotos ( 
-    style       INTEGER, 
-    stylephoto  BLOB SUB_TYPE 0 SEGMENT SIZE 80 
-); 
- 
-/******************************************************************************/ 
-/*                                 Privileges                                 */ 
-/******************************************************************************/ 
-</code> 
- 
 === Datalog table === === Datalog table ===
  
Line 341: Line 308:
 /******************************************************************************/ /******************************************************************************/
 </code> </code>
 +
 +
 +=== StylePhotos table ===
 +
 +Supports the following features:
 +  * Image data BLOB.
 +
 +<code sql>
 +/******************************************************************************/
 +/*                 Generated by IBExpert 10/19/2010 16:43:46                  */
 +/******************************************************************************/
 +SET NAMES none;
 +
 +/******************************************************************************/
 +/*                                   Tables                                   */
 +/******************************************************************************/
 +CREATE TABLE stylephotos (
 +    style       INTEGER,
 +    stylephoto  BLOB SUB_TYPE 0 SEGMENT SIZE 80
 +);
 +
 +/******************************************************************************/
 +/*                                 Privileges                                 */
 +/******************************************************************************/
 +</code>
 +
 +== Creating Database Programmatically (C#) ==
 +Source: [[http://codefrenzy.blogspot.com/2005/11/run-embedded-sql-script-against.html|Run an embedded SQL Script agains Firebird]]
 +
 +=== Run an embedded SQL Script against Firebird ===
 +I had an idea that it would be great if my application could automatically create any database that it required.
 +
 +I have in the past attempted to hardcode database construction routines but dislike this approach as it makes the code messy and difficult to maintain. Instead, I favoured the idea of executing a script containing my SQL statements which could be used to construct the database. The application would just simply execute the script, an approach I’ve used in the past with SQL Sever.
 +
 +Whilst investigating further, I found these useful links:
 +
 +  * [[http://www.dotnetfirebird.org/blog/2005/03/using-fbconnectionstringbuilder.html}Using FbConnectionStringBuilder]]
 +  * [[http://www.dotnetfirebird.org/blog/2005/03/batch-sqlddl-execution.html|Batch SQL/DDL Execution]]
 +
 +However, distributing a separate script file would allow a user to change or view the contents of the file.
 +
 +Having experimented with embedded resource files, I thought a similar approach would protect the script from abuse by the average user and only venerable to experienced programmers.
 +
 +I tested various routines and arrived at the following working example:
 +<code csharp>
 +void ButtonRunScriptClick(object sender, System.EventArgs e)
 +{
 +  //specify the database name
 +  string dbName = "test.fdb";
 +  //instantiate a new connection stringbuilder
 +  FbConnectionStringBuilder csb = new FbConnectionStringBuilder();
 +  csb.Database = dbName;
 +  csb.UserID = "SYSDBA";
 +  csb.Password = "masterkey";
 +  csb.ServerType = 1;         //embedded server
 +  //instantiate a connection object
 +  FbConnection con = new FbConnection(csb.ToString());
 +  //check if the database exists
 +  if (System.IO.File.Exists(dbName) == false)
 +  //create the database as it didn’t exist
 +  FbConnection.CreateDatabase(csb.ToString());
 +  //run the script against the current connection
 +  RunScript("Test.Sql", con);
 +}
 +
 +void RunScript(string ScriptName, FbConnection connection)
 +{
 +  //get a reference to the executing assembly
 +  System.Reflection.Assembly assembly = System.Reflection.Assembly.GetExecutingAssembly();
 +  //instantiate a textReader object initialised using a stream to the embedded resource
 +  System.IO.TextReader textReader = new System.IO.StreamReader(assembly.GetManifestResourceStream(ScriptName));
 +  FbScript script = new FbScript(textReader);
 +  //parse the script
 +  script.Parse();
 +  //open the connection
 +  connection.Open();
 +  FbBatchExecution fbe = new FbBatchExecution(connection);
 +  foreach (string cmd in script.Results)
 +  {
 +    //add each sql statement to the batch
 +    fbe.SqlStatements.Add(cmd);
 +  }
 +  //execute the batch
 +  fbe.Execute();
 +  //close the connection
 +  connection.Close();
 +}
 +</code>
 +
 +To test the above code, you will need to do the following:
 +  # Download and install the 'Firebird ADO.Net Provider' from DotNetFirebird
 +  # Once installed, create a new Windows Application and add a reference to your project for the FirebirdSql.Data.Firebird assebly loaded in the GAC.
 +  # Copy & Paste the sample code into your project.
 +  # Add the following Using Directives: <code csharp>
 +using FirebirdSql.Data.Firebird;
 +using FirebirdSql.Data.Firebird.Isql;</code>
 +  # Download 'Embedded Firebird for Windows' from DotNetFirebird and extract ‘fbembed.dll’ and ‘firebird.msg’ from the zip archive. These files should be copied to your applications directory.
 +  # Create a text file named 'Test.Sql' to contain your Firebird SQL script and save it in your project directory. I would suggest including a ''CREATE TABLE'' statement such as: <code sql>
 +CREATE TABLE CLIENTS (
 +  client_id integer not null,
 +  firstname char(20),
 +  lastname char(20),
 +  PRIMARY KEY (client_id)); </code>Note: The filename is case sensitive, if you choose a different filename you will need to amend the sample code to reflect this change.
 +  # Add the file you created in Step 4 to your project and set the build action to Embedded Resource.
 +  # Add a button to your form named buttonRunScript and check that its Click Event is set to the ButtonRunScriptClick Event Handler.
 +
 +Hopefully, when you build the project and click the Run Script button, a file will be created in the applications directory named ''TEST.FDB''.
 +
 +Providing there were no errors during the applications execution the database should have been constructed according to the statements in the SQL script.
 +
 +There are several Database Admin Tools you can use to inspect/update and alter the database, one of which is [[http://www.flamerobin.org|FlameRobin]] which can also be downloaded for free.