Skip to content

Resource Manager

dbeaver-devops edited this page Dec 4, 2024 · 9 revisions

Table of contents

Overview

The Resource Manager allows users to store and manage scripts in the CloudBeaver server file system. Scripts can be saved in both projects, the Private or the Shared, and available to every user who has access to this project.

Each user has the Private project and can create, edit and delete scripts in it. Other users do not have access to this project.

Administrators can also create and manage scripts in the Shared project. All users with access to this project can see, open and run the project scripts.
Scripts can be associated with a specific connection. When a user opens such a script, the specified connection is displayed in the SQL Editor top toolbar and the user can immediately execute the script for the connection. Note: scripts can only be associated with connections from the same project.

The Resource Manager is only available to logged users. Anonymous users may save scripts on a local machine.

Opening the Resource Manager

To open the Resource Manager select it in the Tools menu.

sql_scripts_manager_open

The Resource Manager panel will appear to the right of the SQL Editor. The panel contains the list of saved user’s scripts in ascending order. Every script has the context menu with tools.

sql_scripts_manager

Resource manager settings menu

The Settings menu gives access to additional tools of the Resource Manager tree. To open it, press the Settings button in the upper left corner of the Resource Manager.

The table below describes each tool within the Resource Manager:

Tool Description
Filter Allows for script search within the Resource Manager. Activate the Filter switch to access the filter field and enter the script name to display relevant scripts. The search is limited to scripts that are currently visible.
Show collapsed An additional setting for the Filter. When enabled, the search will include scripts within collapsed directories that the user has previously expanded.
Save tree state Preserves the state of the Resource Manager tree view after refreshing the browser page. This setting is enabled by default.
Folders Displays only the top level of folders. The full path to a folder is shown as breadcrumbs. When a user double-clicks on a script, the path to it is displayed in the Resource Manager tree.
Group by Project Omits project names from the Resource Manager tree view, simplifying the display of scripts and folders.

Saving a script

To save an SQL script to the Resource Manager, press the Save button Resource Manager Save button on the left SQL Editor toolbar:

For users: the script will be saved to the Private project in the CloudBeaver server.

For administrators:

  • if a connection for the script is not selected, the script will be saved to the project selected by the administrator in the pop up dialog box.

sql_scripts_manager_save

  • if a connection for the script is selected, the script will be saved to the project where the connection is stored.

The script name will appear in the Resource Manager panel under the project name.

Once a script is saved in the Resource Manager, all future changes will automatically be saved in it:

  • each time any changes have been made in it
  • every time when the SQL Editor with the script has been closed.

Specifying a connection for a script If necessary, when you want to specify a connection, just select a connection and a schema in the SQL Editor top toolbar for the script. The script will use this connection the next time the user opens it. To change the connection, select another one in the SQL Editor top toolbar. The changes will be saved automatically. To remove the connection, disconnect from the database in the Navigator tree and do not restore the connection for the script.

Opening a script

To open a saved script, double click the script name in the Resource Manager panel or select Open in the script context menu.

sql_scripts_manager_context_menu

The script will be opened in a separate SQL Editor and its name will be displayed on the SQL Editor tab. If a connection has not been specified for the script, users will need to select a connection name in the SQL Editor top toolbar before execution.

Deleting a script

To delete a script from the Resource Manager, select Delete in the script context menu in the Resource Manager panel. The script will disappear from the panel and will be deleted from the CloudBeaver server. The SQL Editor with the script will also be closed if it has been opened. The deleted script cannot be restored. Scripts from the Shared project can only be deleted by the administrators.

Script size limit

You can configure the size limit for scripts in the Resource Manager. This can be useful if you need to control the amount of space on the CloudBeaver server. The limit also helps to improve the application performance, because opening big scripts can take quite a long time. If a user is saving a large script, they will see a message that the file size has been exceeded and the script will not be saved.

For more information, see Resource quotas.

Deactivate Resource manager

Administrators can deactivate the Resource Manager in the Server Settings. The Resource Manager panel disappears from the CloudBeaver interface, and users don’t have access to scripts on the server.

Tip: For more information on how to disable the Resource Manager through the configuration file, see Server configuration.

CloudBeaver Documentation

User Guide

Installation

Configuration

CloudBeaver AWS

CloudBeaver Enterprise Edition

Deployment

Clone this wiki locally