Database Doc Tool

DevScribe’s Database Doc Tool provides a dedicated workspace for connecting to and working with databases alongside the rest of your development resources.

It brings database connections, queries, and results into the same environment as your documentation, code, diagrams, and other project artifacts, so you can work with your data without leaving your development workspace.

What is the Database Doc Tool?

The Database Doc Tool lets you interact with a connected database directly from DevScribe.

Once a database is connected, you can explore its structure, access its tables and resources, create and manage queries, execute them, and inspect their results.

Database resources can also be organized within your project, making frequently used queries and database operations easy to find and reuse.

Key Capabilities

• Connect to Databases: Establish connections using your database’s connection details.
• Explore Database Structure: Browse connected databases, tables, and available resources.
• Create Queries: Create and maintain database queries as part of your project.
• Execute Queries: Run queries directly against a connected database.
• View Results: Inspect query output within the DevScribe workspace.
• Organize Resources: Keep database-related resources together with the rest of your project.

Use Cases

The Database Doc Tool can support database-related tasks throughout the development process.

Explore

Inspect a database’s structure and understand the tables and data available before working with it.

Develop

Create and refine queries while building or modifying an application.

Test

Execute database operations and inspect their results without switching to a separate database client.

Document

Keep queries and database resources close to the documentation and other technical artifacts they support.

Why Use the Database Doc Tool?

Database work often involves switching between multiple tools—a database client for queries, a documentation platform for explanations, and a development environment for the application itself.

DevScribe brings these resources together in one workspace.

By keeping database connections and queries alongside your project’s documentation, code, diagrams, and other resources, you can maintain the context of your database work within the project itself.

Database Workflow

Working with a database in DevScribe follows a simple workflow:

Connect, Explore, Create Query, Execute, View Results

The following guide walks through this workflow in detail, from adding your first database connection to running a query and working with its results.