gluonDB SDK
The GluonDB SDK lets you query your connected datasources directly from custom dashboards. Write SQL, get data, build visualizations — all within an isolated, secure iframe environment.
What You Can Build
- Interactive dashboards with live data from your databases
- Custom visualizations using Chart.js or Plotly
- Data reports with tables, KPIs, and metrics
- Real-time monitoring dashboards
SDK Overview
The SDK is automatically injected into every dashboard. Access it via the global gluon object:
javascript
// Simple query - returns array of row objects
const users = await gluon.query('SELECT * FROM users LIMIT 10', {
datasource: 'my_database'
});
// Query with metadata - returns rows + column info
const result = await gluon.queryWithMeta('SELECT * FROM orders', {
datasource: 'my_database'
});
console.log(result.rows); // Array of row objects
console.log(result.columns); // Array of { name, type }
console.log(result.executionTimeMs); // Query execution time
Bundled Libraries
Every dashboard includes these libraries — no CDN or imports needed:
| Library | Global Variable | Documentation |
|---|---|---|
| Chart.js | window.Chart | chartjs.org |
| Plotly.js | window.Plotly | plotly.com/javascript |
Quick Links
- Query API Reference — Full API documentation
- Building Dashboards — Step-by-step guide
- Code Snippets — Copy-paste examples