Class Reference
IRIS for UNIX 2024.1.2
|
Class Reference
IRIS for UNIX 2024.1.2
|
|
|
Private
Storage
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
A version of the JSON provider that can use an SQL statement to supply data that is served
to the client in JSON format. This can be used in the same manner as the
For example, placing this within your page definition:
<altJSONSQLProvider id="json" sql="SELECT TOP 2 ID, Name FROM Sample.Person" />
o.content = {
"children": [
{
"ID": 1,
"Name": "Schaefer,Thelma W."
}
{
"ID": 2,
"Name": "Huff,Kevin T."
}
]
};
|
|
|
|
|
|
This specifies a callback method that returns an SQL query (string) that will drive this provider. This is identical in behavior to (and replaces) thesql property. The method can make it easier to create queries based on parameter values or search criteria passed via thecriteria property.
If the provider is using server-side data paging, this is the number (1-based) of the current page.
If the provider is using server-side data paging, this is the number of records in each page.
If the provider is using server-side data paging, this is the total number of records.
|
|
Utility method to allow direct use of JSON from a non-ZEN context (such as a CSP page).
The JSON notation is written out the current device. pVar is the optional name of the client-side javascript variable that refers to the JSON notation.
pSQL is the SQL statement that is executed and provides the JSON content.
From a CSP page, you could invoke the method as follows:
pFormat is provided for signature compatibility with the legacy jsonProvider class, but using it to pretty-print the output stream is not supported by this class.#(##class(%ZEN.Auxiliary.jsonSQLProvider).%WriteJSONFromSQL("json","SELECT Name FROM Sample.Person"))#
pMaxRows controls the maximum number of rows to return and follows the semantics for themaxRows property where 0 indicates all rows should be returned. tProvider If you wish to use a class query or pass in parameters using ? then create and populate an instance of the jsonSQLProvider and pass it in.
Utility method to allow JSON output generated by the SQL query defined in pSQL to be written to the stream supplied in pStream from a general non-ZEN context. Note that pStream will be created if not supplied, hence the ByRef designation.
pRewindStream controls whether the stream should be rewound after the data is written to it.
pFormat is provided for signature compatibility with the legacy jsonProvider class, but using it to pretty-print the output stream is not supported by this class.
pMaxRows controls the maximum number of rows to return and follows the semantics for themaxRows property where 0 indicates all rows should be returned. tProvider If you wish to use a class query or pass in parameters using ? then create and populate an instance of the jsonSQLProvider and pass it in.
If this provider is using server-side paging, this is the current page number (1-based).
If this provider is using server-side paging, this is the number of records in one page.
If this provider is using server-side paging, this is the total number of records in the current query.
If this provider is using server-side paging, set the current page number (1-based).