> For the complete documentation index, see [llms.txt](https://prosbcdocs.telcobridges.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://prosbcdocs.telcobridges.com/telecom-references/developer-reference/database/framework-database.md).

# Framework database

A database is required by the framework for persistent storage; not surprisingly it is called the framework database. It is used to store the configuration, states and status of the system. The framework database’s schema is imposed on client and is considered an [application programming interface (API)](/telecom-references/developer-reference/toolpack-api/api.md). This means that it is subjected to the same rules as any TelcoBridges API. The schema was written in XML so the SQL generation script can be generated using simple XSL sheets. This was done to make it easy to switch DBMS since the SQL data definition language is not always portable. This also makes it possible to generate visual representations of the database using another XSL sheet and Graphviz. Of course the framework must support the DBMS, fortunately we support ODBC so the framework supports almost any database through that interface. In the future we will also add support for some DBMS natively.

This database was created and designed for the Toolpack Web OAMP.

### Caveats

* Note that the division is purely hierarchical and both the databases can be hosted on the same database.
* There is no restriction on the the DBMS of the framework database except that we must support it.

***

Return to the Toolpack [User Guide](https://prosbcdocs.telcobridges.com/tmedia-documentation/other-pages/getting-around-the-portal/user-guide)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://prosbcdocs.telcobridges.com/telecom-references/developer-reference/database/framework-database.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
