pjs.defineTable()

read

Boolean

Set to True to allow records to be retrieved

update

Boolean

Set to True to allow records to be updated

delete

Boolean

Set to True to allow records to be deleted

write

Boolean

Set to True to allow records to be inserted

keyed

Boolean

Set to True to enable keyed record access. Otherwise records will be accessed by relative record number

userOpen

Boolean

Set to True to enable user-controlled file open / close using the file.open() and file.close() methods. Otherwise the file will be opened automatically before this method returns and closed automatically when the calling function ends.

infDS

String

Name of a File Information data structure which will be populated with feedback information after each file method call. The data structure must be defined in the calling scope using pjs.define().

ds

String

The default data structure used for database operations. The data structure is automatically created by the pjs.defineTable() API in the current calling scope. It should not be defined explicitly in the program.

qualified

Boolean

Set to True to qualify field names with the internal file and record format names

include

Array

A list of record formats to define in the calling scope. If omitted, all record format names are included.

ignore

Array

A list of record formats to ignore. If omitted, all record format names are included.

rename

Object

A list of record formats to rename. The record format name given by each object property is set to the name given in the corresponding value.

recno

String

The name of a field that receives the relative record number after a successful input operation. The field must be defined in the calling scope using pjs.define().

likeFile

String

The internal name of another file defined using this method in the calling scope. This defines another instance of the file using the same configuration options.

levelIds

Array

A list of level identifiers for each record format in the file. If specified, record format level checks are performed before opening the file. Otherwise, no level checks are done.

userDefinedData

Any

Specifies user-defined general purpose data associated with the table configuration.

prefix

Object / String

Defines a prefix that will be used to partially rename all the fields of the Rich Display File. This property can be defined in 2 different ways.

1. As an object of the following format:
   
   

   ^{{
   "numberOfCharsToReplace": nn, //numeric value indicating the number of characters, if any, in the existing field names to replace with the prefix
   "prefix": "xxxx" //string prefix value. If numberOfCharsToReplace is not defined or is 0, then the prefix is appended to the beginning of the field names
   }}
   

2. ^{As a string value that will be appended to the beginning of the field names.}

driver

String

Optionally specifies the database driver to use for this table. Shipped drivers include "IBMi" and "jsonDB". If this configuration option is not specified, the driver from the default database connection is used.

template

Boolean

If set to True, the the declared file cannot be opened and used for I/O, but its record formats and fields can be used as templates for field definitions by using the options 'like', 'likeRec', and 'extName' with pjs.define().

static

Boolean

If set to True, the file will hold its state across calls to the function. If the file is open when the function, then the file will still be open on the next call to the function.

alias

Boolean

If set to True, the alias (alternate) names will be used, if present, for the fields associated with the file and also for subfield names in data structures defined with the 'likeRec' option.

likeFile

String

Set to the name of a previously defined table which will be used to derive the table definition.

renameFields

String

Object containing field names to rename within the Rich Display File; the field names are given as properties of this object and their new names as values of these properties.

For example:

^{{
"field1": "newField1",
"field2": "newField2"
}}

If a prefix is defined, the renameFields object properties must be defined with the prefix in place in order for those fields to be renamed.

For example, if the property prefix is defined as string "EX", then renameFields might look like this:

^{{
"EXfield1": "newField1",
"EXfield2": "newField2"
}}

commit

Boolean

Set to true to open the file under commitment control. A commitment control environment must be set up prior to opening the file, using the STRCMTCTL command.

customClass

JavaScript Class

Allows users to specify their own custom class to process database table method calls. This can be used for custom data processing, such as reading from and writing to CSV files.