Default Values

[MrSwitch]

A Default value would automatically add an insert value and filter condition when inserting and matching records respectively.

model.schema[ field ] = {
   default = Boolean | "String" | null | Number
}

How this differs from SQL Schema Field Attributes DEFAULT [value]

Defined on the dare model, rather than the DB Schema, so:

• Two models can share the same DB table, but with different defaults.
• Applies to queries in the filter and join conditions, not just INSERT | UPDATE (SET field = DEFAULT) operations.

Example

e.g. Below the active status on a members model is used to enforce the condition on queries

// Set active status on the model
models.members.schema.status = {
   default: 'active'
}

// Assign model to Dare
const dare = new Dare({models});

// Make a query...
await dare.get({
   table: 'members',
   fields: ['name'],
   limit: 100
});

/*
-- The generated SQL would include the filter condition...
SELECT name FROM members WHERE status = 'active'
*/

The condition would also be enforced on other operations

• patch: WHERE ... AND status = 'active'
• del: WHERE ... AND status = 'active'
  Whilst POST operation automatically appends it to the insert
• post: INSERT (..., status) VALUES (...'active')

Overriding this behaviour per query

Simply set the value e.g.

// Set's the range of status values
await dare.get({
   table: 'members',
   fields: ['name'],
   filter: {status: ['active', 'disabled']}
   limit: 100
});

TODO: should we permit a value of undefined to remove the condition altogether? e.g. (status: undefined)

Defining per method default rules

When it's not appropriate to have the rule applied to a particular method (or at all). It can be set using an object where the properties pertain to the name of the method.

For example: Where we want to restrict the del operation of a member record with a 'disabled' state.

// Set active status on the model
models.members.schema.status = {
   default: {
       del: 'disabled',
       get: 'active',
       post: 'active',
      // patch: undefined
   }
}

The above settings would result in the following rules being applied depending on the operation.

• get: WHERE ... AND status = 'active'
• del: WHERE ... AND status = 'disabled'
  Whilst POST operation automatically appends it to the insert
• post: INSERT (..., status) VALUES (...'active')
  Whilst PATCH operation would not be filtered at all
• patch: WHERE ... // no condition added because it's not defined

[5app-Machine]

🎉 This issue has been resolved in version 0.68.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀