Global

parameter name, can be a string regexp to match dynamic parameters, matched pieces then can be used by the make property to build the final variable name.

parameter description, it is show when run bksh -help command

a valid config type:

• none - skip this parameter
• bool - converts to a boolean
• int, real, number - converts to a number
• map - convert key:value,key:value... pairs into an object, see delimiter/separator properties
• set, list - array type, set makes the list unique, splits strings by separator or ,|
• regexp - a RegExp
• regexpobj - add a regexp to the object that consist of list of patterns and compiled regexp, lib.testRegexpObj
• regexpmap - Add a regexp to the list of regexp objects
• url - an object produces by URL.parse
• json, js - parse as JSON into an object/array
• path - resolves to an absolute path
• callback - calls the callback property only, does not save
• file - reads contents of the file

object name in the module where to store the value, otherwise the value is defined in the module, the obj name is stripped automatically from the variable name. The object name can contain dots to point to deep objects inside the module.

make the variable name from the matched pieces, the final variable is constructed by replacing every $1, $2, ... with corresponding matched piece from the name regexp.

if true prepend a value to the list, to remove an item prepend it with !!

for array: mode append a value

process only args that match the pass value

env variable name to apply before parsing config files

if true merge properties with existing object, 'obj' must be provided

if true and the name contains dots it is treated as deep object

default is auto to parse map values or can be any value type, for type map

works with regexp names like name-([a-z]+)-(.+) to build the final parameter name, can use $1, $2, $3...placeholders

skip if value is equal or included in the list, also works for merges

sort array params

only keep unique items in lists

characters to use when camelizing the name, default is "-"

do not camelize the name

do not save empty values

detect type by using module:lib.autoType

do not save if matches given string or contained in the list

text with examples

function to call for the callback types for manully parsing and setting the value, (value, obj) the obj being current parameter

function to call at the end for additional processing as (value, obj)

separator to use for list and map items, for lists default is ,|, for maps it is :;

separator to split key:value pairs, default is ,

allows empty values for maps and regexps

parsed but not saved, usually it is handled by onupdate callback

text to stripo from the final variable name

only set this parameter once

perform alter table instead of create

type mapping, convert lowercase type into other type supported by any specific database

ignore default value if not supported (Cassandra)

NOT NULL restriction is not supported (Cassandra)

return as a list, the driver does not support multiple SQL commands

ignore column length for columns (Cassandra)

do not support IF EXISTS on table or indexes

does not support composite indexes (Cassandra)

no support for auto increment columns

object with operations which dont support null(empty) values

actual column name

type from DbTableColumn

operator to use in comparison or update, lowercase and all underscores are converted into spaces

value passed for compare or update

join operator, AND is default

original name in case name contained _$ placeholder

existing column definition or undefined

name of the database pool where to execute this query. The difference with the high level functions that take a table name as their firt argument, this function must use pool explicitely if it is different from the default. Other functions can resolve the pool by table name if some tables are assigned to any specific pool by configuration parameters `db-pool-tables__.

function to filter rows not to be included in the result, returns a new result set, args are: function(req, rows)

function to process rows in the result, returns a new result, args are: function(req, rows), this result will be put in cache if requested so this may be used for preparing cached results, it must return an array

function to process result rows via async callback, return a new result in the callback, the function is: function(req, rows, callback), the callback is function(err, rows)

log results at the end with this level or debug by default

log errors with this level instead of error

clear errors occurred as it never happen, do not report in the log, if an array then only matched codes will be cleared

if true then skip post processing result rows, return the data as is, this will result in returning combined columns as it is

if true skip converting the data from the database format into Javascript data types, it uses column definitions

if true skip query preparation and columns processing, the req.query is passed as is, useful for syncing between pools for the table to convert values returned from the db into the the format defined by the column

if true then it is supposed to return only one record with property count, skip all post processing and convertion

to return the record just processed in the info object as query property, it will include all generated and updated columns

to return the query record as result including all post processing and new generated columns, this is not what returning property does, it only returns the query record with new columns from memory

if true then run getCached version directly

disable caching even if configured for the table

operators to use for for properties, an object with column name and operator.

Comparison operators used in select/get:

   between, match, regexp, iregexp, begins_with, not_begins_with, ends_with, not_ends_with,
   like, like%, ilike%, contains, not_contains, expr

Update operators used in incr/update/del:

• add - add to list
• del - remove from list
• incr - increment a number
• unset/remove - remove column or set to NULL
• append - append to existing column value
• prepend - prepend to existing column value
• not_exists - update only if the value is null, otherwise skip
• expr - SQL expression as is or can be an array of values with elememt 0 being the expression with the rest as values: ["COALESCE(name,$1)||$2", 'N/A', ' jr']

As an alternative, operators also can be used inside column names, the format is name_$op:

{ flags_$del: "flag" }
{ count_$incr: 3 }
{ tag_$expr: "COALESCE(name,'none')||count" }
{ tag_$expr: ["COALESCE(name,$1)||count", "N/A"] }

operator mapping between supplied operators and actual operators supported by the db

an object that defines ops by column type, for example typesOps: { list: "add" } will

type mapping between supplied and actual column types, an object make sure all lists will have options.ops set to add if not specified explicitly

a list of columns or expressions to return or all columns if not specified, only existing columns will be returned

start records with this primary key, this is the next_token passed by the previous query from module.db.select

how many records to retrieve in a single batch

a convenient option to return the first record from the result or null (similar to db.get method)

similar to first but return the last record

how to join condition expressions, default is AND

operators to use to combine several expressions in case when an array of values is given, supports and|or|AND|OR__

sort by this column. if not provided then no sorting must be done at all, records will be returned in the order they are kept in the DB.

• DynamoDB: this may affect the results if columns requsted are not projected in the index
• Elasticsearch: by default page based pagination is used if no fullscan is provided with or without the sort option

if sorting, do in descending order

starting page number for pagination, uses count to find actual record to start, for SQL databases mostly

exlicit key for caching, return from the cache or from the DB and then cache it with this key, works the same as get

a name of one of the cache keys to use, it must be defined by a db-cache-keys-table-name parameter

do not check for actual columns defined in the pool tables and add all properties from the obj, only will work for NoSQL dbs, by default all properties in the obj not described in the table definition for the given table will be ignored.

ignore properties by name listed in the this array, the most use case is to skip autogeneratd columns like "now"

an object with the condition for the update/incr ops, it is used instead or in addition to the primary keys in the query, a property named $or/$and will be treated as a sub-expression if it is an object. For multiple OR/AND use $$or, $$$or,...

create a new record if it does not exist

triggers to use specific capacity, default is read

a factor to apply for the read or write capacity limit and trigger the capacity check, default is 0.9

use a different table for capacity throttling instead of the table, useful for cases when the row callback performs writes into that other table and capacity is different

a full capacity object to pass to select calls, used by module:db.checkCapacity

if true rowCallback will be called with all rows from the batch, used in module:db.scan not every row individually, batch size is defined by the count property, used in module:db.scan

as batch mode but the rowCallback is called synchronously as rowCallback(row, info), used in module:db.scan

how many rows or operations to process at the same time, used in module:db.scan, module:db.batch

total number of records to scan, used in module:db.scan

if true no scan will be performed if no primary keys are specified to prevent scanning large tables, used in module:db.scan

if true force to perform a full scan, this is slightly different for each database, used in module:db.scan:

• DynamoDB: used full table scan, the query condition still is checked, can be expensive for large table because pricing is by every object checked not by what is actually returned
• Elasticsearch: performs streaming scan, using native order but all conditions are checked still, very effective for large scans

skip column preprocessing and dynamic values for pool sync and backup restore, used in module:db.copy

column1

column2

more columns

column type, supported types:

• int, bigint, log, real, float, number - numeric types
• bool, boolean - stored as boolean type
• text, string, keyword - text types
• date, time, timestamp - Date stored in database supported type, usually as text in SQL
• mtime - timestamp in milliseconds
• json - stored as JSON text but converted to/from native Javascript objects
• obj, object - native JSON object type
• array - native JSON array type
• list - store a list of primitive types, strings and/or numbers
• set - a unique set of string or numbers
• random - generates a random number in module:db.add/module:db.put methods, uses optional .max/.min properties
• ttl - in add/put save as timestamp in the future to be expired by database (DynamoDB)
• uuid, suuid, sfuuid - autogenerate the column value with UUID, optional prefix property will be prepended, { type: "uuid", prefix: "u" }_, see module:lib.uuid, module:lib.suuid, module:lib.tuuid
• now - defines a column to be automatically filled with the current timestamp
• counter - defines a columns that will be automatically incremented by the module:db.incr command, on creation it is set with 0
• uid - defines a columns to be automatically filled with the current user id, this assumes that user object is passed in the options from the API level
• uname - defines a columns to be automatically filled with the current user name, this assumes that user object is passed in the options from the API level
• ttl - mark the column to be auto expired, can be set directly to time in the future or use one of: days, hours, minutes as a interval in the future

column is part of the primary key, for composite keys the number defines the place starting with 1

column is part of an unique key, the number defines the order if it is composite key

column is part of an index, the value is a number for the column position in the index

additonal unique indexes where N is 1..25

additonal indexes where N is 1..25

default value to save if not provided

default value to return if not present in the db record

column length (SQL)

true if should be NOT NULL (SQL)

true for AUTO_INCREMENT column (SQL)

only add/put operations will use the value, incr/update will not affect the value

only incr/update can change this value, add/put will ignore it

prefix to be prepended for autogenerated columns: uuid, suuid, sfuuid

to be used as a separator in join or lists depending on the column properties

store as is without tokenizing (ElasticSearch)

a list with property names that must be joined together before performing a db operation, it will use the given record to produce a new property, empty properties will be still joined as empty strings.

foreign key reference (SQL)

Properties

convert value on save

Properties

validation checks

Properties

Generic SQL specific instructions to apply when creating a table or column

Sqlite specific instructions to apply when creating a table or column

PostgreSQL specific instructions to apply when creating a table or column

DynamoDB specific instructions to apply when creating a table or column

Elasticsearch specific instructions to apply when creating a table or column

API access permisions

Properties

primary key, user email, name or other unique identifier

unique auto-generated UUID

full user name

list of roles for access

custom tags

create time in milliseconds

last modified time, auto saved

hashed user password

if set access will be defined if beyond this time

can be used for push notifications

can be used for passkey verifications