dobo

Version:

DBMS for Bajo Framework

1 lines • 48.5 kB

JSON

{"list":[{"title":"Dobo","link":"<a href=\"Dobo.html\">Dobo</a>"},{"title":"Dobo#adapters","link":"<a href=\"Dobo.html#adapters\">adapters</a>"},{"title":"Dobo#connections","link":"<a href=\"Dobo.html#connections\">connections</a>"},{"title":"Dobo#features","link":"<a href=\"Dobo.html#features\">features</a>"},{"title":"Dobo#getAdapter","link":"<a href=\"Dobo.html#getAdapter\">getAdapter</a>","description":"Get adapter by name. It returns the first adapter named after "{name}"\nAlso support NsPath format for those who load the same named adapter but from different provider/plugin."},{"title":"Dobo#getAllPropertyKeys","link":"<a href=\"Dobo.html#getAllPropertyKeys\">getAllPropertyKeys</a>","description":"Get all allowed property keys"},{"title":"Dobo#getConnection","link":"<a href=\"Dobo.html#getConnection\">getConnection</a>","description":"Get connection by name. It returns the first connection named after "{name}""},{"title":"Dobo#getFeature","link":"<a href=\"Dobo.html#getFeature\">getFeature</a>","description":"Get feature by name. It returns the first adapter named after "{name}"\nAlso support NsPath format for those who load the same named adapter but from different provider/plugin."},{"title":"Dobo#getModel","link":"<a href=\"Dobo.html#getModel\">getModel</a>","description":"Get model by name"},{"title":"Dobo#getModelsByConnection","link":"<a href=\"Dobo.html#getModelsByConnection\">getModelsByConnection</a>","description":"Get all models that bound to connection <code>name</code>"},{"title":"Dobo#getPropertyKeysByType","link":"<a href=\"Dobo.html#getPropertyKeysByType\">getPropertyKeysByType</a>","description":"Get allowed property keys by field type"},{"title":"Dobo#init","link":"<a href=\"Dobo.html#init\">init</a>","description":"Initialize plugin and performing the following tasks:\n<ul>\n<li>{@link module:Lib.collectAdapters|Collecting all adapters}</li>\n<li>{@link module:Lib.collectConnections|Collecting all connections}</li>\n<li>{@link module:Lib.collectFeatures|Collecting all features}</li>\n<li>{@link module:Lib.collectModels|Collecting all models}</li>\n</ul>"},{"title":"Dobo#models","link":"<a href=\"Dobo.html#models\">models</a>"},{"title":"Dobo#start","link":"<a href=\"Dobo.html#start\">start</a>","description":"Start plugin"},{"title":"Dobo.aggregateTypes","link":"<a href=\"Dobo.html#.aggregateTypes\">aggregateTypes</a>"},{"title":"Dobo.histogramTypes","link":"<a href=\"Dobo.html#.histogramTypes\">histogramTypes</a>"},{"title":"Dobo.idTypes","link":"<a href=\"Dobo.html#.idTypes\">idTypes</a>"},{"title":"Dobo.indexTypes","link":"<a href=\"Dobo.html#.indexTypes\">indexTypes</a>"},{"title":"Dobo.propertyType","link":"<a href=\"Dobo.html#.propertyType\">propertyType</a>"},{"title":"Dobo.sanitizeDate","link":"<a href=\"Dobo.html#.sanitizeDate\">sanitizeDate</a>","description":"Sanitize value as a date/time value. Parse/format string using {@link https://day.js.org/docs/en/display/format|dayjs format}"},{"title":"DoboAction","link":"<a href=\"DoboAction.html\">DoboAction</a>"},{"title":"DoboAction#_setArgs","link":"<a href=\"DoboAction.html#_setArgs\">_setArgs</a>","description":"Internal method to set the arguments to the instance properties based on the method name\nand the arguments passed."},{"title":"DoboAction#body","link":"<a href=\"DoboAction.html#body\">body</a>","description":"Set the body for the corresponding record. You need this for <code>createRecord</code>, <code>updateRecord</code>\nor <code>upsertRecord</code> operations. This method is chainable."},{"title":"DoboAction#dispose","link":"<a href=\"DoboAction.html#dispose\">dispose</a>","description":"Dispose the instance and clean up resources."},{"title":"DoboAction#filter","link":"<a href=\"DoboAction.html#filter\">filter</a>","description":"Set the filter for the corresponding record. You optionally need this for <code>findRecord</code>,\n<code>findOneRecord</code> or <code>findAllRecord</code> operations. This method is chainable."},{"title":"DoboAction#id","link":"<a href=\"DoboAction.html#id\">id</a>","description":"Set the ID for the corresponding record. You need this for <code>updateRecord</code> or <code>removeRecord</code>\noperations. This method is chainable."},{"title":"DoboAction#options","link":"<a href=\"DoboAction.html#options\">options</a>","description":"Set the options for the corresponding method. This method is chainable."},{"title":"DoboAction#run","link":"<a href=\"DoboAction.html#run\">run</a>","description":"Execute the corresponding method with the set arguments and options. This method is chainable."},{"title":"DoboAction.TMethods","link":"<a href=\"DoboAction.html#.TMethods\">TMethods</a>","description":"Dobo model's chainable methods. Only the keys listed here are allowed to be called in chainable methods.\nThe values are the only allowed arguments for the corresponding chainable methods."},{"title":"DoboAction.TOptions","link":"<a href=\"DoboAction.html#.TOptions\">TOptions</a>","description":"Allowed options for Dobo model's chainable methods. Only the keys listed here are allowed to be called\nin chainable methods. The values are the default values for the corresponding options."},{"title":"DoboAdapter","link":"<a href=\"DoboAdapter.html\">DoboAdapter</a>","description":"Constructor."},{"title":"DoboAdapter#_attachHook","link":"<a href=\"DoboAdapter.html#_attachHook\">_attachHook</a>","description":"Attaches hooks to the model for various operations. It runs the appropriate hooks\nbefore and after the specified operation, allowing for custom behavior to be injected\ninto the model's lifecycle."},{"title":"DoboAdapter#_buildModel","link":"<a href=\"DoboAdapter.html#_buildModel\">_buildModel</a>","description":"Wrapper for the <code>buildModel</code> method, called internally by <code>model</code> to make sure\nall adapter hooks are executed accordingly, and all inputs and outputs are sanitized."},{"title":"DoboAdapter#_bulkCreateRecord","link":"<a href=\"DoboAdapter.html#_bulkCreateRecord\">_bulkCreateRecord</a>","description":"Wrapper for the {@link DoboAdapter#bulkCreateRecord} method, called internally by <code>model</code> to make sure\nall adapter hooks are executed accordingly, and all inputs and outputs are sanitized."},{"title":"DoboAdapter#_checkUnique","link":"<a href=\"DoboAdapter.html#_checkUnique\">_checkUnique</a>","description":"Checks the uniqueness of fields with a unique index."},{"title":"DoboAdapter#_clearRecord","link":"<a href=\"DoboAdapter.html#_clearRecord\">_clearRecord</a>","description":"Wrapper for the {@link DoboAdapter#clearRecord} method, called internally by <code>model</code> to make sure\nall adapter hooks are executed accordingly, and all inputs and outputs are sanitized."},{"title":"DoboAdapter#_countRecord","link":"<a href=\"DoboAdapter.html#_countRecord\">_countRecord</a>","description":"Wrapper for the {@link DoboAdapter#countRecord} method, called internally by <code>model</code> to make sure\nall adapter hooks are executed accordingly, and all inputs and outputs are sanitized."},{"title":"DoboAdapter#_createAggregate","link":"<a href=\"DoboAdapter.html#_createAggregate\">_createAggregate</a>","description":"Wrapper for the {@link DoboAdapter#createAggregate} method, called internally by <code>model</code> to make sure\nall adapter hooks are executed accordingly, and all inputs and outputs are sanitized."},{"title":"DoboAdapter#_createHistogram","link":"<a href=\"DoboAdapter.html#_createHistogram\">_createHistogram</a>","description":"Wrapper for the {@link DoboAdapter#createHistogram} method, called internally by <code>model</code> to make sure\nall adapter hooks are executed accordingly, and all inputs and outputs are sanitized."},{"title":"DoboAdapter#_createRecord","link":"<a href=\"DoboAdapter.html#_createRecord\">_createRecord</a>","description":"Wrapper for the {@link DoboAdapter#createRecord} method, called internally by <code>model</code> to make sure\nall adapter hooks are executed accordingly, and all inputs and outputs are sanitized."},{"title":"DoboAdapter#_dropModel","link":"<a href=\"DoboAdapter.html#_dropModel\">_dropModel</a>","description":"Wrapper for the <code>dropModel</code> method, called internally by <code>model</code> to make sure\nall adapter hooks are executed accordingly, and all inputs and outputs are sanitized."},{"title":"DoboAdapter#_findAllRecord","link":"<a href=\"DoboAdapter.html#_findAllRecord\">_findAllRecord</a>","description":"Finds all records for the given model based on the provided filter.\nThis method will only run if child adapter does not implement {@link DoboAdapter#findAllRecord}."},{"title":"DoboAdapter#_findRecord","link":"<a href=\"DoboAdapter.html#_findRecord\">_findRecord</a>","description":"Wrapper for the {@link DoboAdapter#findRecord} method, called internally by <code>model</code> to make sure\nall adapter hooks are executed accordingly, and all inputs and outputs are sanitized."},{"title":"DoboAdapter#_getRecord","link":"<a href=\"DoboAdapter.html#_getRecord\">_getRecord</a>","description":"Wrapper for the {@link DoboAdapter#getRecord} method, called internally by <code>model</code> to make sure\nall adapter hooks are executed accordingly, and all inputs and outputs are sanitized."},{"title":"DoboAdapter#_getReturningFields","link":"<a href=\"DoboAdapter.html#_getReturningFields\">_getReturningFields</a>","description":"Get returning fields for a model based on the provided options. If the adapter supports returning fields,\nit will return the specified fields or all model properties. It ensures that the ID field is always\nincluded in the returned fields."},{"title":"DoboAdapter#_modelExists","link":"<a href=\"DoboAdapter.html#_modelExists\">_modelExists</a>","description":"Wrapper for the <code>modelExists</code> method, called internally by <code>model</code> to make sure\nall adapter hooks are executed accordingly, and all inputs and outputs are sanitized."},{"title":"DoboAdapter#_prepBodyForCreate","link":"<a href=\"DoboAdapter.html#_prepBodyForCreate\">_prepBodyForCreate</a>","description":"Prepares the body of a record for creation by populating default values for properties\nthat are not set. It handles various types of default values, including functions,\nspecial strings (like 'now', 'uuid', etc.), and static values."},{"title":"DoboAdapter#_prepIdForCreate","link":"<a href=\"DoboAdapter.html#_prepIdForCreate\">_prepIdForCreate</a>","description":"Prepares the ID for a record before creation. It generates an ID if it is not set in the body."},{"title":"DoboAdapter#_removeRecord","link":"<a href=\"DoboAdapter.html#_removeRecord\">_removeRecord</a>","description":"Wrapper for the {@link DoboAdapter#removeRecord} method, called internally by <code>model</code> to make sure\nall adapter hooks are executed accordingly, and all inputs and outputs are sanitized."},{"title":"DoboAdapter#_updateRecord","link":"<a href=\"DoboAdapter.html#_updateRecord\">_updateRecord</a>","description":"Wrapper for the {@link DoboAdapter#updateRecord} method, called internally by <code>model</code> to make sure\nall adapter hooks are executed accordingly, and all inputs and outputs are sanitized."},{"title":"DoboAdapter#_upsertRecord","link":"<a href=\"DoboAdapter.html#_upsertRecord\">_upsertRecord</a>","description":"Upserts a record for the given model.\nThis method will only run if child adapter does not implement {@link DoboAdapter#upsertRecord}."},{"title":"DoboAdapter#buildModel","link":"<a href=\"DoboAdapter.html#buildModel\">buildModel</a>","description":"Builds the model in the database.\nMust be implemented by child classes to provide specific database functionality for model building,\nor throw an error if the operation is not supported by the adapter."},{"title":"DoboAdapter#bulkCreateRecord","link":"<a href=\"DoboAdapter.html#bulkCreateRecord\">bulkCreateRecord</a>","description":"Bulk creates records for the given model.\nMust be implemented by child classes to provide specific database functionality for bulk record creation,\nor throw an error if the operation is not supported by the adapter."},{"title":"DoboAdapter#clearRecord","link":"<a href=\"DoboAdapter.html#clearRecord\">clearRecord</a>","description":"Clears all records for the given model.\nMust be implemented by child classes to provide specific database functionality for record clearing,\nor throw an error if the operation is not supported by the adapter."},{"title":"DoboAdapter#connect","link":"<a href=\"DoboAdapter.html#connect\">connect</a>","description":"Connects to the database using the provided connection parameters."},{"title":"DoboAdapter#countRecord","link":"<a href=\"DoboAdapter.html#countRecord\">countRecord</a>","description":"Counts the records for the given model based on the provided filter.\nMust be implemented by child classes to provide specific database functionality for record counting,\nor throw an error if the operation is not supported by the adapter."},{"title":"DoboAdapter#createAggregate","link":"<a href=\"DoboAdapter.html#createAggregate\">createAggregate</a>","description":"Creates an aggregate for the given model based on the provided filter and parameters.\nMust be implemented by child classes to provide specific database functionality for aggregate creation,\nor throw an error if the operation is not supported by the adapter."},{"title":"DoboAdapter#createHistogram","link":"<a href=\"DoboAdapter.html#createHistogram\">createHistogram</a>","description":"Creates a histogram for the given model based on the provided filter and parameters.\nMust be implemented by child classes to provide specific database functionality for histogram creation,\nor throw an error if the operation is not supported by the adapter."},{"title":"DoboAdapter#createRecord","link":"<a href=\"DoboAdapter.html#createRecord\">createRecord</a>","description":"Creates a new record for the given model.\nMust be implemented by child classes to provide specific database functionality for record creation,\nor throw an error if the operation is not supported by the adapter."},{"title":"DoboAdapter#dispose","link":"<a href=\"DoboAdapter.html#dispose\">dispose</a>","description":"Disposes of the adapter, performing any necessary cleanup operations."},{"title":"DoboAdapter#dropModel","link":"<a href=\"DoboAdapter.html#dropModel\">dropModel</a>","description":"Drops the model from the database.\nMust be implemented by child classes to provide specific database functionality for dropping a model,\nor throw an error if the operation is not supported by the adapter."},{"title":"DoboAdapter#findRecord","link":"<a href=\"DoboAdapter.html#findRecord\">findRecord</a>","description":"Finds records for the given model based on the provided filter.\nMust be implemented by child classes to provide specific database functionality for record finding,\nor throw an error if the operation is not supported by the adapter."},{"title":"DoboAdapter#getRealFields","link":"<a href=\"DoboAdapter.html#getRealFields\">getRealFields</a>","description":"Utility method to get the real fields of a model, excluding virtual fields.\nThis is useful for operations that require only the actual stored properties of a model."},{"title":"DoboAdapter#getRecord","link":"<a href=\"DoboAdapter.html#getRecord\">getRecord</a>","description":"Retrieves a record for the given model by its ID.\nMust be implemented by child classes to provide specific database functionality for record retrieval,\nor throw an error if the operation is not supported by the adapter."},{"title":"DoboAdapter#getVirtualFields","link":"<a href=\"DoboAdapter.html#getVirtualFields\">getVirtualFields</a>","description":"Utility method to get the virtual fields of a model.\nThis is useful for operations that need to work with computed or derived properties."},{"title":"DoboAdapter#idField","link":"<a href=\"DoboAdapter.html#idField\">idField</a>","description":"ID field configuration"},{"title":"DoboAdapter#maxChunkSize","link":"<a href=\"DoboAdapter.html#maxChunkSize\">maxChunkSize</a>","description":"Maximum chunk size for bulk operations"},{"title":"DoboAdapter#memory","link":"<a href=\"DoboAdapter.html#memory\">memory</a>","description":"Indicates whether the adapter uses in-memory storage"},{"title":"DoboAdapter#modelExists","link":"<a href=\"DoboAdapter.html#modelExists\">modelExists</a>","description":"Checks if the model exists in the database.\nMust be implemented by child classes to provide specific database functionality for model existence checking,\nor throw an error if the operation is not supported by the adapter."},{"title":"DoboAdapter#name","link":"<a href=\"DoboAdapter.html#name\">name</a>","description":"Adapter name"},{"title":"DoboAdapter#options","link":"<a href=\"DoboAdapter.html#options\">options</a>","description":"Adapter options"},{"title":"DoboAdapter#removeRecord","link":"<a href=\"DoboAdapter.html#removeRecord\">removeRecord</a>","description":"Removes a record for the given model by its ID.\nMust be implemented by child classes to provide specific database functionality for record removal,\nor throw an error if the operation is not supported by the adapter."},{"title":"DoboAdapter#sanitizeBody","link":"<a href=\"DoboAdapter.html#sanitizeBody\">sanitizeBody</a>","description":"Sanitizes the body of a record before creating or updating it. It ensures that all required fields\nare present and have valid values, and converts data types as necessary."},{"title":"DoboAdapter#sanitizeConnection","link":"<a href=\"DoboAdapter.html#sanitizeConnection\">sanitizeConnection</a>","description":"Sanitize connection object"},{"title":"DoboAdapter#sanitizeRecord","link":"<a href=\"DoboAdapter.html#sanitizeRecord\">sanitizeRecord</a>","description":"Sanitizes a record retrieved from the database, converting data types as necessary\nand ensuring that the record conforms to the model's schema."},{"title":"DoboAdapter#support","link":"<a href=\"DoboAdapter.html#support\">support</a>","description":"Support configuration for the adapter"},{"title":"DoboAdapter#transaction","link":"<a href=\"DoboAdapter.html#transaction\">transaction</a>","description":"Executes a transaction for the given model.\nMust be implemented by child classes to provide specific database functionality for transactions,\nor throw an error if the operation is not supported by the adapter."},{"title":"DoboAdapter#updateRecord","link":"<a href=\"DoboAdapter.html#updateRecord\">updateRecord</a>","description":"Updates a record for the given model by its ID.\nMust be implemented by child classes to provide specific database functionality for record updating,\nor throw an error if the operation is not supported by the adapter."},{"title":"DoboAdapter#useUtc","link":"<a href=\"DoboAdapter.html#useUtc\">useUtc</a>","description":"Indicates whether to use UTC for datetime fields"},{"title":"DoboAdapter.TIdField","link":"<a href=\"DoboAdapter.html#.TIdField\">TIdField</a>"},{"title":"DoboAdapter.TSupport","link":"<a href=\"DoboAdapter.html#.TSupport\">TSupport</a>"},{"title":"DoboConnection","link":"<a href=\"DoboConnection.html\">DoboConnection</a>"},{"title":"DoboConnection#adapter","link":"<a href=\"DoboConnection.html#adapter\">adapter</a>","description":"Adapter object"},{"title":"DoboConnection#client","link":"<a href=\"DoboConnection.html#client\">client</a>","description":"Client instance"},{"title":"DoboConnection#connect","link":"<a href=\"DoboConnection.html#connect\">connect</a>","description":"Establish this connection through the adapter to the actual database system. Adapter developer must\nprovide a method named <code>connect()</code> to connect the underlying database and (optionally)\nreturn its client instance."},{"title":"DoboConnection#dispose","link":"<a href=\"DoboConnection.html#dispose\">dispose</a>","description":"Dispose this connection"},{"title":"DoboConnection#initAdapter","link":"<a href=\"DoboConnection.html#initAdapter\">initAdapter</a>","description":"Initialize the adapter for this connection. If the adapter is already an instance of <code>DoboAdapter</code>,\nit will be used directly. Otherwise, it will be retrieved from the plugin's adapter registry\nand sanitized with the connection options."},{"title":"DoboConnection#name","link":"<a href=\"DoboConnection.html#name\">name</a>","description":"Connection name"},{"title":"DoboConnection#options","link":"<a href=\"DoboConnection.html#options\">options</a>","description":"Connection options"},{"title":"DoboConnection.TOptions","link":"<a href=\"DoboConnection.html#.TOptions\">TOptions</a>"},{"title":"DoboFeature","link":"<a href=\"DoboFeature.html\">DoboFeature</a>","description":"Constructor."},{"title":"DoboFeature#dispose","link":"<a href=\"DoboFeature.html#dispose\">dispose</a>","description":"Dispose the instance and clean up resources."},{"title":"DoboFeature#handler","link":"<a href=\"DoboFeature.html#handler\">handler</a>","description":"Feature handler function."},{"title":"DoboFeature#name","link":"<a href=\"DoboFeature.html#name\">name</a>","description":"Feature name"},{"title":"DoboModel","link":"<a href=\"DoboModel.html\">DoboModel</a>","description":"Constructor"},{"title":"DoboModel#adapter","link":"<a href=\"DoboModel.html#adapter\">adapter</a>","description":"Model's adapter name"},{"title":"DoboModel.TFilter","link":"<a href=\"DoboModel.html#.TFilter\">TFilter</a>"},{"title":"DoboModel.TOptions","link":"<a href=\"DoboModel.html#.TOptions\">TOptions</a>"},{"title":"DoboModel.TPagination","link":"<a href=\"DoboModel.html#.TPagination\">TPagination</a>"},{"title":"DoboModel.TPropertyType","link":"<a href=\"DoboModel.html#.TPropertyType\">TPropertyType</a>"},{"title":"DoboModel.TPropertyValue","link":"<a href=\"DoboModel.html#.TPropertyValue\">TPropertyValue</a>","description":"Property value type definition. Used for building property <code>values</code> in a model which is an array of this object type."},{"title":"DoboModel.TRecord","link":"<a href=\"DoboModel.html#.TRecord\">TRecord</a>","description":"The record returned from a model's action. It is an object where:\n<ul>\n<li>Key represents the property name</li>\n<li>Value represents its value according to the property's data type</li>\n</ul>\nThis record is then merged with {@link DoboModel.TRecordFormatted} and {@link DoboModel.TRecordRef} to form the final record returned from a model's action."},{"title":"DoboModel.TRecordFormatted","link":"<a href=\"DoboModel.html#.TRecordFormatted\">TRecordFormatted</a>","description":"Formatted version of a record's property values. It is an object where:\n<ul>\n<li>Key represents the property name</li>\n<li>Value represents its formatted value according to the property's data type or formatting function. Data type is ALWAYS in string.</li>\n</ul>\nThis record is then wrapped in a <code>_fmt</code> property."},{"title":"DoboModel.TRecordRef","link":"<a href=\"DoboModel.html#.TRecordRef\">TRecordRef</a>","description":"Reference record related to a record's result. It is an object where:\n<ul>\n<li>Key represents the name of the referenced record. Normally, it is the referenced model's name in camelCase format.</li>\n<li>Value represents its reference record. It can be an object or an array of objects, depending on the relationship type.</li>\n</ul>\nThis record is then wrapped in a <code>_ref</code> property in the result object."},{"title":"DoboModel.TResultCreateRecord","link":"<a href=\"DoboModel.html#.TResultCreateRecord\">TResultCreateRecord</a>","description":"The result returned from a model's <code>createRecord</code> action if <code>dataOnly</code> is set to <code>false</code>."},{"title":"DoboModel.TResultFindRecord","link":"<a href=\"DoboModel.html#.TResultFindRecord\">TResultFindRecord</a>","description":"The result returned from a model's <code>find*</code> actions if <code>dataOnly</code> is set to <code>false</code>."},{"title":"DoboModel.TResultGetRecord","link":"<a href=\"DoboModel.html#.TResultGetRecord\">TResultGetRecord</a>","description":"The result returned from a model's <code>getRecord</code> action if <code>dataOnly</code> is set to <code>false</code>."},{"title":"DoboModel.TResultRecord","link":"<a href=\"DoboModel.html#.TResultRecord\">TResultRecord</a>","description":"The result returned from a model's action other than <code>find*</code>, <code>{create|update|remove}Record</code> if <code>dataOnly</code> is set to <code>false</code>."},{"title":"DoboModel.TResultRemoveRecord","link":"<a href=\"DoboModel.html#.TResultRemoveRecord\">TResultRemoveRecord</a>","description":"The result returned from a model's <code>removeRecord</code> action if <code>dataOnly</code> is set to <code>false</code>."},{"title":"DoboModel.TResultUpdateRecord","link":"<a href=\"DoboModel.html#.TResultUpdateRecord\">TResultUpdateRecord</a>","description":"The result returned from a model's <code>updateRecord</code> action if <code>dataOnly</code> is set to <code>false</code>."},{"title":"DoboModel.TSort","link":"<a href=\"DoboModel.html#.TSort\">TSort</a>","description":"Key value pairs used as sort order in pagination and sorting of records. It is an object where:\n<ul>\n<li>Key represents model's field name</li>\n<li>Value represents its sort order</li>\n</ul>"},{"title":"DoboModel.TSortOrder","link":"<a href=\"DoboModel.html#.TSortOrder\">TSortOrder</a>","description":"Sort order key used in pagination and sorting of records. It can be either:\n<ul>\n<li><code>1</code> for ascending order (the default, if none is provided) or</li>\n<li><code>-1</code> for descending order.</li>\n</ul>"},{"title":"DoboModel.TValidator","link":"<a href=\"DoboModel.html#.TValidator\">TValidator</a>","description":"All available validators to check against model's properties and rules"},{"title":"DoboModel.TValidatorArray","link":"<a href=\"DoboModel.html#.TValidatorArray\">TValidatorArray</a>","description":"List of available array validators to check against model's properties and rules"},{"title":"DoboModel.TValidatorBoolean","link":"<a href=\"DoboModel.html#.TValidatorBoolean\">TValidatorBoolean</a>","description":"List of available boolean validators to check against model's properties and rules"},{"title":"DoboModel.TValidatorDate","link":"<a href=\"DoboModel.html#.TValidatorDate\">TValidatorDate</a>","description":"List of available date validators to check against model's properties and rules"},{"title":"DoboModel.TValidatorNumber","link":"<a href=\"DoboModel.html#.TValidatorNumber\">TValidatorNumber</a>","description":"List of available number validators to check against model's properties and rules"},{"title":"DoboModel.TValidatorString","link":"<a href=\"DoboModel.html#.TValidatorString\">TValidatorString</a>","description":"List of available string validators to check against model's properties and rules"},{"title":"DoboModel.TValidatorTimestamp","link":"<a href=\"DoboModel.html#.TValidatorTimestamp\">TValidatorTimestamp</a>","description":"List of available timestamp validators to check against model's properties and rules"},{"title":"DoboModel._simpleLookup","link":"<a href=\"DoboModel.html#._simpleLookup\">_simpleLookup</a>","description":"Internal method to perform a simple lookup based on the provided value and lookupValue."},{"title":"DoboModel.action","link":"<a href=\"DoboModel.html#.action\">action</a>","description":"Invoke a model's action. It will create a new instance of {@link DoboAction} and return it."},{"title":"DoboModel.build","link":"<a href=\"DoboModel.html#.build\">build</a>","description":"Build a model's definition based on its properties and rules."},{"title":"DoboModel.buildFromDbModel","link":"<a href=\"DoboModel.html#.buildFromDbModel\">buildFromDbModel</a>","description":"Build JOI model from database model's properties and rules"},{"title":"DoboModel.buildPropValues","link":"<a href=\"DoboModel.html#.buildPropValues\">buildPropValues</a>","description":"Builds the values for a given property if <code>prop.values</code> is set:\n<ul>\n<li>If a string, it will be treated as a handler and executed to get the values.</li>\n<li>If a function, it will be executed to get the values.</li>\n<li>If an array, it will be used as is.</li>\n</ul>\nValues are returned as an array of {@link DoboModel.TPropertyValues}.\nIf a request object is provided in the options, the <code>text</code> will be translated using\nthe request's translation function."},{"title":"DoboModel.clearRecord","link":"<a href=\"DoboModel.html#.clearRecord\">clearRecord</a>","description":"Clears all records from the model's underlying data store.\nIf no arguments are provided, it automatically turns into a chainable {@link DoboAction} object."},{"title":"DoboModel.countRecord","link":"<a href=\"DoboModel.html#.countRecord\">countRecord</a>","description":"Counts the number of records in the model's underlying data store that match the provided filter criteria.\nIf no arguments are provided, it automatically turns into a chainable {@link DoboAction} object."},{"title":"DoboModel.createRecord","link":"<a href=\"DoboModel.html#.createRecord\">createRecord</a>","description":"Creates a new record in the model's underlying data store with the provided data.\nIf no arguments are provided, it automatically turns into a chainable {@link DoboAction} object."},{"title":"DoboModel.drop","link":"<a href=\"DoboModel.html#.drop\">drop</a>","description":"Drops the model from the underlying data store."},{"title":"DoboModel.findAllRecord","link":"<a href=\"DoboModel.html#.findAllRecord\">findAllRecord</a>","description":"Finds all records from the model's underlying data store based on the provided filter."},{"title":"DoboModel.findOneRecord","link":"<a href=\"DoboModel.html#.findOneRecord\">findOneRecord</a>","description":"Finds a single record from the model's underlying data store based on the provided filter.\nIf no arguments are provided, it automatically turns into a chainable {@link DoboAction} object."},{"title":"DoboModel.findRecord","link":"<a href=\"DoboModel.html#.findRecord\">findRecord</a>","description":"Finds records in the model's underlying data store that match the provided filter criteria.\nIf no arguments are provided, it automatically turns into a chainable {@link DoboAction} object."},{"title":"DoboModel.getIndexes","link":"<a href=\"DoboModel.html#.getIndexes\">getIndexes</a>","description":"Returns the model's indexes."},{"title":"DoboModel.getNonVirtualProperties","link":"<a href=\"DoboModel.html#.getNonVirtualProperties\">getNonVirtualProperties</a>","description":"Get the model's non-virtual properties."},{"title":"DoboModel.getProperties","link":"<a href=\"DoboModel.html#.getProperties\">getProperties</a>","description":"Get the model's properties based on the given options."},{"title":"DoboModel.getProperty","link":"<a href=\"DoboModel.html#.getProperty\">getProperty</a>","description":"Get a property by its name."},{"title":"DoboModel.getRecord","link":"<a href=\"DoboModel.html#.getRecord\">getRecord</a>","description":"Gets a record from the model's underlying data store based on the provided ID.\nIf no arguments are provided, it automatically turns into a chainable {@link DoboAction} object."},{"title":"DoboModel.getVirtualProperties","link":"<a href=\"DoboModel.html#.getVirtualProperties\">getVirtualProperties</a>","description":"Get the model's virtual properties."},{"title":"DoboModel.hasProperty","link":"<a href=\"DoboModel.html#.hasProperty\">hasProperty</a>","description":"Checks if the model has a property with the given name."},{"title":"DoboModel.isExists","link":"<a href=\"DoboModel.html#.isExists\">isExists</a>","description":"Checks if the model exists in the underlying data store."},{"title":"DoboModel.removeRecord","link":"<a href=\"DoboModel.html#.removeRecord\">removeRecord</a>","description":"Removes a record from the model's underlying data store based on the provided ID.\nIf no arguments are provided, it automatically turns into a chainable {@link DoboAction} object."},{"title":"DoboModel.sanitizeBody","link":"<a href=\"DoboModel.html#.sanitizeBody\">sanitizeBody</a>","description":"Sanitize the payload body based on the model's properties and rules."},{"title":"DoboModel.sanitizeFixture","link":"<a href=\"DoboModel.html#.sanitizeFixture\">sanitizeFixture</a>","description":"Sanitize a fixture object by resolving lookup values and ensuring proper data types."},{"title":"DoboModel.sanitizeId","link":"<a href=\"DoboModel.html#.sanitizeId\">sanitizeId</a>","description":"Sanitize the given ID based on the model's properties."},{"title":"DoboModel.sanitizeRecord","link":"<a href=\"DoboModel.html#.sanitizeRecord\">sanitizeRecord</a>","description":"Sanitize a record object based on the model's properties and rules."},{"title":"DoboModel.sanitizeRef","link":"<a href=\"DoboModel.html#.sanitizeRef\">sanitizeRef</a>","description":"Sanitize a reference object based on the model's properties and rules."},{"title":"DoboModel.updateRecord","link":"<a href=\"DoboModel.html#.updateRecord\">updateRecord</a>","description":"Updates an existing record in the model's underlying data store based on the provided ID and data.\nIf no arguments are provided, it automatically turns into a chainable {@link DoboAction} object."},{"title":"DoboModel.upsertRecord","link":"<a href=\"DoboModel.html#.upsertRecord\">upsertRecord</a>","description":"Upserts a record in the model's underlying data store. If a record with the specified ID exists, it updates that record; otherwise, it creates a new record.\nIf no arguments are provided, it automatically turns into a chainable {@link DoboAction} object."},{"title":"DoboModel.validate","link":"<a href=\"DoboModel.html#.validate\">validate</a>","description":"Validate body object against JOI model"},{"title":"actionFactory","link":"<a href=\"global.html#actionFactory\">actionFactory</a>","description":"Action factory function"},{"title":"adapterFactory","link":"<a href=\"global.html#adapterFactory\">adapterFactory</a>","description":"Adapter factory function."},{"title":"connectionFactory","link":"<a href=\"global.html#connectionFactory\">connectionFactory</a>","description":"Connection factory"},{"title":"external:Tools","link":"<a href=\"external-Tools.html\">Tools</a>"},{"title":"featureFactory","link":"<a href=\"global.html#featureFactory\">featureFactory</a>","description":"Feature factory function."},{"title":"modelFactory","link":"<a href=\"global.html#modelFactory\">modelFactory</a>","description":"Model factory."},{"title":"module:Helper","link":"<a href=\"module-Helper.html\">Helper</a>"},{"title":"module:Helper.collectAdapters","link":"<a href=\"module-Helper.html#.collectAdapters\">collectAdapters</a>","description":"Collects all database adapters from loaded plugins."},{"title":"module:Helper.collectConnections","link":"<a href=\"module-Helper.html#.collectConnections\">collectConnections</a>","description":"Collects all database connections from loaded plugins, initializes their adapters, and ensures that a default connection is available.\nIt also handles any memory-based connections and merges their models into a single memory connection."},{"title":"module:Helper.collectFeatures","link":"<a href=\"module-Helper.html#.collectFeatures\">collectFeatures</a>","description":"Collects all model features from loaded plugins"},{"title":"module:Helper.collectModels","link":"<a href=\"module-Helper.html#.collectModels\">collectModels</a>","description":"Collects all model schemas from the application, sanitizes them, and creates model instances.\nIt also handles any buildStart and buildEnd handlers defined in the model definitions."},{"title":"module:Helper.sanitizeAll","link":"<a href=\"module-Helper.html#.sanitizeAll\">sanitizeAll</a>","description":"Sanitizes all model schemas, ensuring that properties, indexes, and references are properly defined and validated.\nIt also determines the sortable fields based on the defined indexes."},{"title":"module:Helper.sanitizeRef","link":"<a href=\"module-Helper.html#.sanitizeRef\">sanitizeRef</a>","description":"Sanitizes the references in a model schema, ensuring that all references point to valid models and properties.\nIt checks for duplicate reference keys and validates the existence of referenced models and properties."},{"title":"module:Helper/Model","link":"<a href=\"module-Helper_Model.html\">Helper/Model</a>","description":"Helper functions for model operations in the Dobo framework."},{"title":"module:Helper/Model.buildFilterQuery","link":"<a href=\"module-Helper_Model.html#.buildFilterQuery\">buildFilterQuery</a>","description":"Builds a sanitized filter query for the given filter."},{"title":"module:Helper/Model.buildFilterSearch","link":"<a href=\"module-Helper_Model.html#.buildFilterSearch\">buildFilterSearch</a>","description":"Builds a search filter from the given filter object."},{"title":"module:Helper/Model.clearCache","link":"<a href=\"module-Helper_Model.html#.clearCache\">clearCache</a>","description":"Clears the cache for a specific record ID and related find operations."},{"title":"module:Helper/Model.cloneOptions","link":"<a href=\"module-Helper_Model.html#.cloneOptions\">cloneOptions</a>","description":"Clone options object and omit some keys to avoid reference issues"},{"title":"module:Helper/Model.copyAttachment","link":"<a href=\"module-Helper_Model.html#.copyAttachment\">copyAttachment</a>","description":"Copies attachments for a given record."},{"title":"module:Helper/Model.execDynHook","link":"<a href=\"module-Helper_Model.html#.execDynHook\">execDynHook</a>","description":"Executes a dynamic hook function with the provided name and arguments."},{"title":"module:Helper/Model.execHook","link":"<a href=\"module-Helper_Model.html#.execHook\">execHook</a>","description":"Executes a hook function with the provided name and arguments."},{"title":"module:Helper/Model.execModelHook","link":"<a href=\"module-Helper_Model.html#.execModelHook\">execModelHook</a>","description":"Executes a model hook function with the provided name and arguments."},{"title":"module:Helper/Model.execValidation","link":"<a href=\"module-Helper_Model.html#.execValidation\">execValidation</a>","description":"Executes validation on the provided body with the given options."},{"title":"module:Helper/Model.getAttachmentPath","link":"<a href=\"module-Helper_Model.html#.getAttachmentPath\">getAttachmentPath</a>","description":"Gets the attachment path for a given record and field."},{"title":"module:Helper/Model.getFilterAndOptions","link":"<a href=\"module-Helper_Model.html#.getFilterAndOptions\">getFilterAndOptions</a>","description":"Prepares and returns the filter and options for a given action."},{"title":"module:Helper/Model.getRefs","link":"<a href=\"module-Helper_Model.html#.getRefs\">getRefs</a>","description":"Gets reference records for the given records."},{"title":"module:Helper/Model.handleAttachmentUpload","link":"<a href=\"module-Helper_Model.html#.handleAttachmentUpload\">handleAttachmentUpload</a>","description":"Handles attachment uploads for a given record and trigger."},{"title":"module:Helper/Model.handleReq","link":"<a href=\"module-Helper_Model.html#.handleReq\">handleReq</a>","description":"Handles a request for a given action trigger."},{"title":"module:Helper/Model.mergeAttachmentInfo","link":"<a href=\"module-Helper_Model.html#.mergeAttachmentInfo\">mergeAttachmentInfo</a>","description":"Merges attachment information into the given record."},{"title":"module:Helper/Model.preparePagination","link":"<a href=\"module-Helper_Model.html#.preparePagination\">preparePagination</a>","description":"Prepare pagination parameters for a query:\n<ul>\n<li>Ensures that the limit does not exceed the maximum allowed limit.</li>\n<li>Ensures that the page number is within the allowed range.</li>\n<li>Calculates the number of records to skip based on the page and limit.</li>\n<li>Builds the sort order based on the provided sort input.</li>\n</ul>"},{"title":"module:Helper/Model.sanitizeQuery","link":"<a href=\"module-Helper_Model.html#.sanitizeQuery\">sanitizeQuery</a>","description":"Sanitizes a query object by ensuring that its fields and values conform to the model's schema."},{"title":"module:Helper~applyFeature","link":"<a href=\"module-Helper.html#~applyFeature\">applyFeature</a>","description":"Applies a feature to a model schema, adding properties, rules, hooks, and other\nconfigurations as defined by the feature."},{"title":"module:Helper~createSchema","link":"<a href=\"module-Helper.html#~createSchema\">createSchema</a>","description":"Creates a model schema by sanitizing its properties, features, and indexes, and ensuring that all references are valid.\nIt also applies any buildStart and buildEnd handlers defined in the schema."},{"title":"module:Helper~findAllFeats","link":"<a href=\"module-Helper.html#~findAllFeats\">findAllFeats</a>","description":"Finds and applies all features for a given model schema, ensuring that each feature is properly processed"},{"title":"module:Helper~findAllIndexes","link":"<a href=\"module-Helper.html#~findAllIndexes\">findAllIndexes</a>","description":"Finds and applies all indexes for a given model schema, ensuring that each index is properly processed"},{"title":"module:Helper~findAllProps","link":"<a href=\"module-Helper.html#~findAllProps\">findAllProps</a>","description":"Finds and sanitizes all properties for a given model schema, ensuring that the 'id' property is included and\nthat all properties are properly processed."},{"title":"module:Helper~sanitizeProp","link":"<a href=\"module-Helper.html#~sanitizeProp\">sanitizeProp</a>","description":"Sanitizes a property definition for a model, ensuring it adheres to the expected structure and types.\nIt handles various property attributes such as type, index, required status, and more.\nIf the property is virtual, it processes it accordingly; otherwise, it adds it to the model's properties\nand indexes."},{"title":"module:Hook","link":"<a href=\"module-Hook.html\">Hook</a>","description":"Available hooks for Dobo's operations. You can use these hooks to customize the behavior of the model's CRUD operations.\nFor any of the hooks below, you can also use the <code>modelName</code> in camelCase format to create a model-specific hook. If you\nchoose to use this format, you must omit the first parameter (<code>model</code>) so that the hook function handler syntax will become like this:\n<pre class=\"prettyprint source lang-js\"><code>dobo.{modelName}:beforeCreateRecord (body, options)\ndobo.{modelName}:afterCreateRecord (body, options)\ndobo.{modelName}:beforeFindRecord (filter, options)\ndobo.{modelName}:afterFindRecord (filter, result, options)\n...\n</code></pre>\nYou can use both formats simultaneously if you want. In that case, they will be executed in this order:\n<pre class=\"prettyprint source lang-js\"><code>dobo:beforeCreateRecord (model, body, options)\ndobo.{modelName}:beforeCreateRecord (body, options)\n...\ndobo.{modelName}:afterCreateRecord (body, result, options)\ndobo:afterCreateRecord (model, body, result, options)\n</code></pre>\nFor both formats, there are their counterparts that run deep inside the adapter.\nOnly use these hooks if you know what you are doing.\nTheir syntax is similar to the above, with one exception: you need to put suffix <code>.adapter</code> after <code>dobo</code>:\n<pre class=\"prettyprint source lang-js\"><code>dobo.adapter:beforeAdapterCreateRecord (model, body, options)\ndobo.adapter.{modelName}:beforeAdapterCreateRecord (body, options)\n</code></pre>"},{"title":"module:Hook.dobo:afterCountRecord","link":"<a href=\"module-Hook.html#.dobo:afterCountRecord\">dobo:afterCountRecord</a>","description":"Hook that is called after counting records."},{"title":"module:Hook.dobo:afterCreateRecord","link":"<a href=\"module-Hook.html#.dobo:afterCreateRecord\">dobo:afterCreateRecord</a>","description":"Hook that is called after creating a record."},{"title":"module:Hook.dobo:afterFindAllRecord","link":"<a href=\"module-Hook.html#.dobo:afterFindAllRecord\">dobo:afterFindAllRecord</a>","description":"Hook that is called after finding all records."},{"title":"module:Hook.dobo:afterFindOneRecord","link":"<a href=\"module-Hook.html#.dobo:afterFindOneRecord\">dobo:afterFindOneRecord</a>","description":"Hook that is called after finding one record."},{"title":"module:Hook.dobo:afterFindRecord","link":"<a href=\"module-Hook.html#.dobo:afterFindRecord\">dobo:afterFindRecord</a>","description":"Hook that is called after finding records."},{"title":"module:Hook.dobo:afterGetRecord","link":"<a href=\"module-Hook.html#.dobo:afterGetRecord\">dobo:afterGetRecord</a>","description":"Hook that is called after getting a record by ID."},{"title":"module:Hook.dobo:afterRemoveRecord","link":"<a href=\"module-Hook.html#.dobo:afterRemoveRecord\">dobo:afterRemoveRecord</a>","description":"Hook that is called after removing a record."},{"title":"module:Hook.dobo:afterUpdateRecord","link":"<a href=\"module-Hook.html#.dobo:afterUpdateRecord\">dobo:afterUpdateRecord</a>","description":"Hook that is called after updating a record."},{"title":"module:Hook.dobo:beforeCountRecord","link":"<a href=\"module-Hook.html#.dobo:beforeCountRecord\">dobo:beforeCountRecord</a>","description":"Hook that is called before counting records."},{"title":"module:Hook.dobo:beforeCreateRecord","link":"<a href=\"module-Hook.html#.dobo:beforeCreateRecord\">dobo:beforeCreateRecord</a>","description":"Hook that is called before creating a record."},{"title":"module:Hook.dobo:beforeFindAllRecord","link":"<a href=\"module-Hook.html#.dobo:beforeFindAllRecord\">dobo:beforeFindAllRecord</a>","description":"Hook that is called before finding all records."},{"title":"module:Hook.dobo:beforeFindOneRecord","link":"<a href=\"module-Hook.html#.dobo:beforeFindOneRecord\">dobo:beforeFindOneRecord</a>","description":"Hook that is called before finding one record."},{"title":"module:Hook.dobo:beforeFindRecord","link":"<a href=\"module-Hook.html#.dobo:beforeFindRecord\">dobo:beforeFindRecord</a>","description":"Hook that is called before finding records."},{"title":"module:Hook.dobo:beforeGetRecord","link":"<a href=\"module-Hook.html#.dobo:beforeGetRecord\">dobo:beforeGetRecord</a>","description":"Hook that is called before getting a record by ID."},{"title":"module:Hook.dobo:beforeRemoveRecord","link":"<a href=\"module-Hook.html#.dobo:beforeRemoveRecord\">dobo:beforeRemoveRecord</a>","description":"Hook that is called before removing a record."},{"title":"module:Hook.dobo:beforeUpdateRecord","link":"<a href=\"module-Hook.html#.dobo:beforeUpdateRecord\">dobo:beforeUpdateRecord</a>","description":"Hook that is called before updating a record."},{"title":"pluginFactory","link":"<a href=\"global.html#pluginFactory\">pluginFactory</a>","description":"Plugin factory"}]}