Extension Settings - BTSS Documentation

Accessing Settings

Via VS Code Settings

Open VS Code Settings:
- Windows/Linux: Ctrl+,
- Mac: Cmd+,
Search for “Koala”
Modify settings as needed

Via Settings JSON

Open Command Palette (Ctrl+Shift+P)
Type: “Preferences: Open Settings (JSON)”
Add Koala settings

Core Settings

Query Execution

{
  // Request timeout in milliseconds (default: 120000 = 2 minutes)
  "koalaDataExplorer.timeout": 120000,
  
  // Maximum rows to return (default: 1000)
  // Note: Locked to 50 in free mode
  "koalaDataExplorer.maxRows": 1000,
  
  // Auto-refresh data sources on connection
  "koalaDataExplorer.autoRefreshDataSources": true
}

Max Rows applies a server-side ROWNUM restriction to every query, even when additional WHERE filters are present.

UI change: The Max Rows control is now a dropdown with presets 10, 50, 100, 500, 1000, 2500, 5000 plus an Unlimited checkbox for larger result sets (paid). The free tier remains capped at 50 rows even when higher values are selected.

Timeout Configuration

Adjust timeout for different scenarios:

{
  // Quick queries (30 seconds)
  "koalaDataExplorer.timeout": 30000,
  
  // Standard queries (2 minutes)
  "koalaDataExplorer.timeout": 120000,
  
  // Complex queries (5 minutes)
  "koalaDataExplorer.timeout": 300000,
  
  // Very long queries (10 minutes)
  "koalaDataExplorer.timeout": 600000
}

Longer timeouts may cause VS Code to become unresponsive. Use scheduled reports for very long-running queries.

Logging Settings

Enable Logging

{
  // Enable debug logging
  "koalaDataExplorer.logging.enabled": true,
  
  // Set logging level
  "koalaDataExplorer.logging.level": "INFO",
  
  // Maximum log entries to keep
  "koalaDataExplorer.logging.maxLogs": 1000
}

Logging Levels

Level	Description	Use Case
`ERROR`	Only errors	Production use
`WARN`	Warnings and errors	Normal use
`INFO`	General information	Default
`DEBUG`	Detailed debugging	Troubleshooting

View Logs

Open Command Palette
Type: “Koala: View Logs”
Review log entries in the panel

Scheduled Report Settings

For large dataset processing:

{
  // Maximum wait time for scheduled reports (15 minutes)
  "koalaDataExplorer.scheduleReport.maxPollTime": 900000,
  
  // Download chunk size in KB (50MB)
  "koalaDataExplorer.scheduleReport.chunkSizeKB": 50000,
  
  // Enable for large datasets
  "koalaDataExplorer.scheduleReport.enableForLargeDatasets": true
}

SQL History Settings

{
  // Maximum SQL history entries (default: 500)
  // Note: Limited to 50 in free mode
  "koalaDataExplorer.sqlHistory.maxEntries": 500
}

Performance Settings

Memory Management

For large result sets:

{
  // Limit rows for better performance
  "koalaDataExplorer.maxRows": 500,
  
  // Disable auto-refresh for slow connections
  "koalaDataExplorer.autoRefreshDataSources": false
}

Network Optimization

{
  // Shorter timeout for fast networks
  "koalaDataExplorer.timeout": 60000,
  
  // Smaller chunks for slow connections
  "koalaDataExplorer.scheduleReport.chunkSizeKB": 10000
}

Development Settings

Testing and QA

{
  // Force free mode for testing
  "koalaDataExplorer.license.forceFreeMode": true,
  
  // Enable verbose logging
  "koalaDataExplorer.logging.enabled": true,
  "koalaDataExplorer.logging.level": "DEBUG"
}

Workspace vs User Settings

User Settings (Global)

Applied to all VS Code projects:

// ~/.config/Code/User/settings.json
{
  "koalaDataExplorer.timeout": 120000,
  "koalaDataExplorer.logging.enabled": false
}

Workspace Settings (Project)

Applied only to current project:

// .vscode/settings.json
{
  "koalaDataExplorer.maxRows": 5000,
  "koalaDataExplorer.autoRefreshDataSources": false
}

Workspace settings override user settings for the current project.

Environment-Specific Configuration

Development Environment

{
  "koalaDataExplorer.timeout": 300000,
  "koalaDataExplorer.maxRows": 10000,
  "koalaDataExplorer.logging.enabled": true,
  "koalaDataExplorer.logging.level": "DEBUG"
}

Production Environment

{
  "koalaDataExplorer.timeout": 120000,
  "koalaDataExplorer.maxRows": 1000,
  "koalaDataExplorer.logging.enabled": false,
  "koalaDataExplorer.autoRefreshDataSources": true
}

Proxy Configuration

For corporate networks:

{
  // Proxy server URL
  "http.proxy": "http://proxy.company.com:8080",
  
  // Disable SSL verification (development only)
  "http.proxyStrictSSL": false,
  
  // Proxy authentication
  "http.proxyAuthorization": null
}

Reset to Defaults

Reset All Settings

Open Command Palette
Type: “Preferences: Open Settings (JSON)”
Remove all koalaDataExplorer.* entries
Reload VS Code

Default Values

{
  "koalaDataExplorer.timeout": 120000,
  "koalaDataExplorer.maxRows": 1000,
  "koalaDataExplorer.autoRefreshDataSources": true,
  "koalaDataExplorer.logging.enabled": false,
  "koalaDataExplorer.logging.level": "INFO",
  "koalaDataExplorer.logging.maxLogs": 1000,
  "koalaDataExplorer.scheduleReport.maxPollTime": 900000,
  "koalaDataExplorer.scheduleReport.chunkSizeKB": 50000,
  "koalaDataExplorer.scheduleReport.enableForLargeDatasets": true,
  "koalaDataExplorer.sqlHistory.maxEntries": 500,
  "koalaDataExplorer.license.forceFreeMode": false
}

Troubleshooting Settings

Settings Not Applied

Check for syntax errors in settings.json
Reload VS Code window (Ctrl+R)
Verify setting names are correct
Check workspace vs user settings

Performance Issues

If extension is slow:

{
  "koalaDataExplorer.maxRows": 100,
  "koalaDataExplorer.autoRefreshDataSources": false,
  "koalaDataExplorer.logging.enabled": false
}

Connection Problems

For connection issues:

{
  "koalaDataExplorer.timeout": 180000,
  "http.proxyStrictSSL": false,
  "koalaDataExplorer.logging.enabled": true,
  "koalaDataExplorer.logging.level": "DEBUG"
}

Settings Priority

Settings are applied in this order (highest priority first):

Workspace settings (.vscode/settings.json)
User settings (~/.config/Code/User/settings.json)
Default settings (extension defaults)

Export/Import Settings

Export Settings

# Copy settings to share with team
cp ~/.config/Code/User/settings.json ./koala-settings-backup.json

Import Settings

# Import settings from backup
cp ./koala-settings-backup.json ~/.config/Code/User/settings.json

Next Steps

Timeout Settings

Configure timeouts for your network

Logging

Set up logging for debugging

First Connection

Configure your first connection

Troubleshooting

Resolve configuration issues

​Accessing Settings

​Via VS Code Settings

​Via Settings JSON

​Core Settings

​Query Execution

​Timeout Configuration

​Logging Settings

​Enable Logging

​Logging Levels

​View Logs

​Scheduled Report Settings

​SQL History Settings

​Performance Settings

​Memory Management

​Network Optimization

​Development Settings

​Testing and QA

​Workspace vs User Settings

​User Settings (Global)

​Workspace Settings (Project)

​Environment-Specific Configuration

​Development Environment

​Production Environment

​Proxy Configuration

​Reset to Defaults

​Reset All Settings

​Default Values

​Troubleshooting Settings

​Settings Not Applied

​Performance Issues

​Connection Problems

​Settings Priority

​Export/Import Settings

​Export Settings

​Import Settings

​Next Steps

Timeout Settings

Logging

First Connection

Troubleshooting

Accessing Settings

Via VS Code Settings

Via Settings JSON

Core Settings

Query Execution

Timeout Configuration

Logging Settings

Enable Logging

Logging Levels

View Logs

Scheduled Report Settings

SQL History Settings

Performance Settings

Memory Management

Network Optimization

Development Settings

Testing and QA

Workspace vs User Settings

User Settings (Global)

Workspace Settings (Project)

Environment-Specific Configuration

Development Environment

Production Environment

Proxy Configuration

Reset to Defaults

Reset All Settings

Default Values

Troubleshooting Settings

Settings Not Applied

Performance Issues

Connection Problems

Settings Priority

Export/Import Settings

Export Settings

Import Settings

Next Steps