Support

Documentation

getDBEntities
Prev Methods Reference Next

getDBEntities

[Warning]Warning

DEPRECATED - This method will be removed in Akeeba Backup for Joomla 10, Akeeba Backup for WordPress 8, and Akeeba Solo 8. Versions of our software released after September 2023 may no longer include this method even if their major version is below those specified in this message.

Returns the database entities exclusion filters for the chosen backup profile. Available since API version 340.

Request Data expected

All fields are MANDATORY.

profile

Integer. The profile ID you want to list.

root

string. The UUID of the database root, default [SITEDB] (the main site database definition). See getDBRoots

Response Data returned

A JSON object is returned with the keys

root

The UUID of the database root.

tables

A list of database entities. This is a JSON object. The property keys of the object are the database entity (table, view, function, trigger, procedure) names. The property values are JSON objects with the following keys:

type

The type of the database entity. One of:

table

Regular table

view

Regular VIEW

merge

Merge table (MySQL only, means MRG_MYISAM table type)

temp

Temporary table. For MySQL that includes MEMORY, EXAMPLE, BLACKHOLE and FEDERATED.

procedure

Database procedure.

function

Database function.

trigger

Database trigger

tables

Is this table excluded? 0: No. 1: Yes. 2: Always (excluded by a RegEx, conditional, algorithmic or platform-specific filter).

[Note]Note

In the Akeeba Backup / Solo interface these values are rendered with the following color coding 0: white 1: yellow 2: red.

tabledata

Is the table data excluded? 0: No. 1: Yes. 2: Always (not a regular table; or excluded by a RegEx, conditional, algorithmic or platform-specific filter).

[Note]Note

In the Akeeba Backup / Solo interface these values are rendered with the following color coding 0: white 1: yellow 2: red.

Prev Up Next
getDBFilters Home setDBFilter