-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Task Management
Note: This feature is available in Community, Enterprise, Ultimate and Team editions only.
Use tasks to save and reuse configurations for database tools like data transfer or import/export. Tasks help you automate routine actions and run them with one click. You can create tasks from tool wizards or from the main menu, group them in folders, and manage them in a dedicated view.
All your tasks are stored in the Database Tasks view. Use it to review, organize, and run tasks when you need them.
From this view, you can:
- Add, edit, or delete tasks.
- See task information.
- Run tasks manually.
- Schedule tasks.
To open it:
- Go to Database -> Tasks -> Database Tasks,
- Or click Open Tasks view (
) from the task creation wizard.
The toolbar includes quick-access buttons:
Icon | Name | Description |
---|---|---|
![]() |
Open scheduler | Configure time-based task runs. |
![]() |
Refresh | Reload the task list. |
![]() |
Group by category | Toggle grouping by category (Common/Database-specific). |
![]() |
Group by type | Toggle grouping by type (Export, Import, etc.). |
![]() |
Run task | Start the selected task manually. |
![]() |
View menu | Open options to create a new task, add a folder, or delete items. |
Tip: You can also right-click a task in the list to access these actions.
Right-click any task in the Database Tasks view to access task actions:
Action | Description |
---|---|
Run task | Execute the selected task immediately. |
Edit task | Open the task editor. |
Create new task... | Open the task creation wizard. |
Copy | Copy task name to clipboard. |
Delete | Remove the selected task. |
Create new task folder | Create a folder to organize tasks. |
Rename folder | Rename a selected folder. |
Scheduler | Access task scheduling settings. |
Group tasks by category | Enable grouping by user-defined categories. |
Group tasks by type | Enable grouping by task type. |
Copy | Copy task info to clipboard. |
Configure columns | Choose which columns to display in the view. |
Auto-size columns | Adjust column widths to fit content. |
You can create a new task from:
-
Database Tasks view: Go to Database -> Tasks -> Database Tasks
-
Menu bar: Go to Database -> Tasks -> Create New Task
-
Toolbar: click arrow next to Open Tasks view (
) and choose Create new task.
Note: The toolbar is customizable. For further information, refer to Toolbar Customization article.
-
Database Navigator: Right-click a database object, then select Tools -> Create new task
-
Properties editor: Right-click a database object, then choose Tools -> Create new task
Alternatively, you can save tasks directly from tools like Data Transfer, Data Compare, Back up and Restore, Mock Data generator. Just configure the tool, click Save task, fill in the task details, and save.
-
Open the task creation wizard.
-
Fill in the task properties and choose the tool you want to automate:
Field Description Name Enter a unique name for the task. Description (Optional) Add a short description to help identify the task later. Task folder (Optional) Select a folder to organize tasks. Task type Choose the tool you want to automate. Select from the list of task types:
Common: Available for any database type. Database-specific: Available only for supported database types. Max execution time (in seconds) (Optional) Set a time limit for task execution. Default is 300
.Note: The list of available task types depends on the databases listed in Database Navigator. Database-specific tasks only appear if their corresponding database (like PostgreSQL, MySQL, etc.) is present.
-
Click Next.
-
Complete the task-specific configuration wizard.
-
Save the task when you're done.
To manage tasks open the Database Tasks view.
You can manage tasks using the toolbar or by right-clicking a task in the Database Tasks view.
Available actions:
Action | How to use it |
---|---|
Add | Click the View Menu button (![]() |
Edit | Select a task, then right-click and choose Edit task |
Delete | Select a task, then right-click and choose Delete |
Warning: Deleted tasks can’t be restored.
- Select a task in the Database Tasks view.
- Right-click it to open the context menu.
- Click Run task.
- Alternatively, use Run task button (
) on the view’s toolbar.
- Alternatively, use Run task button (
You can run saved tasks using the DBeaver command line interface. Use the -runTask
parameter like this:
-runTask "@projectName:taskName"
Tasks run in the background without keeping the client open.
If your workspace has only one project, you can omit the @projectName:
part.
On Windows, use the dbeaverc
executable (or the legacy name dbeaver-cli
) to run tasks.
Tip: Add the
-nosplash
parameter to skip the splash screen.
The process of editing a task is similar to the process of creating a task.
By double-clicking on a task or right-click and choose Edit task, the task edit wizard will be opened. In this wizard, you can:
- Change the task properties.
- Change the file format, either output for an export task or input for an import task.
- Alter the set of objects for data transfer.
- Adjust any export/import configuration.
After modifying the task settings, click the Save task button. This button is located on the left side of the task configuration wizard.
Note: This feature is available in Lite, Enterprise, Ultimate and Team editions only.
You can schedule tasks for later/regular execution. See the Task Scheduler article.
You can personalize how tasks are displayed in the Database Tasks view. Group them by type or category, and choose which columns are visible.
To organize your task list:
- Right-click anywhere in the task list
- Select Group tasks by category or Group tasks by type from the context menu
Tip: You can enable both grouping options at the same time.
To show or hide columns:
-
Right-click anywhere in the task list
-
Click Configure columns
-
Select the columns to show or hide
You can organize tasks into folders. To create one:
- Right-click in the Database Tasks view and select Create new task folder.
- Enter a unique name and choose a project.
You can:
- Open a task for editing, click Back, and change the folder.
- Drag and drop tasks between folders directly in the view.
To remove a folder, right-click it and select Delete.
Warning: All tasks inside will also be deleted. Deleted tasks can’t be restored.
-
Views
-
Search
-
Data management
-
Usability enhancements
-
Security
-
Projects
- Sample Database
- Database Connections
- Local Client Configuration
- Connection types
- Configure Connection Initialization Settings
-
Tableau integration
- Transactions
- Drivers
- Tasks
-
Cloud Explorer
-
Cloud Storage
- Classic
- Cloud
- Embedded
- File drivers
- Changing interface language
- DBeaver extensions - Office, Debugger, SVG
- Installing extensions - Themes, version control, etc
- User Interface Themes
- Command Line
- Reset UI settings
- Reset workspace
- Troubleshooting system issues
- Posting issues
- Log files
- JDBC trace
- Thread dump
- Managing connections
- Managing variables
- Managing drivers
- Managing preferences
- Managing restrictions
- Windows Silent Install
- Snap installation