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 Introduction guide.

Features

Command Line Interface

• Easily manage your databases with the platformatic db CLI.

Multiple Database Support

• Integration with multiple database systems
• Efficient Database migrations

REST/OpenAPI

• Automatically generate a REST API from your database schema.
• Access interactive documentation via Scalar.
• Generate OpenAPI 3.0 schema.

GraphQL

• Create a GraphQL API directly from your database schema.
• Extend your API with Apollo Federation.
• Explore your API with the web-based GraphiQL IDE.

Authentication and Authorization

• Secure your APIs with advanced methods such as JWT, Webhooks, and HTTP Headers (for development use).
• Implement role-based access control (RBAC) authorization.

Complete flexibility

• Add custom functionality in a Fastify plugin.
• Interact with your database via mapped entities or execute raw SQL queries.
• Develop plugins in JavaScript or TypeScript.
• Automatically generate types based on SQL tables.

Usage

• Integrate Platformatic DB programmatically into your tests or other applications for more dynamic usage.

info

Ready to start? Dive into our Quick Start Guide and get your API up and running in just 2 minutes! ⚡

Supported databases

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

The database driver is automatically loaded based on the value connectionString configuration setting.

Issues

If you run into a bug or have a suggestion for improvement, please raise an issue on GitHub or join our Discord feedback channel.