SQL Editor

Introduction

One of the DbSchema embedded tools is the SQL Editor. The editor opens inside the layout, is saved in the model file and can be reopened from the menu.

Auto-Complete

The editor is auto-complete enabled. Just type CTRL + SPACE to get the complete pop-up.
SQL editor auto-completion

Commit and Rollback

Database operations like UPDATE, INSERT, DELETE, and sometimes CREATE TABLE requires COMMIT to become effective in the database. Alternatively, press ROLLBACK to cancel them.
DML data changes require commit or rollback

Execute Single Query or Scripts

The editor menu has two distinct buttons, for executing a query or for executing SQL scripts.
  • Executing a query will execute the selected text or the statement at the caret position ( ending with ; )
  • Executing a query will show the result as a table
  • Executing the script will show the result as plain text. Multiple results will show together in the same pane.
  • The Run Script menu option is a combo with options for ignoring errors and auto-commit. If the ignore-errors option is disabled, the SQL Editor will stop by errors.
How to run a script from the SQL Editor

Edit Data in the Result Pane

For most of the databases, you can edit the data directly in the result pane. Double-click any of the result cells to edit.
How to edit data in the SQL editor result pane

Save result data to file

From the result pane, you can choose the save button to save the result directly to file. This will execute the query one more time and will save the complete content to file.
This option can be very useful when the result is large and cannot be loaded on the screen.
How to save query execution result to file

Execute Groovy Scripts

The SQL editor can be used as well for running Groovy scripts. In the editor menu, there is an option to switch from SQL to Groovy. Groovy is a Java-based scripting language. In the Help menu, there is a Code Samples where you can learn it.

Here a simple groovy script listing a column from the table address:

sql.eachRow("select * from address") { r ->
    println "Gromit likes ${r.address_id}"
}

Using Groovy scripts you can access most of the DbSchema classes and methods. Details in DbSchema API Java Documentation.

The following variables are exposed directly to the Groovy script engine :

sql The physical connection to the database.
model The DbSchema model with schemes, tables, columns, etc..
out The PrintStream out console output stream, visible in the Script Result Pane.

Sample Groovy Scripts can be found in the Code Samples Dialog accessible from the SQL Editor Help menu.

Execute JS Scripts

The SQL editor can execute JavaScript code. In the editor menu is a combo where you can switch to JavaScript.

The variables below can be accessed directly by the script engine :

sql The physical connection to the database.
project The DbSchema model, with schemes, tables, columns, etc..
out The PrintStream out console output stream, visible in the Script Result Pane.

Here a simple groovy script listing two columns from a table 'customer':

var stmt = sql.prepareStatement( "SELECT first_name, last_name FROM customer");
var rs = stmt.executeQuery();

while (rs.next()) {
    out.print(rs.getString("FIRST_NAME") + " " + rs.getString("LAST_NAME") + "\n")
}
out.print ('Done');