Database tool window

Collapse all the nodes.

All node types

New

⌘ N

Create a new data source, role, database, schema, query console, table, column, index, or a primary or a foreign key. The list of options depends on which element is currently selected.

Data sources and their elements. If a DDL data source is selected, you can only choose to create another data source.

Duplicate

⌃ D

Create a copy of the selected data source. Specify the properties of the data source in the Data Sources and Drivers dialog that opens.

DB and DDL data source nodes

Refresh

⌃ F5

Update the view of the selected element (that is to synchronize the view of the element with its actual state in the database).

See also, Data sources and drivers dialog.

data sources and their elements

Data Source Properties

Open the Data Sources and Drivers dialog to manage your data sources and their settings.

All node types

Deactivate

⌃ F2

Close the database connection for the selected data source or data sources. (The names of the data sources with active database connections are shown in bold.)

Data sources with active connections and their elements

Edit Data

F4

Open a table view of the object in the data editor. This option works for tables, views, and materialized views.

Corresponding elements in data sources.

Go to DDL

⌃ B

Open the DDL of the selected object. For example, if you press this shortcut on a table's name in the SELECT statement, you will see the DDL of this table (the CREATE TABLE statement).

Corresponding elements in data sources.

Jump to Query Console…

⌃ ⇧ F10

Open the default query console for the corresponding data source.

Data sources and their elements (tables and table columns)

Filter

Open a list of database objects that you can filter for the selected database. The list of database objects depends on the selected database. To see a full list of available database objects and their icons, go to Icons for data sources and their elements.

Data sources and their elements

New

Create a new data source, role, database, schema, query console, table, column, index, a primary or a foreign key. The list of options depends on which element is currently selected.

Rename

⇧ F6

Rename the selected data source, table or column. Specify the new name in the dialog that opens.

Modify Object… (Old UI)

or

Modify Table

⌃ F6

Edit the definition of a table, column, index, primary or a foreign key.

Copy Reference

⌃ ⌥ ⇧ C

Copy the fully qualified name of the selected data source, table or column to the clipboard.

Quick Documentation

⌃ Q

View basic information about the selected element.

To close the documentation popup, press ⎋.

Find Usages

⌥ F7

Find all the usages or references of a data source, table, column, or any other selected item in your source files and libraries.

Add to Favorites

Add an item to the Favorites list. You can quickly access those items in the Favorites tool window (View | Tool Windows | Favorites).

SQL Scripts | SQL Generator…

⌃ ⌥ G

Generate data definition structures for database objects. For example, you can generate DDL files for a single table or for all the tables in the schema. Also, you can customize generation settings. For example, you can set what syntax to use for table creation: CREATE TABLE or CREATE TABLE IF NOT EXISTS.

SQL Scripts | Request and Copy Original DDL

⌃ ⌥ G

If your database stores DDL of the object, retrieve DDL from the database.

SQL Scripts | Generate DDL to Clipboard

⌃ ⌥ ⇧ G

Generate DDL of the object and copy it to the clipboard.

SQL Scripts | Generate DDL to Query Console

⌃ ⌥ ⇧ B

Generate DDL of the object and paste it to a query console.

Tools | Modify Comment…

Modify or add a comment to a database object like if you have run the following query COMMENT ON SCHEMA information_schema IS 'myComment';.

Tools | Truncate…

Remove all the rows in the selected table.

Tools | Manage Shown Schemas…

Open a popup with available schemas for the current data source.

Tools | Hide Schemas

Hide the schema that is selected.

Tools | Force Refresh

⌃ ⇧ F5

Delete the data source information from cache and load it again. This action is available on the data source node only.

Tools | Forget Cached Schemas

Delete the information that AppCode has accumulated about your database. This action is available on the data source node only.

Use this command when you experience issues like wrong display of data structures or errors during synchronization.

To check if this has eliminated the problem, use the Synchronize command.

Tools | Properties

⇧ ⏎

Open the Data Sources and Drivers window where you can customize data source settings.

Tools | Drop Primary Key

Remove the primary key constraint for the current table.

Tools | Drop Foreign Key

Remove the foreign key constraint.

Diagnostics | Dump Model

Generate a diagnostic representation of the database in a AppCode internal format. This information might be helpful for the support team if some database objects exist in the database but do not show up in the Database tool window.

Diagnostics | Diagnostic Refresh

Reload the metadata from the database and generate a detailed log file of the process. This information might be helpful for the support team when your introspection takes too much time.

Diagnostics | Prepare Introspector Diagnostics

Generate three files that include information about the following:

• dataSource.txt: the data source.

• introspector.txt: a module that was used to load the metadata from the database.

• model.xml: a part of the database model.

This information might be helpful when introspection works incorrectly. For example, when you see something outdated or do not see new objects.

Drop

or

Remove

⌦

Remove the selected item.

Jump to Query Console…

⌃ ⇧ F10

Create and open a new query console for the selected data source.

Refresh

⌃ F5

Create and open a new query console for the selected data source.

Compare Structure…

⌃ D

Compare structures of two selected database objects (data sources, schemas, or tables). The comparison results are shown in the differences viewer.

Compare Content

Compare the output results of tables, views, and materialized views. The comparison results are shown in the differences viewer.

Export Data to &File

Save data for the selected tables and views in files. Select the output format (for example, SQL Inserts, Tab-separated (TSV), JSON-Clojure.json.clj).

Export with 'mysqldump'

or

Export with 'pg_dump'

Run mysqldump or pg_dump for the selected items. mysqldump and pg_dump are native MySQL and PostgreSQL tools. They are not integrated into AppCode. You can read about them at dev.mysql.com and postgresql.org.

Import Data from File(s)…

Import a text file containing delimiter-separated values (CSV, TSV, and so on) into your database.

If a schema is currently selected, AppCode will create a new table for the data that you are importing. If a table is selected, AppCode will try to add the data to the selected table.

Full-text Search

Shift+Ctrl+Alt+F

Search for data in your databases or a group of databases without knowing data exact location.

Restore with 'mysql'

Restore with 'psql'

or

Restore

Run mysql,pg_restore, or psql to restore a data dump. These tools are native for MySQL and PostgreSQL. They are not integrated into AppCode. You can read about them at dev.mysql.com and postgresql.org.

Copy Table to…

F5

Create a copy of the selected table. You can create a copy in a different scheme or data source. For example, you can copy the actor table from MySQL to PostgreSQL.

Color Settings…

Set or change the color for the selected element or elements. (The Database Color Settings dialog will open.)

To set a color, right-click a data source and select Color Settings…. In the Database Color Settings dialog, select the dialog and coloring options. To have the data source color applied for query consoles and grids, select the In console editors and grids checkbox.

Scripted Extensions | Generate POJOs.clj

Generate a Java entity class for the selected table. In the dialog that opens, specify the directory in which the JAVA class file should be generated.

Scripted Extensions | Go To Scripts Directory

Switch to the directory where the Generate POJOs.clj example script file is located.

Group Data Sources

Displays folders for data sources if you created any.

Enabled	Disabled

Group Server and Database Objects

Displays folders for server and database objects. This setting concerns users, roles, tablespaces, modules, foreign data wrappers and other rarely-used objects.

Enabled	Disabled

Group Schema Objects

Defines how schema elements are shown.

When on, there are separate nodes for tables, views and stored routines (shown as folders). Tables, views and routines (procedures and functions) are shown as elements of the corresponding groups.

When off, there is no explicit grouping for tables, views, and routines. Tables and views are followed by procedures and functions.

Group Object Elements

This option defines how table elements are shown.

When on, there are separate nodes for columns, indexes, primary and foreign key constraints, and triggers (shown as folders). The elements appear in the corresponding groups.

When off, there is no such grouping and, generally, only columns are shown for tables.

Show All Namespaces

Show all databases and schemes even if they are not selected for introspection.

When the Show All Namespaces option is disabled, databases that are not selected for introspection do not appear in the Database tool window.

When the Show All Namespaces option is enabled, databases that are not selected for introspection are displayed in the Database tool window.

Show Empty Groups

If the Group Schema Objects or Group Object Elements options are selected, you can select to show or hide the categories that contain no elements.

The Show Empty Groups option is on:

The Show Empty Groups option is off:

Show Intermediate Nodes

Shows or hides parent nodes only when you do not have other objects on the same level with a parent.

Enabled	Disabled

Show Generated Objects

For Oracle, shows or hides auto-generated objects in the tree. It concerns the following objects:

• Materialized view logs

• The underlying tables for materialized views

• Secondary tables

Separate Procedures and Functions

In Microsoft SQL Server, Oracle, and PostgreSQL, separates procedures and functions into different folders.

Alphabetically

Order database objects alphabetically. When the option is disabled, natural sort order is applied.

Alphabetically is enabled	Alphabetically is disabled

Place Constraints and Similar Objects under Schema

Display nodes for object names that exist in a schema namespace. For example, nodes for keys, CHECK constraints, indexes, triggers, rules, and other objects.

You can use this option in the following situations:

• To find an object inside a schema with the help of a quick search.

• To see the columns just under the table node. To do this, turn off the Show Empty Groups.

Enabled	Disabled

Show Toolbar

Display the toolbar in the Database tool window.

Access Method

Aggregate

Alias Type

Argument

Body

Check

Cluster

Collation

Collection Type

Column. For more information about column icon combinations, see Possible icon combinations for columns.

Data File

Database

Read-only status

DDL data source

Default

Exception

Extension

External Schema

Foreign Data Wrapper

Foreign Key

Foreign Table

Index

Key

Materialized Log

Materialized View

Object Attribute

Object Type

Operator

Package

Projection

Read-only data sources

Role

Routine

Rule

Scheduled Event

Schema

Sequence

Server

Stored procedure or function

Synonym

Table

Table Type

Tablespace

Trigger

User

User Mapping

Variable

View

Virtual Table

⌃ -

Collapse all expanded nodes in the current view.

⇧ ⎋

Hide the tool window .

To hide all the tool windows, press ⌃ ⇧ F12.