sample VB.NET code for sql data compare with backups

RBohannon · January 10, 2008 3:32PM

Hello,

Do you have any sample code for calling SDC 6 from VB when comparing two backup files? The output will be a SQL change script. I'm using VB.NET 2.0 and SQL Server 2005.

Thank you.

richardjm · January 11, 2008 3:38AM

You're in luck, we're just about to release 6.1 of SQL Data Compare and we've updated the code samples to give you code to do this sort of thing...

You will need a few extra references in your project...

.NET dependencies

RedGate.BackupReader.BackupReader.dll &#40;needed to compare against any database backup file&#41;
RedGate.BackupReader.SqbReader.dll &#40;if you intend to compare against SQL Backup files&#41;
RedGate.SQLCompare.ASTParser.dll &#40;a new component of the SQL Compare engine - necessary&#41;
RedGate.SQLCompare.Rewriter.dll &#40;another new component of the SQL Compare engine - necessary&#41;
RedGate.SQLCompare.BackupReader.dll &#40;needed to compare against any database backup file&#41;
System.Data.SQLite.dll &#40;needed for comparison to any database backup file&#41;

Non .NET dependencies

RedGate.BackupReader.CryptoHelper.dll &#40;only needed to compare against Encrypted SQL Backup files&#41;
rglz.dll &#40;needed for SQL Backup Compression level 1 &#40;or compressed temporary files - 6.1 only&#41;&#41;
zlib1.dll &#40;needed for SQL Backup Compression levels 2 & 3&#41;

And here's the example code I've written, the only real difference between comparing to a live database and a backup database is the method of registration - apart from that they can be used the same ( except of course synchronizing to a backup

).

Option Explicit On

Imports RedGate.SQLCompare.BackupReader
Imports RedGate.SQLCompare.Engine
Imports RedGate.SQLDataCompare.Engine
Imports RedGate.SQLDataCompare.Engine.ResultsStore
Imports RedGate.SQL.Shared

Public Class BackupComparisonExample
    Sub RunExample&#40;&#41;
        Dim session As New ComparisonSession

        'register the databases for comparison
        Dim backupDB As New BackupDatabase
        Dim liveDB As New Database

        Try
            ' First register the backup file
            Console.WriteLine&#40;"Registering backup"&#41;
            backupDB.Status = New StatusEventHandler&#40;AddressOf StatusCallback&#41;
            backupDB.RegisterForDataCompare&#40;New String&#40;&#41; &#123;"c:\\widgetdev.bak"&#125;, Nothing&#41;

            ' Secondly register the live database
            Console.WriteLine&#40;"Registering live database"&#41;
            liveDB.Status = New StatusEventHandler&#40;AddressOf StatusCallback&#41;
            liveDB.RegisterForDataCompare&#40;New ConnectionProperties&#40;".", "WidgetLive"&#41;, Options.Default&#41;


            Dim mappings As New SchemaMappings
            mappings.CreateMappings&#40;backupDB, liveDB&#41;

            'compare the databases
            session.CompareDatabases&#40;backupDB, liveDB, mappings&#41;

            Dim mapping As TableMapping

            For Each mapping In mappings.TableMappings
                Dim table As ViewTableSuperClass = mapping.Obj1
                Dim difference As TableDifference = session.TableDifferences&#40;table.FullyQualifiedName&#41;

                ' Any tables that couldn't be compared we don't output the results
                If difference Is Nothing Then
                    Continue For
                End If

                Dim row As Row
                For Each row In difference.ResultsStore  'loop through all the rows

                    If &#40;row.Type &lt;&gt; row.RowType.Same&#41; Then 'go through the non same records
                        Dim field As FieldPair
                        Dim i As Int32 = 0
                        Console.WriteLine&#40;"&#123;0&#125; Row &#123;1&#125; type &#123;2&#125;", table.FullyQualifiedName, row.Index, row.Type.ToString&#40;&#41;&#41;
                        For Each field In difference.ResultsStore.Fields
                            'work out where about in the results the field data is stored
                            'if we were comparing identical records, or records present in one
                            'database but not the other then we would not need to 
                            'use the OrdinalInResults1 and OrdinalInResults2 properties
                            'but just OrdinalInResults
                            Dim field1 As Int32 = field.OrdinalInResults1
                            Dim field2 As Int32 = field.OrdinalInResults2

                            If &#40;field1 &lt;&gt; field2&#41; Then
                                'get the values
                                Dim value1 As Object = row.Values&#40;field1&#41;
                                Dim value2 As Object = row.Values&#40;field2&#41;
                                If &#40;value1 Is Nothing&#41; Then
                                    value1 = "NULL"
                                End If
                                If &#40;value2 Is Nothing&#41; Then
                                    value2 = "NULL"
                                End If
                                If row.FieldDifferent&#40;i&#41; Then
                                    Console.WriteLine&#40;"&#123;0&#125;:&#123;1&#125; &lt;&gt; &#123;2&#125;", field.Field&#40;False&#41;.Name, value1.ToString&#40;&#41;, value2.ToString&#40;&#41;&#41;
                                Else
                                    Console.WriteLine&#40;"&#123;0&#125;:&#123;1&#125; == &#123;2&#125;", field.Field&#40;False&#41;.Name, value1.ToString&#40;&#41;, value2.ToString&#40;&#41;&#41;
                                End If
                            Else
                                'this is part of the unique index we are comparing on
                                Dim value As Object = row.Values&#40;field1&#41;
                                Console.WriteLine&#40;"*&#123;0&#125;:&#123;1&#125;", field.Field&#40;False&#41;.Name, value.ToString&#40;&#41;&#41;
                            End If
                            i += 1
                        Next
                    End If
                Next
            Next
        Finally
            'dispose of the objects
            session.Dispose&#40;&#41;
            backupDB.Dispose&#40;&#41;
            liveDB.Dispose&#40;&#41;
        End Try
    End Sub

    Sub StatusCallback&#40;ByVal sender As Object, ByVal e As StatusEventArgs&#41;

        If Not &#40;e.Message Is Nothing&#41; Then
            Console.WriteLine&#40;e.Message&#41;
        End If

        If e.Percentage &lt;&gt; -1 Then
            Console.WriteLine&#40;"&#123;0&#125;%", e.Percentage&#41;
        End If
    End Sub
End Class

RBohannon · January 11, 2008 9:59AM

Thanks. Your code snippet will work with 6.0, right? I'd like to put this code into production next week.

When is 6.1 coming out?

richardjm · January 11, 2008 10:07AM

Should do the API is compatible. We're aiming for 6.1 to be out in the next few weeks just fixing a few issues on it and doing final testing.

RBohannon · January 11, 2008 10:16AM

Great. I'll integrate your code into my program today and let you know how it goes. Thanks for the help.

If I have issues in the future, does Redgate have a public code library where I can find sample code? I couldn't find one.

richardjm · January 11, 2008 10:43AM

We have mainly this forum you're looking at and the API documentation. There's also a zip file containing toolkit samples which you can download via the support area of the website.

Also I forgot another dll (Rob has just berated me for being forgetful)

zlib1.dll &#40;not .NET, needed for SQL Backup Compression levels 2 & 3&#41;

I've updated the dlls in the post above (SQLite.dll *is* .NET) - D'Oh)

- Got that Friday feeling.

elizas · March 17, 2010 6:25AM

Using the SQL SMO object we can easily take backup of SQL database through code.

http://www.mindfiresolutions.com/Backup-SQL-Database-Through-Code-In-VBNET-846.php

sample VB.NET code for sql data compare with backups

Comments

Product Learning

Community Forums

Events & Friends

Simple Talk