Ghost/ghost/database-info/README.md
Daniel Lockyer 70ecba06ca Added @trghost/database-info package
refs https://github.com/TryGhost/Toolbox/issues/175

- this library is a small utility around `knex` that returns info on the
  database used - particularly, the version used
- this will initially be used within Ghost but it can be extended to
  other databases and projects if needed
2022-01-18 09:06:44 +00:00

740 B

Database Info

@tryghost/database-info is a small utility for knex that returns information on the underlying DB connection.

It currently works with SQLite, MySQL 5 & 8, and MariaDB.

Install

npm install @tryghost/database-info --save

or

yarn add @tryghost/database-info

Usage

Develop

This is a mono repository, managed with lerna.

Follow the instructions for the top-level repo.

  1. git clone this repo & cd into it as usual
  2. Run yarn to install top-level dependencies.

Run

  • yarn dev

Test

  • yarn lint run just eslint
  • yarn test run lint and tests

Copyright & License

Copyright (c) 2013-2022 Ghost Foundation - Released under the MIT license.