DbScript Class

In This Topic

Serves to execute series of SQL statements separated by special symbols.

Syntax

Visual Basic
C#

'Declaration
 
Public MustInherit Class DbScript 
   Inherits System.ComponentModel.Component
   Implements System.ComponentModel.IComponent, System.IDisposable

public abstract class DbScript : System.ComponentModel.Component, System.ComponentModel.IComponent, System.IDisposable

Remarks

Use DbScript to consecutively execute several SQL statements stored in ScriptText property. DbScript allows to execute them all at once or one by one. You can use Progress event to monitor execution flow and Error to catch errors.

There are three ways to execute a script:

- using Execute method;

- using ExecuteNext method;

- using SqlStatement.SqlStatement.Execute method.

For more information refer to corresponding method.

Example

This sample demonstrates how to execute script and retrieve information about execution flow using Progress and Error events.

csharp

[STAThread]
static void Main(string[] args)
{
string script =
  "DROP TABLE DEPT;"+
  "CREATE TABLE DEPT ("+
  "  DEPTNO INT PRIMARY KEY,"+
  "  DNAME VARCHAR(14),"+
  "  LOC VARCHAR(13)"+
  ")WITH OIDS;"+
  "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.");
}

Visual Basic

Module Module1

  Friend WithEvents pgScript As Devart.Data.PostgreSql.PgSqlScript

  Sub Main()
    Dim script As String = _
  "DROP TABLE DEPT;" & _
  "CREATE TABLE DEPT (" & _
  "  DEPTNO INT PRIMARY KEY," & _
  "  DNAME VARCHAR(14)," & _
  "  LOC VARCHAR(13)" & _
  ")WITH OIDS;" & _
  "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

Reference

DbScript Members
Devart.Common Namespace
SqlStatement Class
SqlStatementCollection Class

Send Feedback