Chat now with support
Chat with Support

Toad for DB2 6.3 - Installation Guide

Configure Version Control

About Version Control

Toad integrates with your existing version control system so you can maintain multiple revisions of objects and SQL scripts . See Configure Version Control for Objects for more information on configuring version control in Toad.

For Version Control of your files handled by Toad see Version Control for Toad Files.

Important: See Troubleshoot Version Control for more information about issues when upgrading version control from a previous version.

Notes: 

  • If you want to place database objects under version control, you must configure version control for objects using the Object Explorer. Once configured, you can manage SQL scripts there. The main advantage of managing scripts in the Object Explorer is that you can easily share them with team members who have version control configured. See Manage Objects under Version Control for more information.
  • If you rename a version controlled object, Toad drops the original object and its history from version control and prompts you to add the renamed object to version control. This newly renamed object does not have any history associated with it.
  • Currently, CLR objects are not supported by version control.

Prerequisites

You must install a supported version control client on the computer where Toad is installed. The following table lists the supported version control providers and the versions tested with Toad.

Supported Provider Server Version Tested Client Version Tested

Apache Subversion™

 

Subversion 1.7.5 on Windows

CollabNet Subversion Command-Line Client 1.7.5

Note: Any Subversion client must have svn.exe in its installation directory to use version control in Toad.

Git Toad works only with the local repository. For commands such as clone, pull and push use an external tool.

Team Foundation Server (TFS)

TFS 2008, 2010, 2012, 2013

Visual Studio® (2008, 2010, 2012, 2013) Team Explorer Client

 

File system based Toad allows to utilize practically any version control system using the external client tool. In this case Toad Version Control tool works with the directories at local HDD while you commit changes to the repository with version control client tool.

Note: Toad connects to your version control system based on login information included in the configuration. Your version control client does not need to run for Toad to connect.

The following objects can be added to Version Control:

ALIAS

DISTINCT TYPE

INDEX

MQ TABLE

SCHEMA

SEQUENCE

TABLE

TRIGGER

USER

VIEW

FUNCTION

PROCEDURE

SCRIPT

Details of Team Foundation Server support:

Visual Studio/Team Explorer version TFS 2013 support notes TFS 2012 support notes TFS 2010 support notes
Visual Studio 2015 Supported (RTM or latest update) Supported (RTM or latest update) Supported (RTM or latest update)
Visual Studio/Team Explorer 2013 Supported (RTM or latest update) Supported (RTM or latest update) Supported (RTM or latest update)
Visual Studio/Team Explorer 2012 Requires latest Visual Studio 2012 update. Supports Git with Visual Studio Tools for Git extension Supported (RTM or latest update). Supports Git with Visual Studio Tools for Git extension Supported (RTM or latest update). Supports Git with Visual Studio Tools for Git extension

Note: Additional functionality and compatibility with older clients is possible but out of scope of what we are able to test.

File Version Control

Toad can integrate with your existing version control system allowing you to maintain multiple versions of Toad files. After you integrate Toad with your version control system, you can perform version control tasks directly from within Toad, such as commit file changes and retrieve revisions.

Toad supports the following version control systems for managing Toad files:

  • Apache Subversion™—Toad has been tested with Subversion 1.7.5 and 1.8.

The following types of files can be managed using version control from within Toad: Editor (.tef, .sql, .txt), Query Builder (.tsm), ER Diagram (.ter), and Automation (.tas).

Toad supports version control for database objects, as well as files. Version control for objects is configured separately from version control for files. For more information about version control for objects, see Configure Version Control for Objects.

To configure version control for Toad files

  1. Ensure that an Apache Subversion client is installed on the same computer as Toad.
  2. In Toad, open one of the supported file types. Then right-click the document window tab and select File Version Control | Version Control Wizard. This action opens the Version Control Wizard which allows you to configure Toad for your version control system.

    Note: Even if you previously configured version control for objects, you must run the Version Control Wizard again to configure version control for files.

  3. Use the wizard to provide information about your version control system to Toad. Review the following for additional information:

    Field/Button  
    Version Control System Page  

    Type

    Select Subversion.

    Properties

    Click the Properties button and enter the path to the Subversion executable (svn.exe) on the client computer. For example, if using TortoiseSVN, the path might be:

    C:\Program Files\TortoiseSVN\bin

    Note: Do not include svn.exe in the path.

    Server

    Enter the URL for the Subversion repository on the Subversion server.

    Login and Password

    Enter the user name and password for your Subversion account.
    Default Version Control Settings Page  

    Version Control Folder

    Select the folder on the Subversion server where you want to check in files.

    If you currently have files under version control, select the folder on the server where these files are located.

    Working Folder

    Select a folder on the client computer to use as the root working folder. This is the location into which you will check out files.

    If you currently have files under version control, select your existing working folder.

To add a file to version control

  1. After configuring version control for files, you can start adding files to version control from within Toad. Right-click a document window tab and select File Version Control | Add file to working folder.
  2. Select a location in your working folder in which to save the file. Click Save.
  3. In the Commit dialog, enter a comment and click OK to add the file to version control.

To browse the repository

  1. Right-click the document window tab (of one of the supported file types) and select File Version Control | Repository Browser.
  2. In the Repository Browser you can right-click a file to perform one of the following actions. Available actions depend on the file's status.

    Action Description
    Open Open the file in Toad.
    Commit Commit your changes. Available for Modified or Untracked files.
    Undo Changes Discards your changes and reverts to the previous revision of the file (previous commit). Available when the file status is Modified.
    Get Latest Version Check out the latest revision from the remote repository. Available when the file status is OutOfDate.

To commit your changes

  • After modifying a file, right-click the document window tab and select File Version Control | Commit.

To compare revisions (Editor files only)

  • After modifying and saving an Editor file, you might want to compare your changes to the remote copy (last commit) before committing your changes. Right-click the document tab and select File Version Control | Diff with latest revision.
  • You can compare two revisions of an Editor file (.tef, .sql, or .txt) by using the History dialog.
    1. To open a file's History dialog, right-click the document tab and select File Version Control | Show history.
    2. Select two revisions to compare. Then right-click the revisions and select Compare revisions.
    3. For an OutOfDate file, right-click the latest revision in the History dialog and select Compare with working copy to compare the remote file to your working copy.

To check file status

  • The status of a currently open file displays in the status bar of the document window. You can also place the cursor over the document tab to display status.
  • You can check the status of one or more files by using the Repository Browser. To update file status in the Repository Browser, right-click a folder and select Update folder.
  • Review the following file status definitions.

    File Status Definition
    Untracked The file has not been added to version control. Right-click the file in the Repository Browser and select Commit to add it to version control.
    UpToDate The file in your working folder is synchronized with the file in the remote repository. No changes are detected. No action is required.
    Modified The working copy of this file was modified. The changes are stored in the working folder only. Commit this file to add the changes to the remote repository.
    OutOfDate A more recent revision of this file exists in the remote repository. To update your working copy, check out the latest revision from the remote repository (right-click the file and select Get Latest Version).
    Unknown The file is under version control, but its status cannot be determined.
    Deleted The file was under version control, but it was dropped or renamed in the working folder and exists only in the remote repository.

Additional Actions

  • To open the folder where a file is located, open the file and then right-click the document tab and select File Version Control | Open in Windows Explorer.

 

Configure Version Control

To configure version control for files, see Version Control for Toad Files.

To configure version control for Objects

  1. Ensure that a supported version control client is installed on the computer where Toad is installed. See About Version Control for more information about tested version control clients and supported versions.

  2. Right-click one or more objects in the Object Explorer and select Version Control | Version Control Wizard.

    Note: Version control is configured for entire LUW database or z/OS subsystem.

  3. Review the following for additional information:

    Version Control System Page

    Description

    Type

    Select the version control system name:

    • Apache Subversion™

      Note: The version number beside Subversion is an internal file definition used by Toad to check if an update for this file is available. It is not the actual version number for the version control provider.

    • Git
    • Team Foundation Server

      Note: If you select TFS, you must specify the workspace name for the provider in the Team Foundation Server Properties window that displays.

    • File system based

    Properties

    (Subversion only) Click this button (beside the Type field) and complete the binary path. Enter the path where the Subversion client that contains svn.exe is installed. For example, if you installed the CollabNet Subversion Client, you would enter:

    C:\Program Files\CollabNet Subversion Client

    Note: Do not include svn.exe in the path.

    Server

    Select one of the following:

    • Subversion—Specify the existing working folder for the version control repository or specify the server string (for example: svn://MyServer).
    • TFS—Specify the server where your version control provider is installed and the port number (default is 8080) to use in the following format:

      • http://MyServer:Port for TSF 2008

      • http://MyServer:Port/TFS for TFS 2010, 2012

    • File System Based—Specify a directory at your local machine.
    Repository Settings

    Set your local Working Folder and your Version Control Folder will be automatically filled.

    User name/ Password

    Enter your Subversion command-line user name and password and click Login.

    Note: For TFS only, if you leave the user name and password fields blank, Toad uses your default Windows credentials.

    Version Control General Options Page Description
    Prompt to Commit on Close You will be asked to commit your changes before each version controlled file is closed
    Store Grant Statements with DDL

    Grant statements will be stored and tracked along with DDL script

    Note: IBM DB2 only

    Version Control Configurations Options Page

    Description

    Version control folder

    Select the folder on the version control server where you want to check objects and scripts in.

    If you already have objects or scripts under version control, select the folder on the server where these objects or scripts are located.

    Note: Version control automatically checks out objects or scripts in this folder and any subfolders to the location you specify in the Working folder field.

    Working folder

    Select the root repository folder on the client computer to use as the default working folder for checking objects and SQL scripts out. If you already have objects or SQL scripts under version control, select the existing working folder for these.
  4. Manage object and scripts using Version Control. See Manage Objects under Version Control for more information.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating