Chat now with support
Chat with Support

Toad Edge 2.0.9 - User Guide

Creating Build Steps - Other Systems

In case you are not using Jenkins, you can still take advantage of Toad Edge CI/CD build steps as long as your system is able to execute batch files/shell scripts.

This example illustrates how to create a Create Snapshot build step and use it in TeamCity.

To create a new build step in TeamCity using Toad Edge CI/CD Wizard

  1. In Toad Edge, click the CI/CD (Continuous Integration and Delivery) button on main toolbar to open the CI/CD Wizard


  2. Select Create Snapshot from the available builds
  3. Configure the path to toadedge.jar (obtained from here). The exported batch/shell script will use this path to look for the jar file, so enter the path relative to the path of the script (Export Path in the last dialog).
    • We choose to set Export Path to N:\TeamCity\working_directory
    • The toadedge.jar file will be located in N:\TeamCity\working_directory\jars
    • Therefore, the toadedge.jar file path will be .\jars (relative) or N:\TeamCity\working_directory\jars (absolute)
  4. In the next dialog, select the Connection and Database that you would like to take a snapshot of
    • The connection is exported as an XML file. If we choose to place it in a different folder than the exported script, we have to modify the Connection File Name path in the same way as in step 3
  5. You can also change the Output file name and path (relative to the Export Path)
  6. In the final dialog, configure the Export Path first. This is the destination folder for the exported script and other files
  7. Now change the Command File Name if you wish. The suffix of the file name determines whether the file will be a batch file (.bat) or a shell script (.sh)

    • Since we are running TeamCity on Windows, it is better to use batch script format. On Linux, shell script would be a better choice

The rest of the configuration is done in TeamCity. This guide assumes that you have already created a Project and a Build Configuration.

  1. In TeamCity web UI, locate your Project and a Build Configuration to which you would like to add a new build step

  2. Open the Build Configuration and select Build Steps from the left menu
  3. Click the Add build step button
  4. From the Runner type dropdown menu, select Command Line
  5. The fields that you now need to configure are:
    • Working directory (you might need to click Show advanced settings) - this is the directory where TeamCity will look for and execute the batch/shell script (in our case, same as Export Path in CI/CD Wizard)
    • Run - select Executable with parameters
    • Command executable - enter the name of the script here (with or without the suffix)

  6. Once you are done with the configuration, Save the changes
  7. Run the Build Configuration to see if everything is configured correctly. If the build step is executed successfully, you should see the newly generated snapshot in the script folder

CI/CD Wizard

Continuous Integration and Delivery Wizard

The CI/CD Wizard guides you through the process of creating and customizing various build steps. It saves you the hassle of having to manually write a script with appropriate arguments to use with the Toad Edge® command line interface.

The generated script can be viewed at any time in the wizard by clicking the Command Preview button.

The following table lists all currently available build steps and files/configuration required to export them.

Build Step Requirements Description
Empty database
  • Database connection file (XML)

Executes a query that drops all objects in the selected database

Create snapshot
  • Database connection (XML file)

Stores the structure (not data) of the selected database as a JSON file. The Snapshotscan be used as a backup

Create baseline
  • Database connection (XML file)

Stores the structure (not data) of the selected database as a JSON file. This snapshot can be used as a backup or as a baseline for the Compare database with baseline build step

Generate create SQL script

One of the following:

  • Database connection (XML file)
  • Repository (folder structure)
  • Snapshot (JSON file)

Generates a create SQL script from a repository, saved snapshot or a database. The script can be used to recreate the structure of the source (not data)

Generate change SQL script
  • Schema Compare result (folder with JSON files)

Generates a change SQL script to deploy changes to the Schema Compare target based on differences found in the previously executed Compare database schemas build step

Compare database schemas
  • Recent Schema Compare
  • Saved Schema Compare (.compare file)

Or two of the following:

  • Database connection (XML file)
  • Repository (folder structure)
  • Snapshot (JSON file)

Compares two different schemas (from databases, repositories or snapshots). The results are stored in a folder that can be used as an input for other build steps

Compare database with baseline

One of the following:

  • Database connection (XML file)
  • Repository (folder structure)
  • Snapshot (JSON file)

And also a baseline snapshot (JSON file)

Compares the given database with the given baseline snapshot. In case any differences are found, an error is raised and the build step will fail

Deploy SQL script
  • Database connection (XML file)
  • Input SQL file

Executes any SQL script on a selected database

Generate HTML comparison report
  • Schema Compare result (folder with JSON files)

Generates an HTML report based on the results of the previously executed Compare database schemas build step

 

Toad Edge Command Line Interface

Toad Edge® command line interface

IMPORTANT: To execute build steps correctly, Toad Edge requires a 64-bit installation of Java Development Kit (JDK), however, 32-bit Java is usually used by default. It is therefore necessary to create a JAVA_HOME system variable pointing at 64-bit JDK directory. Please do the following steps to perform the configuration:

  1. Right-click This PC and select Properties | Advanced System Settings | Environment Variables
  2. Click New in System Variables
  3. In the Variable Name field, enter JAVA_HOME
  4. In the Variable Value field, enter your JDK installation path, e.g. C:\Progra~1\Java\jdk1.8.0_65

The core Continuous Integration and Delivery (CI/CD) functionality in Toad Edge is provided by its command line interface (CLI). Although the best way to use it is to use the CI/CD Wizard, you can also work with it manually.

To use Toad Edge CLI manually

  1. Download a zip archive containing Toad Edge JAR file and other libraries from here
  2. Extract the archive
  3. Launch the command line utility (Windows) or the terminal (Linux) and navigate to the folder with the JAR file
  4. Execute the JAR file with Java command and additional arguments

Every usable command begins with java -jar toadedge.jar followed by the operation you want to perform and additional arguments.

The available operation arguments correspond to the build steps available in the CI/CD Wizard:

  • -compare
  • -report
  • -sql_change
  • -sql_create
  • -deploy
  • -snapshot
  • -baseline

The operation argument has to be followed by other arguments specifying input, output, settings, etc. To learn which arguments you need to use to perform a specific operation, add the -help argument at the end of your command.

Once you supply all the necessary arguments, you can start performing CI/CD actions without having to launch Toad Edge itself.

Preferences

Many aspects of Toad Edge and its behavior can be configured in the Preferences.

To open Preferences

  • On Windows: Select View | Preferences or press ALT + P
  • On macOS: Select Toad Edge | Preferences or press ⌥ + P or ⌘ + ,

The settings are divided into several categories:

General

Startup Options
Option Description
Restore active connections If enabled, database connections that were active before exiting the application will be reconnected again on startup
Verify drivers existence on application start If enabled, automatically check whether the drivers listed in the Database tab actually exist
Play Toad wave on application start By default, Toad Edge plays a toad sound when it is launched. Uncheck this box to disable the sound
Dialogs and Wizards
Option Description
Use quotation marks in SQL output This option concerns mostly new database object wizards. If enabled, names of database objects created via these wizards will be quoted if necessary (e.g. when the name uses both uppercase and lowercase letters or if it contains special characters)
Show warning when connecting to unsupported database In Toad Edge you might be able to connect to databases that are not fully supported and some features might be missing. Check to display a warning message when you are connecting to a database that is not supported.
User Interface
Option Description
Number of connections in application toolbar Determines the number of connections that appear in the Connect button drop down menu in the application toolbar. If you have more connections than the number set here, they will be shown in the order in which they were last used or modified
Show database object count in Object Explorer If enabled, the number of objects of each type is shown next to the object node in the Object Explorer
Format script on load This option automatically formats SQL scripts in Object Detail | Script tab and also whenever you export a script to Worksheet
Confirm before closing Toad Edge If enabled, a prompt is displayed when you attempt to close the application

Connection Parameters

Option Description
Maximum number of sessions Enter the maximum number of concurrent sessions per connection. Enter a value from 1 to 99. With AutoCommit turned off only one session is open.

Database

Option Description
platform Each tab lists available drivers for each of the database platforms
Timeout Settings
Option Description
Database connection timeout in seconds Sets the timeout for database connections. If Toad Edge is unable to establish connection to a database within the timeout period, the connection will fail automatically
Query execution timeout in seconds Sets the timeout for query execution. If the database is unable to execute a query within the timeout period, it will fail automatically
Worksheet
SQL Worksheet
Option Description
Enable Syntax Highlighting Highlights SQL keywords, database objects and aliases by default
Enable Syntax Check By default, checks the syntax of SQL code in Worksheetand underlines errors
Hide results when typing If enabled, automatically hides Result when you start typing in Worksheet
Vertical layout of result set If enabled, vertical layout of Result Set is used by default. Otherwise, horizontal layout is used
Show line numbers Shows/hides line numbers in Worksheet
Show range indicator If enabled, highlights SQL statement line ranges (e.g. lines 9-13) in the vertical bar on the left side of the Worksheet
Content Assist / Autocompletion
Option Description
Enable Content Assist Enables/disables Content Assist entirely
Activate automatically By default, Content Assist is automatically activated when you type a specific character and wait for a set amount of time. You can disable this option and instead activate the tool manually by pressing (CTRL (⌘) + SPACE)
Delay in milliseconds This determines the delay between typing a Content Assist trigger character and the suggestion popup appearing
Content Assist trigger characters Specifies which characters can be used to activate Content Assist. Once you type any of them and wait for a set amount of time, the suggestion popup will appear
Sorting and Filtering Determines how the suggestions will be sorted
Alias Handling Enables/disables the use of aliases when using Content Assist to autocomplete your queries

Data

Data Grid Options
Option Description
Display {null} for NULL values If enabled, NULL values are represented by the {null} string. Otherwise, blank cells are shown instead
Show tooltips over results By default, tooltips are displayed when you hover over data values that have been truncated due to the small column width
Show web links preview You can enable this option to view website previews when you hover over data values that contain a website address
Use fetch limit The fetch limit determines how many rows should be fetched from a table at once. If you disable this option, Toad Edge will fetch all rows at once. This might hinder Toad Edge performance depending on the size of the tables fetched
Number of fetched rows If the fetch limit is enabled, this option determines how many rows should be fetched from a table. Once you scroll past the fetched rows, another set of rows is fetched
Data Manipulation
Option Description
Confirm any DROP, REVOKE and TRUNCATE actions If enabled, you will be prompted before performing some actions using Toad Edge such as dropping objects, truncating tables or revoking permissions. Note that you will not receive a prompt when you try to perform the above actions using a SQL query in Worksheet
Confirm record deletion If enabled, you will be prompted every time you try to delete rows from a table in Object Detail
Trim leading spaces when editing string data Removes spaces in front of the string values you insert into your table when you edit its values directly (in Object Detail or Result Set)
Trim trailing spaces when editing string data Removes trailing spaces in the string values you insert into your table when you edit its values directly (in Object Detail or Result Set)
Date and Time Data Format
Option Description
Date format Determines the format of Date and Datetime types
Time format Determines the format of Time and Datetime types
Numeric Data Format
Option Description
Decimal symbols Sets the symbol used to separate integers and decimals in number data types
Digit grouping symbol Sets the symbol used to separate thousands in number data types
No. of digits after decimal Determines how many decimal digits are shown for Decimal type values. The actual maximum number of decimals is always limited by the scale of the specific decimal type column
JSON Data Settings
Option Description
Number of records used for JSON schema recognition Values in JSON data type column can have a varying number of different columns. Toad Edge analyzes the first X number of records and generates the column structure in Object Explorer based on the columns of these records. The number of analyzed records can be changed here. See JSON support and JSON Editor for more information
Max number of keys in the same level Determines how many key of the same depth level will be displayed in JSON column structure in Object Explorer
Max number of levels Determines how many nested levels will be displays in JSON column structure in Object Explorer
Load keys on demand If enabled, the records used to model JSON column structure in Object Explorer will be loaded only when you expand the JSON column node
BLOB Viewers
Option Description
File Viewers In this section you can configure which viewer should be used to open BLOBs (binary large objects) of specific formats:
  • Default - if possible, BLOBs are opened in an internal Eclipse editor. If not, default system application is used instead
  • System - BLOBs are opened in default system application associated with the specific file format
  • Text - BLOBs are opened in a plain text editor

Templates

This section allows you to define and customize your own code templates. See Templates for more information.

Export

Option Description
Open file after execution Determines whether exported XML and HTML files should be automatically opened after the export is completed
XML
Option Description
Encoding Sets the default encoding for exported XML files
Naming
Option Description
Name of the root tag Determines the name of the tag that should be used in XML to indicate the start and the end of the entire row/record section
Name of the row tag Determines the name of the tag that should be used in XML to indicate the start and the end of a single row/record
Options
Option Description
Trim string values Removes leading and trailing spaced from exported string values if enabled
Include null fields If enabled, null values are listed in exported XML files as {null}
Indent size Determines the indentation size of tags in exported XML files
CDATA export selection Here you can configure which data type values should be enclosed in character data (CDATA) tag
HTML
Option Description
CSS Style You can choose the CSS style applied to exported HTML files here

Folder Paths

Option Description
Document path This path is used as a default for many file related operations in Toad Edge such as exporting/importing and saving/loading files
Repository mapping mask The default file path used when creating a repository. See Repository for more information

Appearance

This sections contains settings related to colors and fonts used in the application. For example, you can change syntax highlighting colors, Worksheet fonts or background colors of certain UI elements.

Feedback

Option Description
Error Reporting Toad Edge can detect unexpected termination and then send an anonymous error log to the application developers. The specific settings can be configure here
Related Documents