Constructor
new Postgresjs(resumeopt, configopt)
- Source:
Example:
//.. var suspend = require("suspend"); var myconfig = require("./dbConfig2.json"); var db = new Postgresjs(suspend.resume,myconfig); //..
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
resume |
function |
<optional> |
null
|
set to suspend.resume from generator context to use suspend library with yields. See setResume. |
config |
Object |
<optional> |
null
|
Overwrite the global config for just this instance. |
Members
(static) config
- Source:
This should be static across your entire project and only needs to be set once.
Set to the Contents of dbConfig.json as Object.
Example:
var Postgresjs = require("postgresjs"); Postgresjs.config = require("./dbConfig.json"); //..
connectionString
- Source:
rowCount
- Source:
rows
- Source:
throwErrors
- Source:
Methods
asyncForEach(cbIterator, cbFinalopt, enableCallbackopt)
- Source:
Example:
//.. yield db.asyncForEach((index,item,next) => { console.log(index + ") ",item); //.. next(); }); //..
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
cbIterator |
Postgresjs~cbAsyncForEachIterator | Returns cb(index,item,cbNext).
Must call cbNext() to continue. |
||
cbFinal |
Postgresjs~cbAsyncForEachFinal |
<optional> |
null
|
Returns cb(). |
enableCallback |
Boolean |
<optional> |
true
|
Set to false to disable default callback handling (used to disable suspend.resume on loop completion). |
begin(cbopt)
- Source:
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
cb |
Postgresjs~cbOnError |
<optional> |
null
|
Use callback or leave null to use suspend.resume.
Returns cb(err) |
commit(cbopt)
- Source:
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
cb |
Postgresjs~cbOnError |
<optional> |
null
|
Use callback or leave null to use suspend.resume.
Returns cb(err) |
deleteHelper(options, cbopt)
- Source:
Example:
Deletes user record with the username "tester".//.. yield db.deleteHelper({ table: "users", where: db.whereHelper({ "username":"tester" }) }); //..
Parameters:
Name | Type | Attributes | Default | Description | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | Required. See properties:
Properties
|
|||||||||||||||||||||||||||
cb |
Postgresjs~cbOnError |
<optional> |
null
|
Use callback or leave null to use suspend.resume.
Returns cb(err) |
end(cbopt)
- Source:
Alias: close(cb)
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
cb |
Postgresjs~cbOnEmpty |
<optional> |
null
|
Use callback or leave null to use suspend.resume.
Returns cb(err) |
error()
- Source:
Returns:
insertHelper(options, cbopt)
- Source:
Example:
Insert new user into users table.//.. yield db.insertHelper({ table:"users", columns:{ "username":"tester", "email":"oldemail@test.com" } }); //..
Parameters:
Name | Type | Attributes | Default | Description | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | Required. See properties:
Properties
|
|||||||||||||||||||||||||||
cb |
Postgresjs~cbOnError |
<optional> |
null
|
Use callback or leave null to use suspend.resume.
Returns cb(err) |
merge(sqlInsert, parasInsertopt, sqlUpdate, parasUpdateopt, cbopt)
- Source:
Try using instead the Postgresjs#mergeHelper to generate the two sql statements.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
sqlInsert |
String | sql statement with unnamed parameters (ie: ?) | ||
parasInsert |
Array |
<optional> |
null
|
array of parameters to replace ? in sql |
sqlUpdate |
String | sql statement with unnamed parameters (ie: ?) | ||
parasUpdate |
Array |
<optional> |
null
|
array of parameters to replace ? in sql |
cb |
Postgresjs~cbOnMerge |
<optional> |
null
|
Use callback or leave null to use suspend.resume.
Returns cb(err,result) where result will be either "insert" or "update" depending on which action was used. |
mergeHelper(options, cbopt)
- Source:
Merge is a smart method that uses insert or update internally. See Postgresjs#merge for more information.
Example:
Inserts a new user in the users table or updates their email if already found.//.. yield db.mergeHelper({ table: "users", columns: { "username":"tester", "email":"test@test.com" }, where: db.whereHelper({ "username":"tester" }) }); //..
Parameters:
Name | Type | Attributes | Default | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | Required. See properties:
Properties
|
|||||||||||||||||||||||||||||||||||||
cb |
Postgresjs~cbOnMerge |
<optional> |
null
|
Use callback or leave null to use suspend.resume.
Returns cb(err,result) where result is either "update" or "insert" depending on which operation was needed. |
orderByHelper(options)
- Source:
Sort options are either "ASC" or "DESC".
Parameters:
Name | Type | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | Required. See properties:
Properties
|
Returns:
query(sql, parasopt, cbopt)
- Source:
Use question-marks (ie: ?) as unnamed parameters within the SQL statement.
Example:
//.. yield db.query("select username from users where email=?;",["test@test.com"]); for (let row of db.rows) { console.log(row.username); } //..
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
sql |
string | sql statement to execute | ||
paras |
Array |
<optional> |
null
|
array of parameters, replacing "?" in SQL |
cb |
Postgresjs~cbOnQuery |
<optional> |
null
|
Use callback or leave null to use suspend.resume.
Returns cb(err,results) where result is an array of rows. |
rollback(cbopt)
- Source:
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
cb |
Postgresjs~cbOnError |
<optional> |
null
|
Use callback or leave null to use suspend.resume.
Returns cb(err) |
selectArray(sql, parasopt, cbopt)
- Source:
Use question-marks (ie: ?) as unnamed parameters within the SQL statement.
Example:
//.. let arr = yield db.selectArray("select username from users where email=?;",["test@test.com"]); //..
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
sql |
string | sql statement to execute | ||
paras |
Array |
<optional> |
null
|
array of parameters, replacing "?" in SQL |
cb |
Postgresjs~cbOnQuery |
<optional> |
null
|
Use callback or leave null to use suspend.resume.
Returns cb(err,results) where result is an array of rows. |
selectHelper(options, cbopt)
- Source:
Example:
Select emails from users table that have a username that starts with the letter "h"://.. yield db.selectHelper({ table:"users", columns:["username","email"], where: db.whereHelper({ "username -like":"h%" }), orderBy: db.orderByHelper({ "email":"ASC" }) }); for (let row of db.rows) { console.log(row); //Output example: {username:"Tester",email:"test@test.com"} } //..
Parameters:
Name | Type | Attributes | Default | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | Required. See properties:
Properties
|
||||||||||||||||||||||||||||||||||||||||||
cb |
Postgresjs~cbOnQuery |
<optional> |
null
|
Use callback or leave null to use suspend.resume.
Returns cb(err,results) where result is an array of rows. |
selectRow(sql, parasopt, cbopt)
- Source:
Use question-marks (ie: ?) as unnamed parameters within the SQL statement.
Example:
//.. let row = yield db.selectRow("select username from users where email=?;",["test@test.com"]); //..
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
sql |
string | sql statement to execute | ||
paras |
Array |
<optional> |
null
|
array of parameters, replacing "?" in SQL |
cb |
Postgresjs~cbOnQuery |
<optional> |
null
|
Use callback or leave null to use suspend.resume.
Returns cb(err,results) where result is an array of rows. |
setLocalConfig(config)
- Source:
Parameters:
Name | Type | Description |
---|---|---|
config |
Object |
setResume(resume)
- Source:
Parameters:
Name | Type | Description |
---|---|---|
resume |
function | set to suspend.resume, set to null to disable |
start(cbopt)
- Source:
Alias: open(cb)
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
cb |
Postgresjs~cbOnError |
<optional> |
null
|
Use callback or leave null to use suspend.resume.
Returns cb() |
updateHelper(options, cbopt)
- Source:
Example:
Updates user's email by username.//.. yield db.updateHelper({ table: "users", columns: { "email":"newemail@test.com" }, where: db.whereHelper({ "username":"tester" }) }); //..
Parameters:
Name | Type | Attributes | Default | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | Required. See properties:
Properties
|
|||||||||||||||||||||||||||||||||||||
cb |
Postgresjs~cbOnError |
<optional> |
null
|
Use callback or leave null to use suspend.resume.
Returns cb(err) |
whereHelper(variables, defaultLogicopt)
- Source:
Example:
//.. db.whereHelper({ "name -like":"%Smith", "banned":false }); //..
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
variables |
Object | Set keys as column names and values as desired value.
Special flags may be appended to key string: -like : uses the LIKE comparator -notlike : uses the NOT LIKE comparator -not : uses the != comparator default : uses the = comparator |
||
defaultLogic |
String |
<optional> |
"AND"
|
logic seperator (ie: OR) |
Returns:
Type Definitions
cbOnEmpty()
- Source:
cbOnError(err)
- Source:
Parameters:
Name | Type | Description |
---|---|---|
err |
Error | Returns an error if there was one, or null. |
cbOnMerge(err, result)
- Source:
Parameters:
Name | Type | Description |
---|---|---|
err |
Error | An error if there was one, or null. |
result |
String | Either "insert" or "update" depending on what was used. |
cbOnQuery(err, result)
- Source:
[ {id: 1, name: "Bob"}, {id: 2, name: "John"} ]
Parameters:
Name | Type | Description |
---|---|---|
err |
Error | An error if there was one, or null. |
result |
Array | An array of objects, where each object represents a row, or null. |