Database Tools Documentation
Comprehensive guides, API references, and tutorials for using DBTools.
Start LearningGetting Started
Introduction
DBTools is a suite of developer-centric tools for database query building, schema visualization, and data exploration. These tools work seamlessly with SQL, NoSQL, and cloud databases.
Installation
Use our browser extension (Install Visualizer) or integrate via API:
// Example: Connect to Postgres
const config = {
host: "your-host",
database: "db-name",
user: "username",
password: "secure-password"
};
dbTools.connect("postgres", config, (err, connection) => {
if (!err) {
console.log("Connection successful:", connection.id);
}
});
Tutorials
Schema Visualizer Guide
Learn how to import existing database schemas, create entity-relationship diagrams, and export them as PDF or PNG.
SQL Query Builder Workshop
Master complex query construction with auto-suggestion, syntax validation, and execution plan visualization.
API Reference
connect(databaseType, connectionParams)
Establishes database connection
- • string
databaseType - • object
connectionParams
Connection ID on success, throws error on failure
query(connectionId, sqlCommand)
Executes database query
- • string
connectionId - • string
sqlCommand
Raw result data or visualization in JSON format
Best Practices
Schema Mapping
Always validate schema relationships before export using the validation checker.
Query Caching
Enable browser-side query caching for frequently used patterns to reduce execution latency.
Security
Use role-based access control when connecting to production databases. Store credentials in encrypted vaults.