Data sources and drivers dialog

⌘ N

Create a data source or a driver.

⌦

Remove the selected item or items from the list.

⌃ D

Create a copy of the selected data source or driver.

⌃ B

Navigate to the driver settings that are associated with the selected data source.

Move the selected data source to the global or project level. For more information about global and project levels, see Manage data sources.

Add

⌘ N

Create a data source or a driver.

Remove

⌦

Remove the selected item or items from the list.

Duplicate

⌃ D

Create a copy of the selected data source or driver.

Go to Driver

⌃ B

Navigate to the driver settings that are associated with the selected data source.

Make Global or Move to Project

Move the selected data source to the global or project level. For more information about global and project levels, see Manage data sources.

Change Driver

Associate a data source with a driver.

Reset Changes

⌃ ⌥ Z

Revert changes for the selected item.

Load Sources

Load source code of database objects for the selected category of schemas.

Show Driver Usages

⌥ F7

Show data sources that use the selected driver.

Switch between recently-used items.

Connection type

A connection type that you want to use for the database connection.

• URL only This option, generally, is for editing the database connection URL directly.

  When you select this option, only the following fields are available: User, Password and URL.

  You should edit the URL right in the field. Your username and password, if necessary, are specified in the corresponding fields, or within the URL in the format appropriate for the JDBC driver that you are using.

• When using any other of the options (the options are DBMS-specific), AppCode forms the database connection URL automatically using the info in the fields above the URL field. In all such cases, normally, you don't need to edit the URL (though you can if you want).

Driver

The driver from the Drivers list that you want to use for the connection.

File

The path to the database file.

Use the Open icon () to select an existing database file.

The Save icon () creates a copy of a database file and changes a path to the copy location.

Path

The path to the database file or folder.

Use the Open icon () to select an existing database file or a folder.

Host

The hostname (domain name) or the IP address of the computer where the database is located. If the database is on your local computer, specify localhost or 127.0.0.1.

If you are using SSH, the database host must be accessible by the specified domain name or IP address from the computer on which the SSH proxy runs. See SSH/SSL tab.

Port

The database port number.

Database

The name of the target database or schema.

User

The name of your database user account.

Password

The password for the database user.

Save

Save settings for the password field. You can select the following options for storing your password:

• Never: password is prompted each time you establish a connection with a database.

• Until restart: password is saved only for the current AppCode run. If you exit AppCode and open it again, you must provide the password again.

• For session: password is saved only for the current connection session with a database (until you disconnect from it). You can terminate the connection by pressing the Disconnect icon () or ⌃ F2.

• Forever: password is saved in the AppCode storage. You do not need to provide the password next time you open AppCode.

Create database

Adds an argument to the URL to create a database. This option is available only in some database management systems (for example, in the Apache Derby (Embedded)).

URL

The URL that AppCode will use to connect to the database. The user interface for specifying the URL is different depending on which option is selected in the Connection type list.

Test Connection

Verifies that the database connection settings are correct and AppCode can communicate with the database. To copy the communication information, click the Copy to Clipboard icon .

Read-only

Set the read-only status. Select the checkbox to protect the data source from accidental data modifications.

If the checkbox is selected, you cannot modify the data in the Data editor.

Data modifications might be possible in the query console if the driver does not support the read-only status.

Transaction control

Set the isolation level for database transactions and the mode of how the transactions are committed.

• Auto: the current transaction is committed automatically when you submit your local changes to the database server.

• Manual: changes submitted to the database server are accumulated in a transaction that can either be committed or rolled back.

Switch schema

Define a mode that AppCode uses to switch schemas.

• Automatic: switch schemas automatically or manually. When this option is enabled, previously-configured search path / current schema are restored automatically between IDE restarts.

• Manual: switch schemas manually only.

• Disable: do not switch schemas.

Single session mode

Enable the single session mode. Single session mode means that the data source and all consoles use one and the same session. This mode allows you to see the temporary objects in the database tree, or use the same transaction in different consoles. For more information about consoles, read Query console.

Run keep-alive query each N seconds

Run a keep-alive query to keep the connection alive. You can define the custom query in the driver settings for unsupported databases.

Auto-disconnect after N seconds

Disconnect from the database after the specified number of seconds.

Enable DBMSOUTPUT

(Oracle, IBM Db2 LUW) Enable DBMS_OUTPUT by default for new sessions.

Single database mode

In the database tree view, show and enable only the database that you specified in the connection settings.

When you connect to a data source, AppCode can retrieve and display you all the databases that the data source has. But in some cases (for example, with certain settings of PgBouncer), you can or are allowed to work only with a certain database. In the database tree view with the Single database mode enabled, you see only the database that you specified in the connection settings.

Consider using this setting for PostgreSQL, Azure SQL Database, Greenplum, Amazon Redshift.

Startup script

Run an SQL query each time you establish a connection.

Note: if the Single session mode checkbox is cleared, each new query console creates a new connection.

Auto sync

Synchronize the actual state of the database automatically. The state of the database means the database tree view that you see in the Database tool window.

If the Auto sync checkbox is selected, the view of the data source is automatically updated:

• When you click OK in the Data Sources and Drivers dialog.

• When you run DDL SQL statements in the database consoles associated with the data source.

If the Auto sync checkbox is cleared, the view of the data source in the Database tool window is synchronized with the actual state of the database only when you click the Refresh button or press ⌃ F5).

Load sources for

Load source code of views, procedures, packages and other database objects for the selected category of schemas: all schemas (All schemas), all schemas excluding system schemas (All excl. system schemas), or disable the feature (None).

To change this setting for several data sources simultaneously, select the corresponding data sources. Right-click the selection and navigate to Load Sources and select an option.

Warn when editing outdated DDL

Display a notification if the cached DDL differs from the actual DDL in the database.

Every time you open source code, AppCode displays you a version that is loaded during the indexing process. But if someone changes the source code from another workstation, the indexed version becomes outdated.

If your version is older than the one in the database, you see the following notification: Cached object differs from the object in the database.

Track databases/schemas creation and deletion

When you create, delete, or rename a schema, AppCode updates the list of available schemas in the introspection scope window. To see the introspection scope, click the button near the data source name in the Database tool window.

Use pre-introspected objects for system catalogs that are not introspected

Toggles the usage of pre-introspected objects for system catalogs. For more information about introspection and system catalogs, see Pre-introspected objects from system catalogs.

Virtual objects and attributes

Defines a path to external-data.xml that stores relations of virtual foreign keys. These relations are used in the auto-completion list, data navigation, and diagrams. For more information about Virtual objects and attributes, see a procedure about creation of virtual foreign keys.

Code style

Select a code style that you want to use for schemas. For more information about code style customization, read Code styles for SQL.

Before connection

Select tasks that AppCode will perform before the first connection (at the start of a process in which the JDBC driver works). Tasks are run sequentially.

Disable incremental introspection

Do not perform the incremental introspection. The option is available for Oracle, Microsoft SQL Server, PostgreSQL and similar databases, .

With the incremental introspection, the introspector detects objects changed in the database after the previous introspection and loads only these objects. When you enable this option, the introspector always loads all objects. It might greatly increase the introspection time.

Fetch LONG values

Select how to download values from LONG columns that belong to views of the Oracle catalog. The option is available only for Oracle.

The default option is XML as it has a better performance. In case of errors in the Oracle XML text generator, consider using the conventional way. Note that the conventional way might increase the introspection time, especially when the ping to the server is long.

Introspect server objects

Run introspection for server objects. The option is available only for Oracle.

Do not use xmin in queries to pgdatabase

Do not use the xmin attribute in queries to the pg_database table. Use this workaround when xmin is absent in pg_database. Note that your database might be corrupted. The option is available only for PostgreSQL.

Register REGEXP function

Register the REGEXP function implementation. This implementation is not available in SQLite by default. The option is available only for SQLite.

Use SHOW CREATE for source code

Use the SHOW CREATE statement to generate the CREATE statement for object source code. Source code for triggers and routines is broken in information_schema of MySQL (see Bug #66414 at bugs.mysql.com). The option is available only for MySQL.

Automatically assign sessionid

Generate a unique session_id for each connection. With session_id, you can use different session statements (for example, USE). The option is available only for ClickHouse.

Refresh the list of the databases and schemas.

Expand all nodes in all trees.

Collapse all nodes in all trees.

Filter the contents in trees. Only the databases and schemas whose names contain the specified text are shown.

Schema pattern

Define a pattern to select the necessary databases and schemas. To get the info about the syntax to be used, position the caret into the field and press ⌃ Q.

• @: the current database or schema.

• *: every database or schema. You can list schemas after *:.

Consider the following examples:

• *:*: all schemas in all databases.

• @:*: all schemas from the current database

• @:@: only the current schema

• *:dbo|@:@|db1:s1,s2,s3: the dbo schema from all databases, the current schema, schemas s1,s2,s3 from the db1 database.

Object filter

Limit the set of tables and other database objects that are shown in the Database tool window for each data source. For example, if you limit the resolve scope to table:actor.*, then only the actor table will be accessible in the Database tool window (View | Tool Windows | Database).

All other tables will be out of the scope. AppCode does not resolve objects that are not displayed in the Database tool window.

Use the following pattern when you compose an expression for the Object filter field.

<type>:[-]<pattern>, where:

<type> might be an aggregate, collation, event, fdw, ftable, mview, operator, package, role, routine, sequence, synonym, table, user, view, vtable.

<pattern> is a regular expression. To exclude an item, prepend with - (minus). For more information about regular expressions, see Class Patterns at JavaTM 2 Platform Standard Edition 5.0 API Specification.

Show internal system schemas

Show or hide internal system schemas (for example, pg_toast or pg_temp). The option is available for PostgreSQL only.

Show template databases

Show or hide template databases (for example, template1, template0). The option is available for PostgreSQL only.

VM options

JVM options for the database driver.

For certain Oracle Database versions (for example, Oracle version 9), there might be connection problems when you and your database server are in different time zones. You can specify the time offset for your timezone in the VM Option field (for example, -Duser.timezone=UTC+03:00). Alternatively, set the variable oracle.jdbc.timezoneAsRegion to false in the table on the Advanced tab.

VM environment

Environment variables for the database driver JVM.

For example, encoding-related issues in Oracle database can be solved by setting the NLS_LANG variable (like NLS_LANG=Russian_CIS.CL8MSWIN1251). For more information, see Oracle NLS_LANG FAQ.

Working directory

The working directory for the process that handles working with data sources. Also, all relative paths are resolved relatively to this directory (for example, paths in driver properties).

For example, if you create a file-based database like SQLite and do not set the path for the SQLITE file, the file will be created in this working directory.

Class

The fully qualified name of the driver class to be used.

JDBC drivers

AppCode uses JDBC drivers to interact with a database. You can download and use a driver from the AppCode driver repository or specify the driver that you store on your computer.

To download and use the latest driver version, click the Download ver. N link.

You can also specify and use a driver with a particular version number. Click the ver. <version_number> link and select the driver version that you want to use. The selected version is downloaded and applied automatically.

You can use the driver that is already available on your computer. In that case, click the Add button and select the driver files (with the JAR extension).

URL templates

The templates used to construct the database URL. The text in curly brackets represents variables. Consider the following examples:

• {host}: the domain name or IP address of the database host.

• {port}: the database port number.

• {database}: the name of the database or schema.

Optional fragments are in square brackets, for example, [:{port}].

Template names correspond to the names of the options in the URL options list.

Transaction control

Set the isolation level for database transactions and the mode of how the transactions are committed.

• Auto The current transaction is committed automatically when you submit your local changes to the database server.

• Manual The changes submitted to the database server are accumulated in a transaction that can either be committed or rolled back.

Switch schema

Define a mode that AppCode uses to switch schemas.

• Automatic: switch schemas automatically or manually.

• Manual: switch schemas manually only.

• Disable: do not switch schemas.

Startup script

An SQL query that will run each time you establish a connection.

Note: if the Single session mode checkbox is cleared, each new query console creates a new connection.

Keep-alive query

A keep-alive query that will run to keep the connection alive.

Auto sync

The default setting for the auto sync option.

Load sources for

Load source code of database objects for the selected category of schemas.

Send application info

When connecting to a database server, AppCode sends the info about itself if this checkbox is selected.

Dialect

The SQL dialect associated with the corresponding data sources.

Code style

Selects a code style that you want to use for the data sources that use this driver. For more information about code style customization, read Code styles for SQL.

Format synced sources

Apply the code style to source code of database objects after synchronization.

VM Options

The default options for the JVM in which the database driver runs. The driver is started as a separate process in the JVM.

VM environment

Environment variables for the database driver JVM.

For example, encoding-related issues in Oracle database can be solved by setting the NLS_LANG variable (like NLS_LANG=Russian_CIS.CL8MSWIN1251). For more information, see Oracle NLS_LANG FAQ.