Skip to content

Instantly share code, notes, and snippets.

@SoMaCoSF
Created December 22, 2024 06:28
Show Gist options
  • Select an option

  • Save SoMaCoSF/0ef2e8812ae81d2b13fb6401a706150d to your computer and use it in GitHub Desktop.

Select an option

Save SoMaCoSF/0ef2e8812ae81d2b13fb6401a706150d to your computer and use it in GitHub Desktop.
Cursor Database Documentation Standards
---
title: "Database Documentation Standards"
author: "Cursor Development Team"
date: "`r format(Sys.time(), '%B %d, %Y')`"
output:
html_document:
theme: united
toc: true
toc_float: true
---
# Database Documentation Standards
## Schema Documentation
### Required Mermaid Diagrams
```mermaid
erDiagram
USERS ||--o{ POSTS : creates
USERS ||--o{ COMMENTS : writes
POSTS ||--o{ COMMENTS : has
```
### Database Overview Table
| Database | Schema | Description | Tables | Owner |
|----------|---------|-------------|---------|--------|
| app_db | public | Core application data | 15 | app_user |
| app_db | audit | Audit logging | 5 | app_user |
| analytics | public | Analytics data | 8 | analytics_user |
## Migration Management
### Migration History
```sql
-- Example migration
CREATE TABLE users (
id SERIAL PRIMARY KEY,
username VARCHAR(50) UNIQUE NOT NULL,
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);
```
### Rollback Procedures
```sql
-- Example rollback
DROP TABLE users;
```
## Performance Monitoring
### Key Metrics
- Query execution time
- Index usage statistics
- Table size growth
- Cache hit ratios
### Maintenance Procedures
1. Regular vacuum
2. Index maintenance
3. Statistics updates
4. Performance tuning
## Security
### Access Control
- Role-based permissions
- Connection security
- Audit logging
- Data encryption
### Backup Procedures
1. Daily full backups
2. Point-in-time recovery
3. Backup verification
4. Retention policies
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment