# @sqltools/base-driver

> SQLTools Base Driver

Latest version **0.2.4** (published 2026-06-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install @sqltools/base-driver
pnpm add @sqltools/base-driver
yarn add @sqltools/base-driver
bun add @sqltools/base-driver
```

## Health

**Score 55/100 (C)** — status: active.

Positive: has types; no vulnerabilities; high maintenance score.

Warnings: low downloads; no esm support; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.2.4 |
| Published | 2026-06-10 |
| First published | 2020-05-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 21.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1767 |
| Author | Matheus Teixeira |
| Maintainers | mtxr, gjsjohnmurray |

## Links

- npm: https://www.npmjs.com/package/@sqltools/base-driver
- Repository: https://github.com/mtxr/vscode-sqltools
- Homepage: https://vscode-sqltools.mteixeira.dev/?umd_source=npm&utm_medium=pkgjson&utm_campaign=base-driver
- Issues: https://github.com/mtxr/vscode-sqltools/issues
- npm.io page: https://npm.io/package/@sqltools/base-driver

## Dependencies (8)

- [resolve](https://npm.io/package/resolve.md) ^1.17.0
- [make-dir](https://npm.io/package/make-dir.md) ^3.1.0
- [env-paths](https://npm.io/package/env-paths.md) ^2.2.0
- [tunnel-ssh](https://npm.io/package/tunnel-ssh.md) ^5.2.0
- [vscode-uri](https://npm.io/package/vscode-uri.md) ^3.0.3
- [@sqltools/log](https://npm.io/package/@sqltools/log.md) latest
- [@sqltools/types](https://npm.io/package/@sqltools/types.md) ^0.2.1
- [vscode-languageserver](https://npm.io/package/vscode-languageserver.md) 6.1.1

## Recent versions

- 0.2.4 (latest) — 2026-06-10
- 0.1.11-beta3 (beta) — 2022-09-09
- 0.2.3 — 2025-09-10
- 0.2.2 — 2025-05-19
- 0.2.1 — 2025-05-19
- 0.2.0 — 2025-04-16
- 0.1.11 — 2022-09-09
- 0.1.11-beta2 — 2022-09-09
- 0.1.11-beta1 — 2022-09-09
- 0.1.10 — 2020-08-04
- 0.1.9-beta2 — 2020-08-04
- 0.1.9 — 2020-08-04
- 0.1.8 — 2020-06-22
- 0.1.7 — 2020-06-20
- 0.1.6 — 2020-06-08
- … 16 more at https://npm.io/package/@sqltools/base-driver/versions

## README

# SQLTools Base Driver

This package is part of [vscode-sqltools](https://vscode-sqltools.mteixeira.dev/?umd_source=repository&utm_medium=readme&utm_campaign=base-driver) extension.

## Creating icon

PNG Images
Size: 64x64px
Default Icon: Opacity 100%, no margins and paddings
Active icon: Opacity 100%, no margins and paddings, green (#00FF00) circle 24x24 bottom right
Inactive icon: Opacity 50%, no margins and paddings

## Changelog

### v0.2.4

- Use @sqltools/types@0.2.1.
- Support `passphrase` for private key.

### v0.2.3

- Support SSH tunnel that uses password.

### v0.2.2

- createSshTunnel needs to be public rather than protected.

### v0.2.1

- Use @sqltools/types@0.2.0.

### v0.2.0

- Added SSH tunneling support.

### v0.1.11

- Fix `toAbsolutePath` for Windows by using `vscode-uri`.

### v0.1.9

- Update log utility to use `@sqltools/log`.

### v0.1.8

- Using [resolve](https://www.npmjs.com/package/resolve) lib as resolver and exposed custom require and resolve functions.

### v0.1.7

- Fixes node require not working for dependencies.

### v0.1.6

- Fixes driver always asking for node runtime.

### v0.1.4

- Update @sqltool/types fixing `checkDependencies` being requred. It's optional

### v0.1.3

- Fix dynamic dependecy require issue.

### v0.1.2

First official release

---
_Source: https://npm.io/package/@sqltools/base-driver · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._