Documentation Level: 
Documentation Status: 
No known problems

The Backdrop 1 Database API provides a standard, vendor-agnostic abstraction layer for accessing database servers. You should almost never be making database calls directly unless you are developing core APIs.

The API is designed to preserve the syntax and power of SQL as much as possible, but also:

  • To support multiple database servers easily;
  • To allow developers to leverage more complex functionality, such as transactions;
  • To provide a structured interface for the dynamic construction of queries;
  • To enforce security checks and other good practices;
  • To provide modules with a clean interface for intercepting and modifying a site's queries.

The main Database API documentation is derived directly from comments in the code. This Handbook section augments those API docs by providing a tutorial for module authors who wish to interact with the database system, as well as an overview of the system from an administrator's point of view.

The Database API was built with object-oriented design concepts, and this document therefore assumes at least a partial familiarity with those concepts. However, most common operations have a procedural front-end as well, and developers may choose to use the procedural style for more readable code.

Note: this Handbook might not cover every feature of the API.