UNPKG

plugin-postgresql-connector

Version:

NocoBase plugin for connecting to external PostgreSQL databases

162 lines (128 loc) 5.14 kB
# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [0.1.1] - 2024-06-16 ### Changed - Updated NocoBase dependencies from 0.15.0-alpha.5 to ^1.7.10 for compatibility with NocoBase v1.7.10 - Updated peerDependencies to require NocoBase >=1.7.0 ### Fixed - Fixed plugin dependencies check error when uploading to NocoBase v1.7.10 ## [0.1.0] - 2024-06-16 ### Added - Initial release of PostgreSQL Connector Plugin - Connection management for external PostgreSQL databases - Query builder with syntax highlighting - Schema browser for tables, views, functions - Saved queries functionality - Security features with encrypted connection credentials - Multi-language support (English/Vietnamese) ### Features - **Connection Management**: Create, test, and manage multiple PostgreSQL connections - **Query Execution**: Execute SQL queries with parameter support - **Schema Browser**: Browse database objects and generate queries - **Query Builder**: Advanced SQL editor with auto-completion - **Result Viewer**: Tabular display of query results with pagination - **Saved Queries**: Save and organize frequently used queries - **Security**: Encrypted password storage and SQL injection prevention ## [1.0.0] - 2024-12-01 ### Added - **Phase 1: Project Setup** - Plugin structure initialization - Database models (Connection, SavedQuery) - Migration files for schema setup - TypeScript configuration - Package.json with dependencies - Internationalization files (en-US, vi-VN) - README and CHANGELOG documentation ### Features in Development - **Phase 2: Core Services** (Planned) - ConnectionManager service with connection pooling - QueryExecutor service for SQL execution - PostgreSQL service integration - **Phase 3: API Controllers** (Planned) - Connection management API endpoints - Query execution API endpoints - Schema browsing API endpoints - **Phase 4: Frontend Components** (Planned) - Connection form component - Query builder with SQL editor - Result viewer component - Schema browser component - **Phase 5: Integration** (Planned) - Plugin registration with NocoBase - Menu integration - Frontend-backend integration - **Phase 6: Testing & Documentation** (Planned) - Unit tests for services and controllers - Integration tests for API endpoints - Complete documentation - Performance optimization ### Technical Details - **Backend Dependencies**: pg, joi, crypto-js, sql-formatter - **Frontend Dependencies**: antd, react-ace, ace-builds - **Development Tools**: TypeScript, Jest, ESLint - **Security**: AES password encryption, SQL injection prevention - **Performance**: Connection pooling, query optimization ### Known Issues - Linter errors for missing NocoBase dependencies (expected in development phase) - Models require NocoBase framework integration for full functionality ### Migration Notes - First release - no migration required - Database tables will be created automatically on plugin installation --- ## Development Phases ### ✅ Phase 1: Project Setup (Week 1) - [x] Plugin structure creation - [x] Database models definition - [x] Migration files - [x] Configuration files - [x] Documentation setup ### 🔄 Phase 2: Core Services (Week 2) - [ ] ConnectionManager implementation - [ ] QueryExecutor implementation - [ ] PostgreSQL service integration - [ ] Connection pooling setup ### ⏳ Phase 3: API Controllers (Week 2-3) - [ ] Connection management endpoints - [ ] Query execution endpoints - [ ] Schema browsing endpoints - [ ] Validation and error handling ### ⏳ Phase 4: Frontend Components (Week 3-4) - [ ] Connection form component - [ ] Query builder component - [ ] Result viewer component - [ ] Schema browser component ### ⏳ Phase 5: Integration (Week 5) - [ ] Plugin registration - [ ] Menu integration - [ ] Frontend-backend integration - [ ] Testing and debugging ### ⏳ Phase 6: Testing & Documentation (Week 6) - [ ] Unit tests - [ ] Integration tests - [ ] Performance testing - [ ] Complete documentation --- ## Future Enhancements ### Version 1.1.0 (Planned) - Query history management - Query templates - Export functionality (CSV, Excel, JSON) - Advanced query builder with visual interface ### Version 1.2.0 (Planned) - Data visualization (charts and graphs) - Scheduled query execution - Real-time data updates via WebSocket - Query performance analysis ### Version 2.0.0 (Planned) - Multi-database support (MySQL, SQL Server, Oracle) - Advanced security features - Plugin API for extensions - Enterprise features --- ## Support For questions, issues, or contributions: - 📖 [Documentation](https://docs.nocobase.com) - 🐛 [Issue Tracker](https://github.com/nocobase/nocobase/issues) - 💬 [Community Forum](https://forum.nocobase.com)