Install a database driver

Prepare a package from Git, review it and confirm application. Restart the server after installation to load the engine.

Installation

1. Open Databases and choose Driver, the Install driver from Git… action in the panel header.
2. Enter the repository address and select a stable vX.Y.Z version. The GrigDesk server needs access to the source, including private repositories.
3. Prepare the package and review its engine, version, source, warnings and changes. The entry point does not execute before application.
4. Confirm installation separately and wait for the result.
5. Restart the GrigDesk server manually. Refreshing a page or list does not load drivers.
6. Create a database profile, select the engine and verify a connection.

Packages use an engine.json manifest. A driver runs with server process privileges and receives connection passwords and an SSH channel when used. Install packages from trusted sources.

Updates and rollback

Select an external engine in the profile form. Its Source and updates block shows available actions. Prepare an update or restore the previous version, review the package and confirm replacement separately.

Close that engine's sessions before applying changes. An opening, active or closing connection blocks replacement with engine_busy. A successful replacement requires another manual server restart. Other engines can continue working until then.

If the engine is missing

Check the installation result and server restart, then the panel diagnostics. Possible causes include an incompatible version, an invalid manifest or entry point, or an incomplete adapter contract. An external package cannot use a built-in engine's id: a custom MySQL adapter, for example, needs a different identifier.

Next: driver structure · build your own.