Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Warning
titleImportant!

When using an IBM i database, this API requires the Profound.js Connector module.

Section
Column
width25%

Parameters

Info

This API can accept an optional database connection definition object to select between multiple database connections. To select the database connection, call pjs.getDB() and pass the result as the first parameter, followed by the parameters documented below. If a database connection definition object is not passed, the default database connection is used.


  1. SQL statement string
    1. The SQL statement must be valid for the database you are using
  2. parameter or array of parameters to bind (optional)
  3. number of records to fetch (optional)
    (warning) This parameter only works with the IBM i DB2 database driver.
    (info) If omitted, SQL_FETCH_ALL is assumed.
  4. one or more Profound.js strongly typed field names (optional)
    (warning) This parameter only works with the IBM i DB2 database driver.
    (info) If field names are passed, they will be bound to columns in the resulting rows and populated by this API if the fetch is successful.

...

Return Value

  1. If parameter 4 is specified, the API does not return a value.
  2. If 1 record is requested, the API returns a JavaScript object that represents the fetched record or null if no record was found.
  3. If more than 1 record is requested, the API returns an array of JavaScript objects, where each Object represents a record. If no records were fetched, an empty array is returned.

Examples

Load a Grid
Code Block
languagejavascript
titleLoad a grid where screen fields match database fields
pjs.defineDisplay("display", "mydisplay.json");
var records = pjs.query("SELECT * FROM ORDERS");
display.grid1.replaceRecords(records);

...