{"list":[{"title":"TConfig","link":"TConfig","description":"

Configuration object

"},{"title":"WaibuDb","link":"WaibuDb","description":"

Constructor.

"},{"title":"WaibuDb#adminMenu","link":"adminMenu","description":"

Build menu for WaibuAdmin

"},{"title":"WaibuDb#config","link":"config","description":"

Configuration object.

"},{"title":"WaibuDb#exportData","link":"exportData","description":"

Export data and save it as a file you can download later.\nThis method is intended to be called by a worker process.

\n

If sumba is loaded, file download is handled by sumba download management which provides\nyou a slick UI to monitor the download progress and status.

\n

If not, file is saved in standard bajo download directory.

"},{"title":"WaibuDb#getAutoModels","link":"getAutoModels","description":"

Get all models that will be automatically included in the WaibuAdmin menu.

"},{"title":"WaibuDb#getLookupData","link":"getLookupData","description":"

Get lookup data for a specific model and field based on provided options.

"},{"title":"WaibuDb#getParams","link":"getParams","description":"

Collect all available parameters from the request object.

"},{"title":"WaibuDb#methodMap","link":"methodMap","description":"

Method map for CRUD operations.

"},{"title":"external:DoboModel","link":"DoboModel"},{"title":"external:TFilter","link":"TFilter"},{"title":"external:TOptions","link":"TOptions"},{"title":"factory","link":"factory","description":"

Plugin factory.

\n

Never call this function directly!!! It's only-meant to be called by the {@link https://ardhi.github.io/bajo|Bajo framework} during plugin initialization.

"},{"title":"module:CRUDHandler","link":"CRUDHandler","description":"

Function handlers for CRUD operations.

\n

To use these handlers, you need to import them first and call them with the appropriate parameters.

"},{"title":"module:CRUDHandler.THandlerMap","link":"THandlerMap","description":"

Map of CRUD action names to their corresponding handler functions.

"},{"title":"module:CRUDHandler.addHandler","link":"addHandler","description":"

Handler for rendering the add view of a model.

\n

To use this handler, you must import it first and call it with the necessary parameters. For example:

\n
const { importModule } = this.app.bajo\nconst addHandler = await importModule('waibuDb:/lib/crud/add-handler.js')\nconst result = await addHandler.call(this, { model: 'YourModelName', req, reply })\n
"},{"title":"module:CRUDHandler.allHandler","link":"allHandler","description":"

Handler for routing to the appropriate CRUD action based on the provided options.

\n

To use this handler, you must import it first and call it with the necessary parameters. For example:

\n
const { importModule } = this.app.bajo\nconst allHandler = await importModule('waibuDb:/lib/crud/all-handler.js')\nconst result = await allHandler.call(this, { model: 'YourModelName', action: 'list', req, reply })\n
\n

For more information on the available actions, see {@link module:CRUDHandler.THandlerMap THandlerMap}.

"},{"title":"module:CRUDHandler.deleteHandler","link":"deleteHandler","description":"

Handler for deleting records of a model.

\n

To use this handler, you must import it first and call it with the necessary parameters. For example:

\n
const { importModule } = this.app.bajo\nconst deleteHandler = await importModule('waibuDb:/lib/crud/delete-handler.js')\nawait deleteHandler.call(this, { model: 'YourModelName', req, reply })\n
"},{"title":"module:CRUDHandler.detailsHandler","link":"detailsHandler","description":"

Handler for rendering the details view of a model.

\n

To use this handler, you must import it first and call it with the necessary parameters. For example:

\n
const { importModule } = this.app.bajo\nconst detailsHandler = await importModule('waibuDb:/lib/crud/details-handler.js')\nconst result = await detailsHandler.call(this, { model: 'YourModelName', req, reply })\n
"},{"title":"module:CRUDHandler.editHandler","link":"editHandler","description":"

Handler for rendering the edit view of a model.

\n

To use this handler, you must import it first and call it with the necessary parameters. For example:

\n
const { importModule } = this.app.bajo\nconst editHandler = await importModule('waibuDb:/lib/crud/edit-handler.js')\nconst result = await editHandler.call(this, { model: 'YourModelName', req, reply })\n
"},{"title":"module:CRUDHandler.exportHandler","link":"exportHandler","description":"

Handler for rendering the export view of a model.

\n

To use this handler, you must import it first and call it with the necessary parameters. For example:

\n
const { importModule } = this.app.bajo\nconst exportHandler = await importModule('waibuDb:/lib/crud/export-handler.js')\nawait exportHandler.call(this, { model: 'YourModelName', req, reply })\n
"},{"title":"module:CRUDHandler.listHandler","link":"listHandler","description":"

Handle the list view for a given model, rendering the appropriate template with the retrieved data.

\n

To use this handler, you must import it first and call it with the necessary parameters. For example:

\n
const { importModule } = this.app.bajo\nconst listHandler = await importModule('waibuDb:/lib/crud/list-handler.js')\nconst result = await listHandler.call(this, { model: 'YourModelName', req, reply })\n
"},{"title":"module:CRUDHandler/Helper","link":"CRUDHandler/Helper"},{"title":"module:CRUDHandler/Helper.addOnsHandler","link":"addOnsHandler","description":"

Add-ons handler for generating chart options based on the schema's aggregate settings.

\n

This function retrieves the aggregate settings from the schema and generates chart options for each setting.\nThe generated chart options are encoded in base64 and returned as an array of add-ons.

"},{"title":"module:CRUDHandler/Helper.attachmentHandler","link":"attachmentHandler","description":"

Handles attachments for a given schema and ID.

"},{"title":"module:CRUDHandler/Helper.buildParams","link":"buildParams","description":"

Builds parameters for a given model and request.

"},{"title":"module:CRUDHandler/Helper.notFoundTpl","link":"notFoundTpl","description":"

Template path for the "not found" page.

"},{"title":"module:Helper","link":"Helper"},{"title":"module:Helper.getOneRecord","link":"getOneRecord","description":"

Get a single record from the database based on the provided model, ID, filter, and options.

"},{"title":"module:Helper.prepCrud","link":"prepCrud","description":"

Prepare CRUD operation parameters.

"},{"title":"module:Helper.processHandler","link":"processHandler","description":"

Process a database operation with error suppression and transaction handling.

"},{"title":"module:Helper~TActions","link":"TActions","description":"

Type of actions that can be performed on records in the database.

"}]}