AppCode 2019.3 Help

Services tool window

The Services tool window includes various services that help you during software development: run/debug configurations, application servers, database sessions, Docker connections, and so on. Plugin developers can add other services through the IntelliJ platform API.

Main toolbar

The main toolbar contains the following buttons and menus that are common for all service types:

Icon

Action

Description

The Expand All button

Expand All ⌘+

Expand all items in the list.

The Collapse All button

Collapse All ⌘-

Collapse all items in the list.

The Group By menu

Group By

Choose how you want to organize the list of services.

The Filter menu

Filter

Choose how you want to filter the list of services.

The Open in New Tab button

Open in New Tab

Move the selected items to a separate tab.

The Add Service menu

Add Service ⌘N

Choose a service type to add.

Run/debug configurations

Run/debug configurations are not listed in the Services tool window by default. You need to explicitly specify the types of configurations you want to be available and create the corresponding configurations.

Add the types of configurations to show in the Services tool window

  1. Click the New Service menu and select Run Configuration Type.

  2. Select the necessary run/debug configuration type from the Add Configuration Type popup.

The Services tool window only displays the configuration types for which you have created at least one configuration.

Buttons on the toolbar depend on the selected type of the run/debug configuration.

Icon

Action

Description

The Run button

Run ⌃⇧R

Run the selected configuration.

The Debug button

Debug ⌃⇧D

Debug the selected configuration.

The Stop button

Stop ⌘F2

Stop the selected configuration.

Database service

In the database service, you can manage your sessions and connections. Connection is a physical communication channel and session is a state of information exchange. For example, if you surf a social network, your connection log might have thousands of connection entries between a client and a server while a session log might show you only a single log entry with the number of bytes transferred.

For more information about managing database sessions, see Run a query.

Left toolbar

Icon

Action

Description

Tx

Tx Mode and Tx Isolation

Choose the isolation level for database transactions and the way transactions are committed.

  • Auto: each statement is executed in its own transaction that is implicitly committed.

  • Manual: transactions are committed and rolled back manually.

The Commit button

Commit ⌥⇧⌘⏎

Commit the current transaction.

The Rollback button

Rollback

Roll back the last transaction.

The Cancel Running Statements button

Cancel Running Statements ⌘F2

Terminate the execution of the current statement.

The Restore Default Layout button

Restore Default Layout ⌘F2

Restore default positions of visual elements in the Service view.

The Jump to Console button

Jump to Console ⇧⌘F10

Open the Consoles popup. In the Consoles popup, you can select a database console that you want to open in the editor.

The Disconnect button

Disconnect ⌘F2

(For data sources) Close a connection to the selected data source.

The Disconnect button

Cancel Running Statements ⌘F2

(For sessions and attached files) Close a connection to the selected data source.

Data sources

Icon

Action

Description

The Jump to Console button

Jump to Console ⇧⌘F10

Open the Consoles popup. In the Consoles popup, you can select a database console that you want to open in the editor.

The Disconnect button

Disconnect ⌘F2

Close a connection to the selected data source.

Close All Sessions

Close all opened sessions to a data source.

The Show in New Tab button

Show in New Tab

Move the selected items to a separate tab.

The Split to New Tabs button

Split to New Tabs

Split the selected items into separate tabs.

The Split By Type button

Split By Type

Create separate tabs for each type of service.

Delete

Close all opened sessions to a data source. Identical to Close All Sessions.

Sessions

Icon

Action

Description

Tx

Tx Mode and Tx Isolation

Choose the isolation level for database transactions and the way transactions are committed.

  • Auto: each statement is executed in its own transaction that is implicitly committed.

  • Manual: transactions are committed and rolled back manually.

The Commit button

Commit ⌥⇧⌘⏎

Commit the current transaction.

The Rollback button

Rollback

Roll back the last transaction.

The Disconnect button

Cancel Running Statements ⌘F2

Stop execution of running statements.

The Restore Default Layout button

Restore Default Layout ⌘F2

Restore visual elements of are arranged.

Rename Session

Display the Rename dialog where you can specify a name for a session.

Close Session

Close the selected session.

The Show in New Tab button

Show in New Tab

Move the selected items to a separate tab.

The Split to New Tabs button

Split to New Tabs

Split the selected items into separate tabs.

The Split By Type button

Split By Type

Create separate tabs for each type of service.

Delete

Close all opened sessions to a data source. Identical to Close All Sessions.

SQL files

Icon

Action

Description

Tx

Tx Mode and Tx Isolation

Choose the isolation level for database transactions and the way transactions are committed.

  • Auto: each statement is executed in its own transaction that is implicitly committed.

  • Manual: transactions are committed and rolled back manually.

The Commit button

Commit ⌥⇧⌘⏎

Commit the current transaction.

The Rollback button

Rollback

Roll back the last transaction.

The Disconnect button

Cancel Running Statements ⌘F2

Stop execution of running statements.

The Restore Default Layout button

Restore Default Layout ⌘F2

Restore visual elements of are arranged.

Switch Session

Display the Sessions popup where you can select or create a new session and connect to it.

Detach Session

Detach the selected file from the current session. To attach the file to a session, open the file in the editor, and select the session in the sessions list.

Detach a session
The Show in New Tab button

Show in New Tab

Move the selected items to a separate tab.

The Split to New Tabs button

Split to New Tabs

Split the selected items into separate tabs.

The Split By Type button

Split By Type

Create separate tabs for each type of service.

Delete

Close all opened sessions to a data source. Identical to Close All Sessions.

the Jump to Source button

Jump to Source ⌘↓

Open the file in the editor.

Docker

This type of service is available if you have configured connection settings for at least one Docker instance. For more information, see Enable Docker support.

Add a Docker connection

  1. Click the New Service menu and select Docker Connection.

  2. Configure the docker connection settings in the New Docker Connection dialog.

Main Docker node

Icon

Action

Description

The Connect button

Connect

Connect to the Docker daemon and list all available images and containers.

The Disconnect button

Disconnect

Disconnect from the Docker daemon.

The Edit Configuration button

Edit Configuration

Edit the Docker connection settings.

The Deploy button

Deploy

Select an existing Docker run configuration or create a new one. For more information, see Running containers

The Pull Image button

Pull Image

Pull an image from a Docker registry. For more information, see Pull an image from a Docker registry.

The Filter button

Filter

Choose whether you want to show or hide containers that are not running and images with no tags.

Containers

Icon

Action

Description

The Start Container button

Start Container

Run the selected container.

The Stop Container button

Stop Container

Stop the selected container.

The Delete Container button

Delete Container

Delete the selected container.

The Filter button

Filter

Choose whether you want to show or hide containers that are not running and images with no tags.

Images

Icon

Action

Description

The Pull Image button

Pull Image

Pull an image from a Docker registry. For more information, see Pull an image from a Docker registry.

The Create Container button

Create Container

Create a Docker container from the selected image.

The Delete Image button

Delete Image

Remove the selected image.

The Push Image button

Push Image

Push an image to a Docker registry. For more information, see Push an image to a Docker registry.

The Filter button

Filter

Choose whether you want to show or hide containers that are not running and images with no tags.

Main Docker Compose node

Icon

Action

Description

The Deploy button

Deploy

Deploy your selected Docker Compose services using the associated run/debug configuration. For more information, see Docker Compose

The Stop button

Stop

Stop all containers in the selected Docker Compose services.

The Down button

Down

Stop and remove all containers in the selected Docker Compose services, including all related networks, volumes, and images.

The Edit Configuration button

Edit Configuration

Edit the selected Docker Compose run configuration.

The Filter button

Filter

Choose whether you want to show or hide containers that are not running and images with no tags.

Docker Compose services

Icon

Action

Description

The Start button

Start

Start all containers for the selected service.

The Stop button

Stop

Stop all containers for the selected service.

The Scale button

Scale

Change the number of containers for the selected service.

The Delete Container button

Delete Container

Delete the selected container.

The Filter button

Filter

Choose whether you want to show or hide containers that are not running and images with no tags.

Kubernetes

This type of service is available if:

  • The Kubernetes plugin is installed and enabled. For more information about the Kubernetes integration in AppCode, see Kubernetes.

  • AppCode detects a Kubernetes cluster configuration file. By default, this is a file named config in the $HOME/.kube directory. You can specify other kubeconfig files by setting the KUBECONFIG environment variable or using the --kubeconfig option when running kubectl. For more information about kubeconfig files, see Organizing Cluster Access Using kubeconfig Files.

The Kubernetes node in the Services tool window lists resources of the Kubernetes cluster in the current context. To check the name of the cluster in the current context, run the following command:

kubectl config current-context

For more information, see Configure Access to Multiple Clusters.

Icon

Action

Description

The Refresh button

Refresh

Refresh the Kubernetes cluster configuration.

The Namespace menu

Namespace

Select a namespace to filter the listed resources of the cluster.

The Load YAML button

Load YAML

Open the selected resource configuration file from the cluster in the editor.

The Show Log button

Show Log

Show logs for containers of the selected pod in separate tabs.

Productivity tips

Use tabs

The Services tool window can include a lot of services, which you can group according to their type or create separate tabs for your own custom grouping. For example, you can create a tab that will include the following: the run configuration for the application that you are developing, the Docker container that runs the database used as a backend for your application, and a console for accessing the database.

Hide the services tree

Click The Show Options Menu button in the right part of the Services tool window toolbar and then click Show Services Tree to remove the checkbox. You can also press N/A to toggle the services tree.

If you hide the services tree, it is replaced by a services navigation bar. Press ⌘↑ to focus the services navigation bar.

Last modified: 16 December 2019