Embedding Database Queries

Database query files are embedded directly into your documentation as interactive query documents rather than static code snippets. Queries are presented in a clean, readable format with syntax highlighting, allowing readers to understand the query without opening a separate database client.

When you need to execute or modify a query, simply click Edit on the embedded query. DevScribe opens the query in the full Database Plugin, where you can connect to your database, update the query, execute it, inspect the results, and save your changes.

Because the embedded query and the Database Plugin reference the same underlying file, any changes you save are reflected immediately in the documentation. This ensures your documentation always stays synchronized with the latest version of the query.

With built-in support for SQL, MongoDB, Redis, OpenSearch, and Elasticsearch, DevScribe eliminates the need to switch between documentation tools and separate database clients just to review or execute queries. Your documentation becomes the central place to document, run, and maintain database operations.