Versions Compared

Old Version 38

changes.mady.by.user Jessica Tomkins

Saved on

compared with

New Version Current

changes.mady.by.user David Russo

Saved on

Key

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


...



titleContent Freeze

As of July 25th, 2023, there is a content freeze on this page.

Section


Column
width60%

API Overview

The pjs.query() API is a shortcut for executing an SQL statement and automatically fetching the results. The results are returned by default as a primitive JavaScript array or object. However, if the 4th parameter is specified, the results are instead returned into a set of strongly defined fields, a strongly defined array, or a strongly defined data structure.

This API first prepares the SQL statement, binds parameters (if any), executes the statement, and then fetches the records.

This API also has the capability to INSERT or UPDATE records using a primitive JavaScript object that represent fields and their corresponding values.

Note
If the SQL statement is an INSERT or an UPDATE, parameter 3 and parameter 4 are not applicable.



Column
width40%

Contents

Info
iconfalse
Table of Contents
maxLevel6
minLevel2
indent15px
stylenone
separatorbraces


HTML Comment
hiddentrue

This column is for a table of contents or notice. If neither are needed, delete this column. If only one is needed, delete the other. If more are needed, you can add what you like, remember to check how long it becomes by clicking "Preview" in the bottom right corner. While preview, the page should be checked at half page and maximize to check that the formatting is not distorted. You may need to make some adjustments to compensate.



...

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. Database Connection (optional/omittable)
    Pass an object returned by pjs.getDB() to use an alternate database connection. If not passed, the default connection will be used.
  2. Query Options (optional/omittable)
    Pass an object containing statement attributes to set before executing the query.
  3. SQL statement string
    The SQL statement must be valid for the database you are using
  4. parameter or array of parameters to bind (optional)
  5. 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.
  6. 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.
  7. number of rows per INSERT SQL request on a multi-insert action (optional; if not specified, the default is 100; available in Profound.s version 5.2.0). This parameter is applicable only for an INSERT statement.

...

  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.


Info
titleLimitations

16MB of data is the limit for the whole result from a pjs.query() request with the IBM i Connector. (The limit is not 16MB per column).


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);

...