Skip to content

dev-asterix/yape-postgres-ext-vsc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

51 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

PostgreSQL Explorer for VS Code - Status

Version Downloads Rating

A powerful PostgreSQL database explorer with interactive SQL notebooks, table visualization, and data export capabilities.

✨ Implemented Features

πŸ”Œ Database Connection

  • Secure credential storage using VS Code SecretStorage
  • Multiple database connection support
  • Connection management through UI

πŸ“Š SQL Notebooks

  • Interactive SQL query execution in notebook cells
  • Rich tabular output with formatted data
  • Export results to CSV and Excel formats
  • Query execution status and result counts

🌳 Database Explorer

  • Tree view navigation of databases, schemas, and tables
  • Table and view operations through context menus
  • Function management and execution
  • Schema-level operations

πŸ“‹ Object Properties

  • Detailed table structure view with column information
  • View definition display
  • Function properties and definition view
  • Toggle between table view and SQL script view

πŸ’Ύ Data Management

  • Table data viewing and export
  • View data querying
  • Function execution with parameters
  • Data export to CSV and Excel

🎯 Future Milestones

Connection Enhancements

  • Auto-reconnect capability
  • Connection health monitoring
  • Connection pooling
  • SSL/TLS support

Query Features

  • Query history
  • Query plan visualization
  • Saved queries library
  • Query parameter support

Performance Improvements

  • Large dataset pagination
  • Lazy loading of tree items
  • Query timeout handling
  • Background task execution

Data Management

  • Bulk data import wizard
  • Support for more export formats (JSON, XML)
  • Schema export/import functionality
  • Custom data transformations
  • Data streaming for large exports

Data Visualization

  • Basic charting capabilities
  • Result set visualizations
  • Data statistics and summaries
  • Custom visualization plugins

UI Enhancements

  • Dark/light theme support
  • Custom SQL syntax highlighting
  • Custom icons for database objects
  • Theme extension API
  • Multi-root workspace support
  • Workspace-specific settings

πŸš€ Quick Start

1. Connect to Your Database

  1. Click the PostgreSQL icon in the Activity Bar (or press Ctrl+Shift+P and search for "PostgreSQL: Add Connection")
  2. Click the "+" button to add a new connection
  3. Enter your connection details:
    Host: localhost (or your database host)
    Port: 5432 (default PostgreSQL port)
    Username: your_username
    Password: your_password
    Database: your_database
    
  4. Save the connection

2. Explore Your Database

  • Expand the connection in the tree view to see databases
  • Navigate through schemas and tables
  • Right-click items for context actions

3. Create SQL Notebooks

  1. Right-click on any database, schema, or table
  2. Select "New PostgreSQL Notebook"
  3. Write SQL in notebook cells:
    -- Example query
    SELECT * FROM users
    WHERE created_at >= NOW() - INTERVAL '7 days'
    ORDER BY created_at DESC;
  4. Press Ctrl+Enter to execute a cell

4. Work with Results

  • Click column headers to sort results
  • Use the export buttons to save data:
    • CSV: For spreadsheet applications
    • Excel: For Microsoft Excel

πŸ’‘ Pro Tips

  1. Quick Table Info

    • Click any table in the explorer to see its structure
    • Hover over columns to see data types and constraints
  2. Efficient Querying

    • Use table names from the explorer (drag & drop supported)
    • Save commonly used queries in notebooks
    • Use multiple cells for complex operations
  3. Data Export

    • Large result sets are automatically paginated
    • Exports preserve data types and formatting
    • Files are saved in your workspace root

βš™οΈ Extension Settings

Customize through VS Code settings (Ctrl+,):

{
  "postgresExplorer.connections": [],     // Saved connections
  "postgresExplorer.autoConnect": true,  // Auto-connect on startup
  "postgresExplorer.maxResults": 1000    // Max rows per query
}

πŸ”§ Troubleshooting

Common Issues

  1. Connection Failed

    • Verify host and port are correct
    • Check username and password
    • Ensure database server is running
    • Check firewall settings
  2. Query Timeout

    • Reduce the data set with WHERE clauses
    • Use LIMIT to restrict results
    • Consider indexing frequently queried columns
  3. Export Issues

    • Ensure write permissions in workspace
    • Close files in other applications
    • Check available disk space

πŸ“ License

This extension is licensed under the MIT License.

🀝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

πŸ“« Support


Enjoying the extension? Rate us on the marketplace ⭐

Packages

No packages published

Contributors 2

  •  
  •  

Languages