# @janiscommerce/model > A package for managing Janis Models Latest version **8.16.0** (published 2026-07-21) · ISC license · 0 weekly downloads ## Install ```sh npm install @janiscommerce/model pnpm add @janiscommerce/model yarn add @janiscommerce/model bun add @janiscommerce/model ``` ## Health **Score 60/100 (C)** — status: active. Positive: has types; no vulnerabilities; high maintenance score; high quality score. Warnings: low downloads; no esm support. ## Facts | | | |---|---| | Version | 8.16.0 | | Published | 2026-07-21 | | First published | 2019-07-11 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | bundled | | Module format | CommonJS | | Node | >=18 | | Dependencies | 6 | | Unpacked size | 105.4 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 1 | | Author | Janis | | Maintainers | janiscommerce | ## Links - npm: https://www.npmjs.com/package/@janiscommerce/model - Repository: https://github.com/janis-commerce/model - Homepage: https://github.com/janis-commerce/model.git#readme - Issues: https://github.com/janis-commerce/model/issues - npm.io page: https://npm.io/package/@janiscommerce/model ## Dependencies (6) - [md5](https://npm.io/package/md5.md) ^2.3.0 - [lllog](https://npm.io/package/lllog.md) ^1.1.2 - [@janiscommerce/log](https://npm.io/package/@janiscommerce/log.md) ^5.5.0 - [@aws-sdk/client-ssm](https://npm.io/package/@aws-sdk/client-ssm.md) ^3.859.0 - [@janiscommerce/settings](https://npm.io/package/@janiscommerce/settings.md) ^1.0.1 - [@janiscommerce/aws-secrets-manager](https://npm.io/package/@janiscommerce/aws-secrets-manager.md) ^1.1.1 ## Recent versions - 8.16.0 (latest) — 2026-07-21 - 8.16.0-beta.2 (beta) — 2026-07-17 - 8.16.0-beta.1 — 2026-07-16 - 8.16.0-beta.0 — 2026-07-16 - 8.15.1 — 2026-07-03 - 8.15.0 — 2026-07-02 - 8.14.0 — 2026-04-29 - 8.13.0 — 2026-04-29 - 8.12.1 — 2026-03-26 - 8.12.0 — 2025-08-20 - 8.11.0 — 2025-08-04 - 8.10.0 — 2025-06-24 - 8.9.0 — 2025-06-24 - 8.8.3 — 2025-04-14 - 8.8.2 — 2025-02-21 - … 69 more at https://npm.io/package/@janiscommerce/model/versions ## README # model ![Build Status](https://github.com/janis-commerce/model/workflows/Build%20Status/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/janis-commerce/model/badge.svg?branch=master)](https://coveralls.io/github/janis-commerce/model?branch=master) [![npm version](https://badge.fury.io/js/%40janiscommerce%2Fmodel.svg)](https://www.npmjs.com/package/@janiscommerce/model) ## 📦 Installation ```sh npm install @janiscommerce/model ``` ## ⚠️ Core logging & sensitive data _(Since 8.15.0)_ Models whose `databaseKey` maps to a **core** database now automatically log their write operations as _core logs_ (client-less logs sent to the trace service). This means the data written by core models — which may include sensitive fields — starts being sent to the logs. **Before upgrading, review your core models** and make sure sensitive fields are not logged: - exclude them per-model with the `excludeFieldsInLog` static getter (e.g. `['password', 'super-secret']`), which removes the field from the log, - mask them service-wide with the `JANIS_TRACE_PRIVATE_FIELDS` env var from [`@janiscommerce/log`](https://www.npmjs.com/package/@janiscommerce/log#env-variables), which recursively replaces the listed fields with `***` in every log, or - disable logging entirely with `static get shouldCreateLogs() { return false; }`. See the [Logging](#clipboard-logging) section for details. ## Breaking changes ⚠️ ### 6.0.0 - When use `changeKeys` param and cannot get any items, it will return an empty object (before returns an empty array) ## Future versions 🔜 ### 9.0.0 - ⚠️ Deprecated: Settings with `@janiscommerce/settings` will no longer be supported. (Replaced with **AWS Parameter Store** _Since 8.8.0_) - ⚠️ Deprecated: Usage of **AWS Secrets Manager** for credentials will no longer be supported. (Replaced with **AWS Parameter Store** _Since 8.8.0_) ## 🔧 Database connection settings In order to use this package with a DB, you must to add the database connection settings, it can be set in service settings *`janiscommercerc.json`* **(Core model)** or in session **(Client Model)**. #### Configure database connection with `databaseKey` Regardless if you use a *Core* or *Client* model you may set the `databaseKey` that your model will use to get the database connection settings. Default: `'default'`. ```js class MyModel extends Model { get databaseKey() { return 'myDatabaseKey'; } } ``` 👀 Either in Core or Client model the `databaseKey` connection settings structure is the same: :information_source: The `type` property is the only one used by this package to fetch the correct DB Driver package to use. :warning: The rest of the connection properties depends entirely by the DB Driver that you will use. ```js { myDatabaseKey: { write: { "type": "mongodb", "host": "http://write-host-name.org", // ... }, read: { "type": "mongodb", "host": "http://read-host-name.org", // ... } } } ``` ### :information_source: Model types There are two different model types:
🛠 Core: Intended for internal databases that manages common data between clients. #### :one: Set the `databaseKey` in your Model extended class ```js class MyModel extends Model { get databaseKey() { return 'core'; } } ``` #### :two: Model will try to find your `databaseKey` in database service settings Using [Settings](https://www.npmjs.com/package/@janiscommerce/settings), with settings in file `/path/to/root/.janiscommercerc.json`: ```json { "database": { "core": { "write":{ "host": "http://my-host-name.org", "type": "mysql", // ... } } } } ```
👥 Client: Intended for only client databases that not shares data with other databases. #### 💉 Session injection The session injection is useful when you have a dedicated database per client. Using the public setter `session`, the session will be stored in the `controller` instance. All the controllers and models getted using that controller will have the session injected. #### :one: Set the `databaseKey` in your Model extended class ```js class MyModel extends Model { get databaseKey() { return 'myDatabaseKey'; } } ``` #### :two: Database connection configured with session injected Your client should have the config for read (optional) and/or write (required) databases. **Example of received client:** ```json { "name": "Some Client", "code": "some-client", "databases": { "default":{ "write": { "type": "mongodb", "host": "http://default-host-name.org", // ... } }, "myDatabaseKey": { "write": { "type": "mongodb", "host": "http://write-host-name.org", // ... }, "read": { "type": "mongodb", "host": "http://read-host-name.org", // ... } } } } ```
--- ### :outbox_tray: Getters * **shouldCreateLogs** (*static getter*). Returns if the model should log the write operations. Default: `true`. For more details about logging, read the [logging](#Logging) section. * **excludeFieldsInLog** (*static getter*). Returns the fields that will be removed from the logs as an array of strings. For example: `['password', 'super-secret']`. For more details about logging, read the [logging](#no_entry_sign-excluding-fields-from-logs) section. * **statuses** (*class getter*). Returns an `object` with the default statuses (`active` / `inactive`) * **executionTime** (*class getter*). Returns the time spent in _ms_ on the las query. --- ### :inbox_tray: Setters * **useReadDB** `[Boolean]` (*class setter*) Set if model should use the read DB in all read/write DB operations. Default: `false`. --- ## :gear: API ### async `getDb()`
Get the configured/sessionated DBDriver instance to use methods not supported by model. #### Example: ```js const dbDriver = await myModel.getDb(); await myModel.dbDriver.specialMethod(myModel); ```
### async `isCore()`
Returns true when the model is core or false otherwise. *Since 8.8.0* #### Core Example: ```js const myCoreModel = new MyCoreModel(); const isCore = await myCoreModel.isCore(); // true expected ``` #### Non-Core Example: ```js const myClientModel = new MyClientModel(); const isCore = await myClientModel.isCore(); // false expected ```
### async `get(params)`
Returns items from database. #### Parameters - `params` is an optional Object with filters, order, paginator. - `params.readonly` as `true` if you want to use the Read Database. #### Example ```js const items = await myModel.get({ filters: { status: 'active' } }); ```
### async `getById(id, [params])`
It's an alias of get(), passing and ID as filter and handling return value as an array if id is an array, or an object otherwise. #### Parameters - `id` is required. It can be one ID or an array of IDs - `params` is an optional Object with filters, order, paginator, changeKeys. #### Example ```js const items = await myModel.getById(123, { filters: { status: 'active' } }); ```
### async `getBy(field, id, [params])`
It's an alias of get(), passing and field and the values of that field as filter and handling return value as an array if value is an array, or an object otherwise. #### Parameters - `field` is required. A string as a field - `value` is required. It can be one value or an array of values - `params` is an optional Object with filters, order, paginator. #### Example ```js const items = await myModel.getBy(orderId, 123, { filters: { status: 'active' } }); ```
### async `getPaged(params, callback)`
Returns items from database using pages, the default limit is 500 items per page. #### Parameters - `params` See get() method - `callback` A function to be executed for each page. Receives three arguments: the items found, the current page and the page limit #### Example ```js await myModel.getPaged({ filters: { status: 'active' } }, (items, page, limit) => { // items is an array with the result from DB }); ``` #### Default order The default order when no order was received is field `id` using `asc` as order direction. _Since 6.8.3_
### async `getTotals(filters, params)`
This method returns an object with data of totals. If filters is not present it will default to last get() filters. If no get() was executed before and no filters param is present, it will use no filters #### Parameters - `filters` is an optional Object with filters or array of filters. _Since 7.1.0_ - `params` is an optional Object with params. _Since 8.9.0_ - `limit` The max amount of items to count as total. This can be ignored by the DB Driver if it's not supported or a full count is not a performance issue (for example, full collection count in MongoDB). #### Result object structure: - **pages**: The total pages for the filters applied - **page**: The current page - **limit**: The limit applied in get - **total**: The total number of items in DB for the applied filters #### Example ```js await myModel.get({ filters: { status: 'active' } }); const totals = await myModel.getTotals(); /** totals content: { pages: 15, page: 1, limit: 500, total: 7450 } */ ``` ```js const totals = await myModel.getTotals( { status: 'active' }, { limit: 6000 } ); /** totals content: { pages: 12, page: 1, limit: 500, total: 6000 } */ ```
### async `mapIdBy(field, fieldValues, [params])`
Search all items filtering by field and fieldValues and return an Object with key: referenceIds and values: id, only those founds. #### Parameters - `field` Field to filter for (`String`) - `fieldValues` List of values to filter for (`Array`) - `params` See get() method #### Example ```js await myModel.mapIdBy('code', ['code-123', 'code-456'], { order: { code: 'desc' } }); /** { code-456: 'the-code-456-id', code-123: 'the-code-123-id' } */ ```
### async `mapIdByReferenceId(referencesIds, [params])`
Search all References Ids and return an Object with key: referenceIds and values: id, only those founds. #### Parameters - `referencesIds` List of References Ids (`Array`) - `params` See get() method #### Example ```js await myModel.mapIdByReferenceId(['some-ref-id', 'other-ref-id', 'foo-ref-id'], { order: { date: 'asc' }, filters: { foo: 'bar' } }); /** { some-ref-id: 'some-id', foo-ref-id: 'foo-id' } */ ```
### async `distinct(key, params)`
Returns unique values of the key field from database. #### Parameters - `params` is an optional Object with filters. #### Examples ```js const uniqueValues = await myModel.distinct('status'); ``` ```js const uniqueValues = await myModel.distinct('status', { filters: { type: 'some-type' } }); ```
### async `insert(item)`
Inserts an item in DB. This method is only for insert, will not perform an update. #### Example ```js await myModel.insert({ foo: 'bar' }); const items = await myModel.get({ filters: { foo: 'bar' }}); /** itemInserted content: [ { foo: 'bar' } //... ] */ ```
### async `save(item, setOnInsert, options)`
Inserts/updates an item in DB. This method will perfrom an upsert. #### Parameters - `setOnInsert` to add default values on Insert, optional - `options` optional object forwarded to the database driver (e.g. MongoDB `save`). _Since **8.14.0**_. Supported flags depend on the driver; commonly: - `skipAutomaticSetModifiedData`: _Boolean_. When **true**, the fields `dateModified` and `userModified` are not set automatically on `item` before the driver runs (aligned with `update()`). #### Example ```js await myModel.save({ foo: 'bar' }, { status: 'active' }); await myModel.save({ foo: 'bar' }, {}, { skipAutomaticSetModifiedData: true }); const items = await myModel.get({ filters: { foo: 'bar' }}); /** items content: [ { foo: 'bar', status: 'active' } //... ] */ ```
### async `update(values, filter, params)`
Update items that match with the filter. #### Parameters - `params` optional parameters to define some behavior of the query - `skipAutomaticSetModifiedData`: _Boolean_. When receive as **true**, the fields `dateModified` and `userModified` are not updated automatically. #### Example ```js await myModel.update({ updated: 1 }, { status: 5 }); // will set updated = 1 for the items that has status = 5 ```
### async `remove(item)`
Remove an item from DB. #### Example ```js await myModel.remove({ foo: 'bar' }); const items = await myModel.get({ filters: { foo: 'bar' }}); /** items content: [] */ ```
### async `multiInsert(items, options)`
Perform a bulk insert of items in DB. This action will insert elements, and will not update elements. #### Parameters - `items` array of objects to insert (required) - `options` optional object forwarded to the database driver (e.g. MongoDB `multiInsert`). _Since **8.14.0**_. Flags depend on the driver; for example the MongoDB driver may honor `failOnDuplicateErrors` among others. #### Example ```js await myModel.multiInsert([{ foo: 1 }, { foo: 2 }]); await myModel.multiInsert([{ foo: 1 }], { failOnDuplicateErrors: true }); const items = await myModel.get(); /** items content: [ { foo: 1 }, { foo: 2 } ] */ ```
### async `multiSave(items, setOnInsert, options)`
Perform a bulk save of items in DB. This action will insert/update (upsert) elements. #### Parameters - `setOnInsert` to add default values on Insert, optional - `options` optional object forwarded to the database driver (e.g. MongoDB `multiSave`). _Since **8.14.0**_. Supported flags depend on the driver; commonly: - `skipAutomaticSetModifiedData`: _Boolean_. When **true**, `dateModified` and `userModified` are not set automatically on each item before the driver runs. #### Example ```js await myModel.multiSave([{ foo: 1 }, { foo: 2, status: 'pending' }], { status: 'active' }); await myModel.multiSave([{ id: '...', foo: 1 }], {}, { skipAutomaticSetModifiedData: true }); const items = await myModel.get(); /** items content: [ { foo: 1, status: 'active' }, { foo: 2, status: 'pending' } ] */ ```
### async `multiRemove(filter)`
Perform a bulk remove of items in DB. #### Example ```js await myModel.multiRemove({ status: 2 }); const items = await myModel.get({ filters: { status: 2 }}); /** items content: [] */ ```
### async `increment(filters, incrementData)`
Increment/decrement values from an item in DB. This method will not perform an upsert. #### Example ```js await myModel.increment({ uniqueIndex: 'bar' }, { increment: 1, decrement: -1 }); /** before: items content: [ { increment: 1, decrement: 2 } //... ] after: items content: [ { increment: 2, decrement: 1 } //... ] */ ```
### static `changeKeys(items, newKey)`
Creates an object list from the received array of items, using the specified field as keys. #### Parameters - `items` The items array - `newKey` The common field in items that will be used as key for each item #### Example ```js const myItems = await myModel.get(); /* [ { some: 'item', otherProp: false }, { some: 'otherItem', otherProp: true } ] */ const myItemsByKey = MyModel.changeKeys(myItems, 'some'); /* { item: { some: 'item', otherProp: false }, otherItem: { some: 'otherItem', otherProp: true } } */ ``` :information_source: In get methods such as `get` and `getBy` you can add the `changeKeys` param with the `newKey` value. ```js const myItems = await myModel.get({ changeKeys: 'some' }); /* { item: { some: 'item', otherProp: false }, otherItem: { some: 'otherItem', otherProp: true } } */ ``` :information_source: _Since 6.0.0_: When no items were found it will return an empty object ```js const myItems = await myModel.get({ filters: { status: 'active' }, changeKeys: 'other' }); /* {} */ ```
### async `dropDatabase()`
Drop the Database. #### Example ```js await myModel.dropDatabase(); ```
### async `aggregate(stages)`
Execute Aggregation operations to obtain computed results in Databases > :warning: Not supported by all database connectors #### Parameters - `stages` An array with the aggregation stages - `options` An object with additional options #### Examples ```js const results = await myModel.aggregate([ { $match: { id: '0000000055f2255a1a8e0c54' } }, // find the document with that id { $unset: 'category' }, // Removes the category field ]); /** [ { id: '0000000055f2255a1a8e0c54', name: 'Product 1', description: 'Product 1 description' } ] */ ``` ```js await myModel.aggregate([ { $group: { _id: '$status', count: { $sum: 1 } } }, ], { allowDiskUse: true, hint: { status: 1 } }); /* > { active: 2342, inactive: 992 } */ ```
### async `multiUpdate(operations, options)`
Perform a bulk save of update operations in DB. This action will update elements according to received filters. #### Example ```js await myModel.multiUpdate([ { filter: { id: [1,2] }, data: { name: 'test 1' } }, { filter: { otherId: 3 }, data: { name: 'test 2' } } ]); const items = await myModel.get(); /** items content: [ { id: 1, name: 'test 1' }, { id: 4, otherId: 3, name: 'test 2' } ] */ ``` #### Parameters - `operations`: `Array` - A list of db operations to be executed - `options`: `Object` (optional) - Additional options for the multiUpdate operation
--- ### :bookmark_tabs: Indexes Manipulation ##### :warning: Only if DB Driver supports it ### async `getIndexes()`
Get an array of indexes in Database table. ### Example ```js await myModel.getIndexes(); /* [ { name: '_id_', key: { _id_: 1}, unique: true }, { name: 'code', key: { code: 1} } ] */ ```
### async `createIndex(index)`
Create a single index in Database Table. #### Example ```js await myModel.createIndex({ name: 'name', key: { name: 1}, unique: true }); ```
### async `createIndexes(indexes)`
Create a multiple indexes in Database Table. #### Example ```js await myModel.createIndexes([{ name: 'name', key: { name: 1}, unique: true }, { name: 'code', key: { code: -1 }}]); ```
### async `dropIndex(name)`
Drop a single in Database Table. #### Example ```js await myModel.dropIndex('name'); ```
### async `dropIndexes(names)`
Drop multiple indexes in Database Table. #### Example ```js await myModel.dropIndexes(['name', 'code']); ```
### async `getIdStruct()`
Returns struct function to validate ID Type. This struct will vary depending on the implemented DB by the model #### Example (for mongodb DB) ```js const idStruct = await myModel.getIdStruct(); /* struct('objectId') */ ```
## :clipboard: Logging This package automatically logs any write operation such as: - **`insert()`** - **`multiInsert()`** - **`update()`** - **`save()`** - **`multiSave()`** - **`increment()`** - **`remove()`** - **`multiRemove()`** :information_source: The logs will be added using the package [@janiscommerce/log](https://www.npmjs.com/package/@janiscommerce/log). ### Automatic data in `log` The package will add automatic fields in the `log` _Object_ field. - `executionTime`. Each log will have the time spent on the query. _Since 6.6.0_ - `itemsBatch`. Exclusively for methods `multiInsert()` and `multiSave()`, will be added the quantity of items _inserted_ or _updated_ in the same query. _Since 6.6.0_ ### Grouped logs for batch writes _Since 8.16.0_ `multiInsert()` and `multiSave()` now emit a single **grouped** log per batch of items with id, instead of one log per item. A grouped log identifies its items through `relatedEntities` (`entity:id` tokens, `entity` = model name) and carries the item payloads under `log.items` (e.g. `relatedEntities: ['product:5ea1c8c53fdac68fb60eac9e', 'product:5ea1c8cd11f82560a364cbd4']`). A single-item write keeps the previous per-item shape (`entityId` + `item`). To stay within the trace service's per-record limit, large batches are split into several grouped logs by item count and serialized size (whichever limit is reached first). ### :no_mouth: Disabling automatic logging
This functionality can be disabled in 2 ways 1. For all Model operation: by setting the `static getter shouldCreateLogs` to `false`. #### Example ```js class MyModel extends Model { static get shouldCreateLogs() { return false; } } ``` 2. For the "next" operation: by using the method `disableLogs()`. _Since 8.3.0_ :information_source: The logs are disabled **only for the following operation** ### Example ```js // will not save logs await myModel.disableLogs().insert({ pet: 'roger', animal: 'dog', age: 8 }); // will save logs normally await myModel.insert({ pet: 'ringo', animal: 'dog', age: 7 }); ``` 3. Re-enabling logs: by using the method `enableLogs()`. _Since 8.15.0_ :information_source: Reverts a pending `disableLogs()` before it is consumed by the next operation, restoring the automatic logging ### Example ```js // An earlier step in the flow decided to skip logging for the next write myModel.disableLogs(); // ...but a later condition determines the write must be audited after all, // so the pending disableLogs() is reverted before the operation runs if(mustAudit) myModel.enableLogs(); // logs are saved normally because enableLogs() cancelled the pending disableLogs() await myModel.insert({ pet: 'roger', animal: 'dog', age: 8 }); ```
### :no_entry_sign: Excluding fields from logs
You can exclude fields for logs in case you have sensitive information in your entries such as passwords, secondFactor, etc. #### Specify the fields (as field name or field path) to exclude by setting them in the `static getter` `excludeFieldsInLog`: ```js class MyModel extends Model { static get excludeFieldsInLog() { return [ 'password', // Exclude the password field 'preferences.**.specialNotes', // Exclude the specialNotes field without knowing the intermediate field path between such field and the root path '*.shipping.*.secondFactor', // Exclude the secondFactor field in any object in the shipping array without specifying the root object '*.shipping.*.items.*.quantity' // Exclude the quantity field in any object in the items array of any object in the shipping array without specifying the root object ] } } ``` By setting this when you do an operation with an item like: ```js await myModel.insert({ user: 'johndoe', password: 'some-password', preferences: { shippingDetails: { specialNotes: 'some shipping notes' } } location: { country: 'some-country', address: 'some-address' }, shipping: [ { addressCommerceId: 'some-address-commerce-id', isPickup: false, type: 'delivery', deliveryEstimateDate: '2025-04-24T22:35:56.742Z', deliveryWindow: { initialDate: '2025-04-24T22:25:56.742Z', finalDate: '2025-04-24T22:35:56.742Z' }, price: 10, items: [ { index: 0, quantity: 1 } ], secondFactor: { method: 'numericPin', value: '1234' } } ] }); ``` It will be logged as: ```js { user: 'johndoe', preferences: { shippingDetails: {} } location: { country: 'some-country', address: 'some-address' }, shipping: [ { addressCommerceId: 'some-address-commerce-id', isPickup: false, type: 'delivery', deliveryEstimateDate: '2025-04-24T22:35:56.742Z', deliveryWindow: { initialDate: '2025-04-24T22:25:56.742Z', finalDate: '2025-04-24T22:35:56.742Z' }, price: 10, items: [ { index: 0 } ] } ] } ``` ℹ️ **Note**: - The wildcard `*` in the field path of the `excludeFieldsInLog` static getter, is used to access properties inside arrays or when the root field path is unknown. - The wildcard `**` in the field path of the `excludeFieldsInLog` static getter, can be used when the intermediate field path is unknown between the root and the field to exclude. - The `excludeFieldsInLog` static getter can have both field names and field paths. ⚠️ **Warning**: - When using the wildcard `*` alone in the field path of the `excludeFieldsInLog` static getter, it will exclude all the fields in the log. - In case the field path is incorrect, it will not exclude any field.
### :memo: Set custom log data
You can add custom message or object data to log
Adding a custom message: ```js await myModel .setLogData('custom message!') .insert({ foo: 'bar' }); /* Log: { ...logData, message: 'custom message!' } */ ``` Adding a custom object data: ```js await myModel .setLogData({message:'custom message!', type:'some type'}) .insert({ foo: 'bar' }); /* Log: { ...logData, message: 'custom message!', type:'some type' } */ ``` Adding a custom object data with log property name: ```js await myModel .setLogData({message:'custom message!', type:'some type', log: { isTest: true }}) .insert({ foo: 'bar' }); /* Log: { ...logData, message: 'custom message!', type:'some type', log:{ ...defaultModelLogData, isTest: true } } */ ```
## 🔑 Secrets > ⚠️ Deprecated: This configuration will no longer be supported starting from version 9.0.0. ⚠️ The package will get the **secret** using the `JANIS_SERVICE_NAME` environment variable. If the **secret** is found, the result will be merged with the settings found in the *`janiscommercerc.json`* file or in the Client databases configuration. See [Database connection settings](#Database-connection-settings). The Secrets are stored in [AWS Secrets Manager](https://aws.amazon.com/secrets-manager) and obtained with the package [@janiscommerce/aws-secrets-manager](https://www.npmjs.com/package/@janiscommerce/aws-secrets-manager)
Complete example in which the settings are obtained for settings file or Client and merged with the fetched credentials in AWS Secrets Manager. 1. Settings in file or Client. ```json { "core": { "write": { "type": "mongodb", "database": "core", "otherDBDriverConfig": 100 } } } ``` 2. Secret fetched. ```json { "databases": { "core": { "write": { "host": "mongodb+srv://some-host.mongodb.net", "user": "secure-user", "password": "secure-password", } } } } ``` 3. Config passed to the Database Driver. ```json { "core": { "write": { "type": "mongodb", "database": "core", "otherDBDriverConfig": 100, "host": "mongodb+srv://some-host.mongodb.net", "user": "secure-user", "password": "secure-password", } } } ```
### Skip Credential Fetching To skip the fetch of the credentials, it can be used the setting `skipFetchCredentials` set as **true**. ```json { "core": { "write": { "skipFetchCredentials": true, "type": "mongodb", "protocol": "mongodb+srv://", "host": "mongodb+srv://some-host.mongodb.net", "user": "some-user", "password": "insecure-password" } } } ``` --- _Source: https://npm.io/package/@janiscommerce/model · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._