Key Concepts
Understand the core building blocks of Lordbase.
The Lordbase Hierarchyβ
Lordbase organizes resources in a hierarchical structure designed for multi-tenancy and scalability.
1. Workspacesβ
A Workspace is your top-level organizational unit and multi-tenant container. It acts as a security boundary for all your resources.
- Isolation: Databases, users, backups, and settings in one workspace are completely separate from those in another.
- Collaboration: Invite team members to manage databases together. The workspace creator is the Owner, while invited developers are assigned Admin or Member roles.
- Environment Management: Use separate workspaces for
Development,Staging, andProductionto ensure total separation.
| Role | Permissions |
|---|---|
| Owner | Full access, manage members, delete workspace |
| Admin | Manage databases, backups, and users |
| Member | Read access, basic database operations |
π Learn more: Managing Workspaces
2. Databasesβ
A Database represents a provisioned database instance on the Lordbase infrastructure. Each database is an isolated instance with its own credentials, users, and configuration.
- Multi-Engine: Choose from PostgreSQL, Redis, or MongoDB.
- Auto-Provisioning: Database names, admin credentials, and connection details are auto-generated.
- Status Lifecycle: Databases transition through
creating β active β paused β deleting β deletedstates. - Storage Limits: Each database has configurable storage and connection limits based on your plan.
| Property | Description |
|---|---|
| Display Name | Human-readable name you choose |
| Database Name | Auto-generated unique identifier (e.g., lb_a1b2c3d4e5f6) |
| Engine | PostgreSQL, Redis, or MongoDB |
| Connection String | Ready-to-use connection URI |
π Learn more: Database Management
3. Database Usersβ
Database Users are per-database accounts with fine-grained permission levels. They allow team members or services to connect with appropriate access.
- Permission Levels:
Read Only,Read/Write, orAdmin. - Per-Database Scope: Each user is scoped to a single database.
- Password Management: Passwords can be reset at any time from the Dashboard.
π Learn more: Database Users
4. Backupsβ
Lordbase provides both manual and scheduled backups for data protection.
- Manual Backups: Create on-demand snapshots for migration or safety.
- Scheduled Backups: Configure hourly, daily, weekly, or monthly backup schedules.
- Retention Policies: Define how many backups to keep per schedule.
- Restore: Restore any completed backup to its source database.
π Learn more: Backups
5. Monitoring & Analyticsβ
Lordbase provides real-time visibility into your database performance.
- Metrics: Storage usage, active connections, cache hit ratio, transaction counts.
- Query Analytics: Slow query detection, query statistics, active query monitoring.
- Audit Logs: Complete audit trail of all actions (create, delete, modify) on your resources.
π Learn more: Monitoring
6. Connection Poolingβ
For PostgreSQL databases, Lordbase includes built-in PgBouncer connection pooling.
- Efficient Connections: Reuse database connections to reduce overhead.
- Pool Monitoring: View active clients, server connections, and pool health.
- Transparent: Connect through the pooler port instead of the direct PostgreSQL port.
π Learn more: Connection Pooling
7. Developer Access Tokensβ
Developer Access Tokens (Personal Access Tokens) allow programmatic API access for automation.
- Scoped Permissions: Grant specific access levels (
api,read_databases,write_backups, etc.). - Expiration: Set optional expiration dates for security.
- CI/CD Ready: Use tokens in build pipelines and infrastructure scripts.
π Learn more: Developer Access Tokens
Next Stepsβ
- Setup Checklist - Get your first database running in 5 minutes.
- Dashboard Overview - Learn how to manage your workspace.
- Any Language Quickstart - Start provisioning databases with the API.