dotConnect for SQL Server Documentation
Devart.Common Namespace / DbScript Class
Members Example

In This Topic
    DbScript Class
    In This Topic
    Serves to execute series of SQL statements separated by special symbols.
    Syntax
    'Declaration
     
    Public MustInherit Class DbScript 
       Inherits System.ComponentModel.Component
       Implements System.ComponentModel.IComponentSystem.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.
    [STAThread]
    static void Main(string[] args)
    {
    string script =
      @"if object_id('dept', 'U') is not null
      drop table dept;
    CREATE TABLE Dept(
      DEPTNO int PRIMARY KEY NOT NULL,
      DNAME varchar(14) NULL,
      LOC varchar(13) NULL
    );"+
      "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";
          SqlConnection myConn = new SqlConnection(
              "User Id=sa;Server=localhost;Initial Catalog=Test;");
          SqlScript myScript = new SqlScript(script,myConn);
          myScript.Progress += new Devart.Common.ScriptProgressEventHandler(OnProgress);
          myScript.Error += new Devart.Common.ScriptErrorEventHandler(OnError);
          myConn.Open();
          myScript.Execute();
          myConn.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 myScript As Devart.Data.SqlServer.SqlScript
    
      Sub Main()
        Dim script As String = _
      "if object_id('dept', 'U') is not null" & _
      "  drop table dept;" & _
      "CREATE TABLE Dept(" & _
      "  DEPTNO int PRIMARY KEY NOT NULL," & _
      "  DNAME varchar(14) NULL," & _
      "  LOC varchar(13) NULL" & _
      ");" & _
      "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 myConn As SqlConnection = New SqlConnection( _
            "User Id=sa;Server=localhost;Initial Catalog=Test;")
        myScript = New SqlScript(script, myConn)
        myConn.Open()
        myScript.Execute()
        myConn.Close()
        Console.ReadLine()
      End Sub
    
      Sub OnProgress(ByVal sender As Object, ByVal e As Devart.Common.ScriptProgressEventArgs) Handles myScript.Progress
        Console.WriteLine(e.Text)
        Console.WriteLine("  Successfully executed.")
      End Sub
    
      Sub OnError(ByVal sender As Object, ByVal e As Devart.Common.ScriptErrorEventArgs) Handles myScript.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.SqlServer.SqlScript

    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