Module: database

Database

Source: database.js, line 9

Methods

(inner) addDatabase()

Adds the specified database icon to the user's workspace, without opening the database.

Source: database.js, line 374

Throws:

no plans to implement
Type Error

(inner) addDatabaseRepID()

Adds an icon to the desktop for the database specified by its replica ID.

Source: database.js, line 382

Throws:

no plans to implement
Type Error

(inner) databaseDelete()

Permanently deletes the current database file from the hard disk where it is stored.

Source: database.js, line 391

Throws:

no plans to implement
Type Error

(inner) databaseReplSettings()

Displays the Replication Settings dialog box for the current database.

Source: database.js, line 399

Throws:

no plans to implement
Type Error

(inner) dAverage(database, field, criteria) → {number}

Finds the average of values in a given field from the records (rows) in a database that match a search criteria.

Parameters:

Name	Type	Description
`database`	Array	Range of values that makes up the list or database. A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
`field`	string	Indicates which column is used in the function. Enter the column label enclosed between double quotation marks, such as "Age" or "Yield," or a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
`criteria`	Array	Range of values that contains the conditions you specify. You can use any range for the criteria argument, as long as it includes at least one column label and at least one value below the column label in which you specify a condition for the column.

Source: database.js, line 35
See: For further information, see docs.oasis-open.org

Returns:

Average of the field's values from call to OpenFormula DAVERAGE function

Type:: number

(inner) dB2Schema(any)

Given the name of a database as a text string, returns a text string containing the DB2® schema of that database if it is a db2nsf database or the empty string if it is not a db2nsf database.

Parameters:

Name	Type	Description
`any`	Array	arguments

Source: database.js, line 238

Throws:

No plans to implement
Type Error

(inner) dbColumn(cache, serverDatabase, viewName, column)

Returns a column of values from a view or folder in a Domino® database.

Parameters:

Name	Type	Default
`cache`	*
`serverDatabase`	*
`viewName`	string
`column`	number	1

Source: database.js, line 191
See: For further information, see www.hcltechsw.com

Returns:

Promise

(inner) dbCommand(any)

Accesses view and folder information from a Domino® database in Web applications.

Parameters:

Name	Type	Description
`any`	Array	arguments

Source: database.js, line 247

Throws:

No plans to implement
Type Error

(inner) dbExists(any)

Given a server and file name, or replica ID, indicates whether the specified database exists.

Parameters:

Name	Type	Description
`any`	Array	arguments

Source: database.js, line 257

Throws:

No plans to implement
Type Error

(inner) dbLookup(cache, serverDatabase, viewName, key, field)

Given a key value, looks in the specified view (or folder) and finds all documents containing the key value within the view.

Parameters:

Name	Type	Description
`cache`	*
`serverDatabase`	*
`viewName`	string
`key`	string
`field`	*

Source: database.js, line 205
See: For further information, see www.hcltechsw.com

Returns:

Promise

(inner) dbManager(any)

Returns a list of users, groups, and servers who currently have Manager access to the database. In a window title formula, only the name of the first manager listed in the ACL is displayed.

@DbManager does not work in selection formulas or column formulas.

Parameters:

Name	Type	Description
`any`	Array	arguments

Source: database.js, line 270

Throws:

No plans to implement
Type Error

(inner) dbName(any)

Returns the name of the current Domino® server and database.

Parameters:

Name	Type	Description
`any`	Array	arguments

Source: database.js, line 279

Throws:

No plans to implement
Type Error

(inner) dbTitle(any)

Returns the title of the current database.

Parameters:

Name	Type	Description
`any`	Array	arguments

Source: database.js, line 288

Throws:

No plans to implement
Type Error

(inner) dCount(database, field, criteria) → {number}

Counts the number of records (rows) in a database that match a search criteria and contain numerical values.

Parameters:

Name	Type	Description
`database`	Array	The database
`field`	string	The field
`criteria`	Array	The criteria

Source: database.js, line 48
See: For further information, see docs.oasis-open.org

Returns:

Count of records matching search criteria from call to OpenFormula DCOUNT function

Type:: number

(inner) dCountA(database, field, criteria) → {number}

Counts the number of records (rows) in a database that match a search criteria and contain values (as COUNTA).

Parameters:

Name	Type	Description
`database`	Array	The database
`field`	string	The field
`criteria`	Array	The criteria

Source: database.js, line 61
See: For further information, see docs.oasis-open.org

Returns:

Count of records matching search criteria from call to OpenFormula DCOUNTA function

Type:: number

(inner) dGet(database, field, criteria) → {number}

Get the single value in the field from the single record (row) in a database that matches a search criteria.

Parameters:

Name	Type	Description
`database`	Array	The database
`field`	string	The field
`criteria`	Array	The criteria

Source: database.js, line 73
See: For further information, see docs.oasis-open.org

Returns:

Value in field matching search criteria from call to OpenFormula DGET function

Type:: number

(inner) dMax(database, field, criteria) → {number}

Finds the maximum value in a given field from the records (rows) in a database that match a search criteria.

Parameters:

Name	Type	Description
`database`	Array	The database
`field`	string	The field
`criteria`	Array	The criteria

Source: database.js, line 86
See: For further information, see docs.oasis-open.org

Returns:

Maximum value of the field's values matching search criteria from call to OpenFormula DMAX function

Type:: number

(inner) dMin(database, field, criteria) → {number}

Finds the minimum value in a given field from the records (rows) in a database that match a search criteria.

Parameters:

Name	Type	Description
`database`	Array	The database
`field`	string	The field
`criteria`	Array	The criteria

Source: database.js, line 99
See: For further information, see docs.oasis-open.org

Returns:

Minimum value of the field's values matching search criteria from call to OpenFormula DMIN function

Type:: number

(inner) dProduct(database, field, criteria) → {number}

Finds the product of values in a given field from the records (rows) in a database that match a search criteria.

Parameters:

Name	Type	Description
`database`	Array	The database
`field`	string	The field
`criteria`	Array	The criteria

Source: database.js, line 112
See: For further information, see docs.oasis-open.org

Returns:

Product of the field's values matching search criteriain field records matching search criteria from call to OpenFormula DPRODUCT function

Type:: number

(inner) dstDev(database, field, criteria) → {number}

Finds the sample standard deviation in a given field from the records (rows) in a database that match a search criteria.

Parameters:

Name	Type	Description
`database`	Array	The database
`field`	string	The field
`criteria`	Array	The criteria

Source: database.js, line 125
See: For further information, see docs.oasis-open.org

Returns:

Sample standard deviation of the field's values matching search criteria from call to OpenFormula DSTDEV function

Type:: number

(inner) dstDevP(database, field, criteria) → {number}

Finds the population standard deviation in a given field from the records (rows) in a database that match a search criteria.

Parameters:

Name	Type	Description
`database`	Array	The database
`field`	string	The field
`criteria`	Array	The criteria

Source: database.js, line 138
See: For further information, see docs.oasis-open.org

Returns:

Population standard deviation of the field's values matching search criteria from call to OpenFormula DSTDEVP function

Type:: number

(inner) dSum(database, field, criteria) → {number}

Finds the sum of values in a given field from the records (rows) in a database that match a search criteria.

Parameters:

Name	Type	Description
`database`	Array	The database
`field`	string	The field
`criteria`	Array	The criteria

Source: database.js, line 151
See: For further information, see docs.oasis-open.org

Returns:

Sum of the field's values matching search criteria from call to OpenFormula DSUM function

Type:: number

(inner) dVar(catabase, field, criteria) → {number}

Finds the sample variance in a given field from the records (rows) in a database that match a search criteria.

Parameters:

Name	Type	Description
`catabase`	Array	The database
`field`	string	The field
`criteria`	Array	The criteria

Source: database.js, line 164
See: For further information, see docs.oasis-open.org

Returns:

Sample variance of the field's values matching search criteria from call to OpenFormula DVAR function

Type:: number

(inner) dVarP(database, field, criteria) → {number}

Finds the population variance in a given field from the records (rows) in a database that match a search criteria.

Parameters:

Name	Type	Description
`database`	Array	The database
`field`	string	The field
`criteria`	Array	The criteria

Source: database.js, line 177
See: For further information, see docs.oasis-open.org

Returns:

Population variance of the field's values matching search criteria from call to OpenFormula DVARP function

Type:: number

(inner) getDocField(documentUNID, fieldName) → {*}

Given the unique ID of a document, returns the contents of a specific field on that document. The document must reside in the current database.

Parameters:

Name	Type	Description
`documentUNID`	string
`fieldName`	string

Source: database.js, line 216
See: For further information, see www.hcltechsw.com

Returns:

fieldValue

Type:: *

(inner) getProfileField(any)

Retrieves a field from a profile document, and caches the field value for the remainder of the session.

Parameters:

Name	Type	Description
`any`	Array	arguments

Source: database.js, line 298

Throws:

No plans to implement
Type Error

(inner) isDB2() → {boolean}

Given a server and filename or server and replica ID, indicates if the specified database is backed by DB2® or not.

Source: database.js, line 308

Throws:

No plans to implement
Type Error

Returns:

Type:: boolean

(inner) isExpandable() → {string}

In column formulas, returns a specified string if a row in a view can be expanded.

Source: database.js, line 318

Throws:

No plans to implement
Type Error

Returns:

Type:: string

(inner) publishDatabase()

Displays the Publish Database dialog box, where the user selects a library in which to publish the selected database.

Source: database.js, line 408

Throws:

no plans to implement
Type Error

(inner) renameDatabase()

For a particular database on the user's workspace, RenameDatabase locates a replica of that database (based on its replica ID) on the specified server, and replaces the database icon with that of the replica. The only change the user sees is that the server name has changed on the database icon.

Source: database.js, line 419

Throws:

no plans to implement
Type Error

(inner) replicaID() → {string}

Returns the replica ID of the current database.

Source: database.js, line 327

Throws:

No plans to implement
Type Error

Returns:

Type:: string

(inner) serverName() → {string}

Returns the name of the server containing the current database. When the database is local, returns the user name.

Source: database.js, line 337

Throws:

No plans to implement
Type Error

Returns:

Type:: string

(inner) setDocField(documentUNID, fieldName, fieldValue)

Given the unique ID of a document, sets the value of a specific field on that document. The document must reside in the current database.

Parameters:

Name	Type	Description
`documentUNID`	string	The unique ID of a document.
`fieldName`	string	The name of a field in the current document.
`fieldValue`	*	The value to set the field.

Source: database.js, line 227
See: For further information, see www.hcltechsw.com

(inner) setProfileField() → {*}

Sets the value of a field in a profile document or creates a profile document.

Source: database.js, line 346

Throws:

No plans to implement
Type Error

Returns:

Type:: *

(inner) switchView()

Switches to the specified view or folder within the current database or, if a view or folder is not specified, displays the View menu so the user can select a view.

Source: database.js, line 429

Throws:

no plans to implement
Type Error

(inner) viewTitle() → {string|Array.<string>}

Returns the current view's name. If there are aliases and synonyms, they are returned in a text list.

Source: database.js, line 356

Throws:

No plans to implement
Type Error

Returns:

Type:: string | Array.<string>

(inner) webDbName() → {string}

Returns the name of the current database encoded for URL inclusion.

Source: database.js, line 365

Throws:

No plans to implement
Type Error

Returns:

Type:: string