nocobase-app-plugin-database-explorer

Browse database connections, collections, and fields read-only through a NocoBase settings page.

9|3|Updated Aug 14, 2026
One-click install
npx skills add https://github.com/nocobase/nocobase3 --skill nocobase-app-plugin-database-explorer-nocobase
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: nocobase-app-plugin-database-explorer
Source: https://github.com/nocobase/nocobase3/tree/main/packages/plugins/app-plugin-database-explorer/skills/nocobase-app-plugin-database-explorer
Command: npx skills add https://github.com/nocobase/nocobase3 --skill nocobase-app-plugin-database-explorer-nocobase

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires @nocobase/app-plugin-authentication, @nocobase/app-plugin-authorization.

What problem does it solve? Teams need visibility into which databases an application connects to, what collections exist on each connection, and what fields and physical columns a collection has, without granting write access or exposing credentials. This Skill provides a read-only Database Explorer page and API for that inspection, with role-based access control. ## Core Features & Use Cases - Connection and Collection Browsing: List every configured database connection, page through collections per connection, and inspect a collection's resolved definition, fields, and physical columns, indexes, keys, and constraints. - Role-Based Access: Grant non-administrator roles access to the /settings/database-explorer page with a single permission grant that governs both the navigation entry and the API endpoints. - Credential Safety by Default: Connection responses use an allow-list that never exposes passwords, hosts, ports, socket paths, TLS material, or pool settings. - Use Case: A support engineer needs to verify which physical columns exist on a production collection without touching the schema. Grant their role the database-explorer page access, then open the settings page or call GET /api/database-explorer/connections/:connection/collections/:collection/physical. ## Quick Start Register the database explorer plugin on both the server and client composition roots, then ask the assistant to list the application's database connections and inspect a collection's fields.

Frequently Asked Questions about nocobase-app-plugin-database-explorer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I browse database collections in a NocoBase application?▼

Register the database explorer plugin on both server and client composition roots, then open the settings page at /settings/database-explorer or call GET /api/database-explorer/connections/:connection/collections. Results are paginated with a limit of 1-200 and an opaque cursor.

How do I grant a non-admin role access to the database explorer page?▼

Add one grant to the role's permission set with resource type page, id database-explorer, and action access. The same grant governs the navigation entry and all four read endpoints, so nothing else needs alignment.

Does the database explorer expose database credentials or connection details?▼

No. Connection responses use an allow-list that excludes passwords, user names, hosts, ports, socket paths, SQLite filenames, TLS material, driver options, and pool settings. Driver errors are logged by classification only, never by message or cause.

Can the database explorer modify collections or data?▼

No. The plugin has no write endpoint and cannot create, alter, or drop collections or change rows. The only side effect is that a first read may create the __nocobase_collection_metadata bookkeeping table on a managed connection.

Why does the database explorer return 503 DATABASE_UNAVAILABLE?▼

Every endpoint returns 503 DATABASE_UNAVAILABLE when the application is configured with database.default set to none. Other error codes include CONNECTION_NOT_FOUND, CONNECTION_UNREACHABLE, SCHEMA_READ_DENIED, and INVALID_CURSOR.