Platformatic DB

Platformatic DB is an HTTP server that provides a flexible set of tools for building robust APIs with Node.js.

For a high level overview of how Platformatic DB works, please reference the Architecture guide.

Features

• Command-line interface: platformatic db
• Support for multiple database systems
• Database migrations
• REST/OpenAPI
  • Automatic REST API from your database schema
  • Interactive documentation (Swagger UI)
  • OpenAPI 3.0 schema
• GraphQL
  • Automatic GraphQL API from your database schema
  • Support for Apollo Federation
  • Web based GraphQL IDE (GraphiQL)
  • Generated GraphQL schema
• Authentication & authorization
  • Supported methods: JWT, Webhook, HTTP Headers (development only)
  • Authorization via role based access control (RBAC)
• Complete flexibility
  • Add custom functionality in a Fastify plugin
  • Execute database operations via mapped entities
  • Write and execute raw SQL queries
  • Write plugins in JavaScript or TypeScript
  • Automatic generation of types based on the SQL tables
• Start Platformatic DB programmatically in tests or other applications

info

Get up and running in 2 minutes using our Quick Start Guide ⚡

Supported databases

Database	Version
SQLite	3.
PostgreSQL	>= 15
MySQL	>= 5.7
MariaDB	>= 10.11

The required database driver is automatically inferred and loaded based on the value of the connectionString configuration setting.

Issues

If you run into a bug or have a suggestion for improvement, please raise an issue on GitHub.