Plugin API » Interfaces » Plugin » Data and databases

Plugin data and databases

Your plugin object provides data storage facilities to store arbitrary data outside the main object store. The data property allows for a small amount of JSON-compatible data to be stored, and the db property provides a full relational database.

Interface

property db

The plugin’s database object, implementing the Database interface. Requires pDatabase to be included in privilegesRequired in your plugin.json.

See Database for how to use the plugin’s database.

property data

The DataStore object for this plugin. Plugins can use this to store small amounts of arbitrary data.

Note there are restrictions and limitations on the data which can be stored. See the DataStore documentation for details.