Apache AGE for VS Code

Official Marketplace Icon

Query Apache AGE graph databases with Cypher — directly from VS Code.

Write Cypher queries with syntax highlighting and snippets, execute them against PostgreSQL + AGE, and visualize results as interactive graphs or sortable tables.

Features

Cypher Editing

• Full syntax highlighting for Cypher (.cypher, .cql, .age files)
• 22 code snippets including common patterns (MATCH, CREATE, MERGE, shortestPath) and AGE-specific wrapped SQL queries
• Bracket matching, comment toggling, and auto-closing pairs

Connection Management

• Add, edit, and remove PostgreSQL + AGE connection profiles
• Secure password storage using VS Code's built-in SecretStorage API
• Connection pooling with configurable pool size and idle timeout
• Switch between graphs on the same database

Query Execution

• Run full file — Cmd+Enter (macOS) / Ctrl+Enter
• Run selection — Cmd+Shift+Enter / Ctrl+Shift+Enter
• Explain query — view EXPLAIN ANALYZE output
• Automatic Cypher → SQL wrapping (SELECT * FROM cypher(...)) — no manual wrapping needed
• Raw SQL passthrough when needed

Results Table

• Sortable HTML table with VS Code theme integration
• Vertices displayed as ⊙ :Label {props}, edges as → :Label {props}
• CSV and JSON export
• Double-click cells to copy values

Graph Visualization

• Interactive graph rendering powered by Cytoscape.js
• Auto-extracts vertices and edges from query results
• 5 layout algorithms: force-directed, circle, grid, hierarchy, concentric
• Color-coded nodes by label
• Click nodes/edges to inspect properties
• PNG export

Schema Explorer

• Browse graphs, node labels, and edge labels in the sidebar
• Approximate row counts per label
• Click a label to query all nodes/edges of that type

Requirements

• VS Code 1.85.0 or later
• PostgreSQL with Apache AGE extension installed
• Node.js 18+ (for extension development only)

Network Access (Graph View)

The graph visualization webview loads Cytoscape.js from the CDN at:

• https://cdnjs.cloudflare.com/ajax/libs/cytoscape/3.30.4/cytoscape.min.js

If your environment is offline or blocks external CDNs, query execution and table results still work, but the graph view will not render until that URL is reachable.

Getting Started

1. Install the extension (F5 to run in development, or install the .vsix package)
2. Open the Apache AGE view in the Activity Bar
3. Click Add Connection and enter your PostgreSQL + AGE database details
4. Connect and select a graph
5. Open or create a .cypher file and start writing queries
6. Press Cmd+Enter to execute

Extension Settings

Commands

Development

# Install dependencies
npm install

# Build (esbuild → dist/extension.js)
npm run build

# Watch mode
npm run watch

# Type-check
npm run lint

# Run tests
npm test

# Package as .vsix
npm run package

Press F5 in VS Code to launch the Extension Development Host for testing.

Architecture

The extension follows a strict layered architecture:

src/
├── core/          # Domain logic — zero vscode imports
├── commands/      # VS Code command handlers
├── providers/     # TreeDataProviders, StatusBar
├── panels/        # WebviewPanels (results table, graph view)
├── utils/         # SecretStorage, SQL template loader
└── extension.ts   # Wiring — activate() / deactivate()

Core domain classes (ConnectionPool, QueryExecutor, AgtypeDeserializer, etc.) have no VS Code dependency, enabling unit testing with Vitest and potential reuse outside the extension.

License

Apache-2.0