Skip to content

README.md

Latest commit

 

History

History
144 lines (109 loc) · 5.64 KB

README.md

File metadata and controls

144 lines (109 loc) · 5.64 KB
layout default
title NocoDB Database Platform
nav_order 38
has_children true
format_version v2

NocoDB: Deep Dive Tutorial

Project: NocoDB — An open-source Airtable alternative that turns any database into a smart spreadsheet.

Stars License: AGPL v3 Node.js

Why This Track Matters

NocoDB lets teams build collaborative no-code applications on top of their existing databases without rewriting their data layer — turning any SQL database into an Airtable-like interface with auto-generated APIs.

This track focuses on:

  • connecting NocoDB to MySQL, PostgreSQL, SQLite, and SQL Server
  • understanding automatic REST API generation from database schemas
  • implementing RBAC, authentication, and audit logging
  • deploying NocoDB with Docker for full self-hosted data ownership

What Is NocoDB?

NocoDB transforms any SQL database (MySQL, PostgreSQL, SQL Server, SQLite) into a spreadsheet-like interface with auto-generated REST APIs. It provides a no-code layer over existing databases, enabling teams to build applications without rewriting their data layer.

Feature Description
Database Abstraction Connect to MySQL, PostgreSQL, SQL Server, SQLite
Spreadsheet UI Grid, gallery, kanban, and form views
Auto REST API Automatic API generation from database schema
Collaboration Real-time multi-user editing with roles and permissions
Plugin System Extensible with custom field types and integrations
Self-Hosted Full Docker deployment, data stays on your infrastructure

Mental Model

graph TB
    subgraph Frontend["Vue.js Frontend"]
        GRID[Grid View]
        GALLERY[Gallery View]
        KANBAN[Kanban View]
        FORM[Form Builder]
    end

    subgraph Backend["Node.js Backend"]
        API[REST API Engine]
        QB[Query Builder]
        SCHEMA[Schema Manager]
        AUTH[Auth & Roles]
    end

    subgraph Databases["Connected Databases"]
        PG[(PostgreSQL)]
        MYSQL[(MySQL)]
        SQLITE[(SQLite)]
        MSSQL[(SQL Server)]
    end

    Frontend --> Backend
    Backend --> Databases
Loading

Chapter Guide

Chapter Topic What You'll Learn
1. System Overview Architecture NocoDB's approach to database abstraction
2. Database Abstraction Connectors Multi-database support and schema mapping
3. Schema Management Data Model Dynamic table/field handling and migrations
4. API Generation APIs Automatic REST endpoint creation
5. Query Builder Querying Translating UI/API filters into SQL safely
6. Auth System Security Authentication, RBAC, and auditability
7. Vue Components Frontend Grid/editor component architecture
8. Realtime Features Collaboration Event streams, optimistic updates, and conflict handling

Tech Stack

Component Technology
Backend Node.js, Express, Knex.js
Frontend Vue.js, Nuxt
Databases PostgreSQL, MySQL, SQLite, SQL Server
Auth JWT, role-based access control
Deployment Docker, npm

Ready to begin? Start with Chapter 1: System Overview.

Built with insights from the NocoDB repository and community documentation.

Related Tutorials

Navigation & Backlinks

Full Chapter Map

  1. Chapter 1: NocoDB System Overview
  2. Chapter 2: Database Abstraction Layer
  3. Chapter 3: Schema Management
  4. Chapter 4: API Generation Engine
  5. Chapter 5: Query Builder
  6. Chapter 6: Auth System
  7. Chapter 7: Vue Components
  8. Chapter 8: Realtime Features

Current Snapshot (auto-updated)

What You Will Learn

  • how NocoDB abstracts multiple SQL databases behind a unified spreadsheet-like interface
  • how automatic REST API generation works from existing database schemas
  • how the query builder safely translates UI filters into parameterized SQL
  • how to implement RBAC, configure authentication, and deploy NocoDB with Docker

Source References

Generated by AI Codebase Knowledge Builder