🛫 Ramco Aviation SQL Stored Procedure Review
Ramco Aviation SQL Stored Procedure Standard Copilot is an AI-powered Visual Studio Code extension that reviews SQL stored procedures against Aviation Enterprise coding standards and best practices.
✨ Features
🔍 Comprehensive Code Analysis
- SQL Enlight: Guidelines loaded from SQL Enlight Analysis Template
🎯 Enterprise-Grade Features
- Real-time Feedback: Get instant feedback directly in your editor
- Aviation Standards Compliance: Aligned with Ramco Aviation Enterprise coding standards
- Multiple Trigger Options: Manual review, auto-review on save, or on file open
- Quality Metrics: Complexity, maintainability, and compliance scoring
- Actionable Suggestions: Detailed recommendations with code examples
🚀 Getting Started
Installation
- Install the extension from VS Code Marketplace (or install via
.vsix file)
- Open any SQL stored procedure file
- Configure Authentication Token (First-time setup):
- You'll be prompted to enter your authentication token
- Or manually configure via Command Palette:
Ctrl+Shift+P → "Configure Authentication Token"
- Enter your token when prompted (input is hidden for security)
- Look for the "🛫 Review with Ramco Aviation Copilot" button at the top of your file
🔐 Authentication Setup
First-Time Configuration:
- When you first use the extension, you'll be prompted to enter your authentication token
- Click "Set Token Now" to configure immediately, or "Later" to postpone
- Your token is stored securely using VS Code's SecretStorage API (encrypted)
Manual Token Configuration:
- Open Command Palette (
Ctrl+Shift+P or Cmd+Shift+P)
- Type "Ramco Aviation: Configure Authentication Token"
- Enter your token in the input box (hidden for security)
- Click Enter to save
Update Token:
- Use the same "Configure Authentication Token" command to update your token
- Old token will be replaced automatically
Clear Token:
- Command Palette → "Ramco Aviation: Clear Authentication Token"
- Useful when switching accounts or decommissioning
Security Notes:
- Tokens are stored encrypted using VS Code's secure storage
- Tokens are never logged or displayed in plain text
- Each workspace can have its own token configuration
Usage
Simply click the "🛫 Review with Ramco Aviation Copilot" button at the top of any SQL file.
Method 2: Command Palette
- Press
Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (Mac)
- Type "Review SQL Stored Procedure"
- Press Enter
Right-click in any SQL file and select "Review SQL Stored Procedure"
Method 4: Status Bar
Click the "🚀 Ramco Aviation SQL" button in the status bar (bottom-right)
Viewing Results
- Inline Diagnostics: Issues appear with colored squiggly lines in your code
- 🔴 Red: Critical errors
- 🟡 Yellow: Warnings
- 🔵 Blue: Information/Suggestions
- Problems Panel: View all issues in the Problems panel (
Ctrl+Shift+M)
- Output Panel: Detailed summary with metrics in "Ramco SQL Review" output channel
⚙️ Configuration
Access settings via: File > Preferences > Settings > Search for "Ramco"
Available Settings
| Setting |
Default |
Description |
ramco-sql-review.autoReviewOnSave |
false |
Auto-review when saving SQL files |
ramco-sql-review.autoReviewOnOpen |
false |
Auto-review when opening SQL files |
ramco-sql-review.showCodeLens |
true |
Show CodeLens button at top of files |
ramco-sql-review.analysisTypes |
All enabled |
Select which analysis types to run |
ramco-sql-review.apiEndpoint |
UAT endpoint |
API endpoint URL |
ramco-sql-review.timeout |
30000 |
API timeout in milliseconds |
📊 Understanding Results
Issue Categories
| Icon |
Category |
Description |
| 📝 |
Naming Conventions |
Variable, parameter, and procedure naming standards |
| 🛡️ |
Error Handling |
TRY-CATCH blocks, error messages, and logging |
| 🔄 |
Transaction Safety |
BEGIN TRAN, COMMIT, ROLLBACK patterns |
| ⚡ |
Performance |
Query optimization, indexing, cursors |
| 📖 |
Readability |
Comments, formatting, code organization |
| 🔒 |
Security |
SQL injection, permissions, data exposure |
Severity Levels
- Error (❌): Must be fixed - violates critical standards
- Warning (⚠️): Should be fixed - affects quality/performance
- Info (ℹ️): Consider fixing - best practice suggestions
- Hint (💡): Optional improvements
Quality Metrics
- Complexity Score: Code complexity (0-100, higher is better)
- Maintainability Score: How easy to maintain (0-100)
- Compliance Score: Standards adherence percentage
🔌 API Integration
🎯 Use Cases
For Developers
- Get instant feedback while writing stored procedures
- Learn Aviation coding standards through suggestions
- Catch errors before code review
- Improve code quality incrementally
For Code Reviewers
- Consistent review standards across team
- Focus on business logic instead of syntax
- Automated compliance checking
- Detailed documentation of issues
For Team Leads
- Enforce coding standards automatically
- Track code quality metrics
- Identify training needs
- Maintain consistent quality across projects
🛠️ Troubleshooting
Extension Not Working
- Verify you're editing a
.sql file
- Check if extension is activated (check status bar)
- Review extension logs in Output panel
API Connection Issues
- Check network connectivity
- Verify API endpoint in settings
- Check timeout settings
- Review output logs for error details
No Diagnostics Appearing
- Run review command manually
- Check if auto-review is enabled
- Clear old diagnostics using "Clear Review Diagnostics"
- Restart VS Code
📝 Example Workflow
- Open SQL File: Open any stored procedure
- Run Review: Click the CodeLens button or use Command Palette
- View Issues: See colored underlines in your code
- Read Details: Hover over issues for detailed messages
- Fix Issues: Apply suggested fixes
- Re-review: Run review again to verify fixes
- Check Metrics: Review quality scores in output panel
🤝 Support
For issues, questions, or feature requests:
- Contact: Ramco Aviation CTB-AIML Development Team
- Email: chongtham.pankaj@ramco.com
📄 License
Copyright © 2025 Ramco Systems. All rights reserved.
Proprietary software for internal use by Ramco Aviation teams.
Made with ❤️ for Ramco Aviation Enterprise Teams
