Skip Navigation LinksHome > Products > SQL Auditor > SSW SQL Auditor - User Guide
SSW SQL Auditor > User Guide

SSW SQL Auditor
Keep your SQL Server database free from design flaws with SSW SQL Auditor.

Maintaining quality code across a large team is difficult. Even when standards are in place developers can make mistakes that will slip through Quality Assurance. SSW SQL Auditor, built in VB .NET, allows a developer to set SQL Server design rules and then check the database for code or design elements that ignores those rules.

SQL Auditor User Guide
1. Prerequisites
2. Running SQL Auditor
3. Clustered Index Wizard
4. Relationships Script Wizard
5. Timestamp Script Wizard
6. Validate Foreign Key columns with Script Wizard

  1. Prerequisites

    1. To install, view the Installation User Guide
    2. To register, view the Registration User Guide

  2. Running SQL Auditor

    1. Run SSW SQL Auditor

      Welcome

       

    2. Choose a data source.

      • Enter the connection string to your database.
      • The build button provides a screen to select the server and database to use.

      DataSource

    3. Process the Database. This step reads the database schema.

      Process Data Base

    4. Select Database Optimization" wizard in the application main menu

    5. Select the rules you'd like to ensure your SQL database complies with

      Rules

    6. Review the summary of violations for each rule by clicking on button in the "Problems" column, or all rules at once by clicking on "Report(All)" button. Clicking on "SQL" button will take you to the screen with automatically generated SQL script to fix rule violations. Clicking on the "Wizard" button will open relevant Wizard that will guide you through a few steps to create an SQL script.

      Rule Violation Summary

    7. Check the report for detail on the rule violations

      Database Optimisation Report

  3. Clustered Index Wizard

    4. This Wizard can help to optimize SQL Server performance by analyzing the data in a table and recommending candidate columns for a clustered index. It will generate a SQL script to add or change the clustered index for the selected column. Details...

    Clustered Index
    Figure: Select table to generate clustered index script.

    Clustered Index
    Figure: Generating a clustered index on a table column.

    Clustered Index
    Figure: Set and review the Options to create clustered index.

    Clustered Index
    Figure: Clustered index script generated by SQL Auditor.

  4. Relationships Wizard

    5. This wizard lets you modify relationships constraints on all tables.

    Relationships
    Figure: Choose your script creation options

    Relationships
    Figure: The auto-generated script

  5. Timestamp Wizard

    6. The timestamp Wizard will add timestamp columns to any or all tables that do not have a timestamp column.

    Timestamp
    Figure: The Timestamp Wizard

    Timestamp
    Figure: SQL Auditor generated script for adding timestamp columns.

  6. Validate Foreign Key columns Wizard

    7. Many SQL Server database programmers use standard naming conventions such as ID in the column name to indicate a relationship with another table. i.e. ClientID. This wizard identifies columns ending with 'ID' which are missing FOREIGN KEY constraints and suggests relationships, where possible.

    Foreign Key
    Figure: The Foreign Key Relationship Wizard.

    Foreign Key
    Figure: Set Foreign Key Columns.