AppCode 2018.2 Help

Working with Database Consoles

Database consoles let you compose and execute SQL statements for databases defined in AppCode as data sources. They also let you analyze and modify the retrieved data.

The following standardized and DBMS vendor-specific SQL dialects are supported: DB2, Derby, H2, HSQLDB, MySQL, Oracle, Oracle SQL*Plus, PostgreSQL, SQL Server, SQL92, SQLite, and Sybase.

One database console is created for a data source automatically when a data source is created. If necessary, you can create additional consoles.

Database consoles are persistent: they are stored as SQL files.

A database console created in one of your projects can then be accessed from any other project.

Creating a database console

When you create a DB data source, one database console for that data source is created automatically. If necessary, you can create additional consoles.

To create a database console, you can use the Database tool window or the Scratches view of the Project tool window. The procedure is the same in both cases:

Select the data source of interest or any node within it, and do one of the following:

  • Select File | New | Console File from the main menu.
  • Select New | Console File from the context menu
  • Press ⌘N and select Console File.

In the Database tool window, you can also use icons general add svg | Console File and the Open New Console context menu command.

Opening a database console

You can jump to the default console or any custom console that you created from the Database tool window. Select a data source in the list and do one of the following:

  • Click database openapi icons consoleRun on the title bar if the toolbar is hidden.
  • Click runJdbcConsole on the toolbar if the toolbar is shown.
  • Select Open Console from the context menu to open the default console for this source. Or press⌘↓.
  • Select Jump to Console from the context menu to choose any console for this source. Or press⇧⌘F10.

You can also open any console in the Scratches and Consoles directory of the Project tool window. Select the console and do one of the following:

  • Double-click the console.
  • Select View | Jump to Source from the main menu.
  • Select Jump to Source from the context menu.
  • Press⌘↓.

Viewing and modifying console settings

Before actually starting to use a console, you may want to take a look at the console settings and adjust them to your needs.

  • To access these settings, click icons general settings svg on the toolbar of the input pane or on the toolbar of the Database Console tool window. (Alternatively, ⌘, | Tools | Database.)

As a result, the Database page of the Settings / Preferences dialog will open.

    Changing the SQL dialect

    By default, the SQL dialect used in a console is defined by the DBMS of an associated data source. If for some reason you want to use a different dialect:

    • Right-click the editing area of the input pane, select Change Dialect (<CurrentDialect>), and select the necessary dialect.

      In addition to particular dialects, also the following option is available:

      • <Generic SQL>. Basic SQL92-based support is provided including completion and highlighting for SQL keywords, and table and column names. Syntax error highlighting is not available. So all the statements in the input pane are always shown as syntactically correct.

    Closing a console

    1. Click icons actions close (⌃⇧F4) to close the Database Console tool window.
    2. Click icons actions close on the editor tab (⌘W) to close the input pane.

    Managing database consoles

    To manage your database consoles, use the Scratches and Consoles directory of the Project tool window.

    To open the list of consoles, select Scratches from the list in the left-hand part of the title bar.

    projectToolWindowViews

    The directory contains the existing database consoles (represented by SQL files) grouped by your data sources (shown as folders). The default consoles (the ones that were created by AppCode automatically) have the same names as the corresponding data sources.

    projectToolWindowScratchesView

    You can:

    • Create new consoles. Select the target data source or a node within it, and do one of the following:
      • Select File | New | Console File from the main menu.
      • Select New | Console File from the context menu
      • Press ⌘N and select Console File.
    • Rename your consoles. When a new console is created, it has the name of the data source with a number at the end, e.g. MySQL_1. If you want to give a console a more descriptive name, select the console and do one of the following:
      • Select Refactor | Rename from the main or the context menu.
      • Press⇧F6.

      Then, specify a new name in the dialog that opens.

    • Save your console files in arbitrary directories. Select the console and then choose Refactor | Copy (F5). Specify the file name and location in the dialog that opens.
    • Group your consoles. This is done by creating folders and then dragging your consoles into those folders.
    • Open your consoles. Select the consoles of interest and do one of the following:
      • Select View | Jump to Source from the main menu.
      • Select Jump to Source from the context menu.
      • Press⌘↓.
    • View the history of changes for your consoles. Select File | Local History | Show History from the main menu or Local History | Show History from the context menu.
    • Delete individual consoles and groups of consoles. Use Edit | Delete, Delete from the context menu or on the keyboard.
    Last modified: 16 August 2018