dotConnect for PostgreSQL Documentation
Devart.Data.PostgreSql Namespace / PgSqlScript Class
Members Example

PgSqlScript Class
Serves to execute series of SQL statements separated by special symbols.
Syntax
'Declaration
 
Public Class PgSqlScript 
   Inherits Devart.Common.DbScript
   Implements System.ComponentModel.IComponentSystem.IDisposable 
 
Remarks

Often it is necessary to execute several SQL statements one by one. It can be performed by using a lot of components such as PgSqlCommand. Usually it isn't a good solution. With only one PgSqlScript component you can execute several SQL statements as one. This sequence of statements is named script. To separate individual statements use semicolon (;) symbol.

When PgSqlScript encounters a BEGIN keyword in the script, it looks for a slash symbol "/" in the first position of some consecutive line. Everything between the BEGIN and the slash is considered single block. Usually the slash is placed after the line containing END keyword. You do not have to place slash after nested BEGIN...END block.

Example
This sample demonstrates how to execute script and retrieve information about execution flow using Progress and Error events.
[STAThread]
static void Main(string[] args)
{
string script =

  "INSERT INTO DEPT VALUES (10,'ACCOUNTING','NEW YORK');"+
  "INSERT INTO DEPT VALUES (20,'RESEARCH','DALLAS');"+
  "INSERT INTO DEPT VALUES (30,'SALES','CHICAGO');"+
  "INSERT INTO DEPT VALUES (40,'OPERATIONS','BOSTON');"+
  "SELECT * FROM DEPT";
      PgSqlConnection pgConn = new PgSqlConnection(
          "host=server;database=test;user id=postgres;");
      PgSqlScript pgScript = new PgSqlScript(script,pgConn);
      pgScript.Progress += new Devart.Common.ScriptProgressEventHandler(OnProgress);
      pgScript.Error += new Devart.Common.ScriptErrorEventHandler(OnError);
      pgConn.Open();
      pgScript.Execute();
      pgConn.Close();
    }

static void OnProgress(object sender, Devart.Common.ScriptProgressEventArgs e)
{
  Console.WriteLine(e.Text);
  Console.WriteLine("  Successfully executed.");
}

static void OnError(object sender, Devart.Common.ScriptErrorEventArgs e)
{
  e.Ignore = true;
  Console.WriteLine(e.Text);
  Console.WriteLine("  Failed.");
}
Module Module1

  Friend WithEvents pgScript As Devart.Data.PostgreSql.PgSqlScript

  Sub Main()
    Dim script As String = _

  "INSERT INTO DEPT VALUES (10,'ACCOUNTING','NEW YORK');" + _
  "INSERT INTO DEPT VALUES (20,'RESEARCH','DALLAS');" + _
  "INSERT INTO DEPT VALUES (30,'SALES','CHICAGO');" + _
  "INSERT INTO DEPT VALUES (40,'OPERATIONS','BOSTON');" + _
  "SELECT * FROM DEPT"
    Dim pgConn As PgSqlConnection = New PgSqlConnection( _
        "host=server;database=test;user id=postgres;")
    pgScript = New PgSqlScript(script, pgConn)
    pgConn.Open()
    pgScript.Execute()
    pgConn.Close()
    Console.ReadLine()
  End Sub

  Sub OnProgress(ByVal sender As Object, ByVal e As Devart.Common.ScriptProgressEventArgs) Handles pgScript.Progress
    Console.WriteLine(e.Text)
    Console.WriteLine("  Successfully executed.")
  End Sub

  Sub OnError(ByVal sender As Object, ByVal e As Devart.Common.ScriptErrorEventArgs) Handles pgScript.Error
    e.Ignore = True
    Console.WriteLine(e.Text)
    Console.WriteLine("  Failed.")
  End Sub

End Module
Inheritance Hierarchy

System.Object
   System.MarshalByRefObject
      System.ComponentModel.Component
         Devart.Common.DbScript
            Devart.Data.PostgreSql.PgSqlScript

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also