SQLFirst (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Loading the query in memory
Partial Fetch
Various

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

SQLFirst (Function)

In french: SQLPremier

Positions on the first row of the query result. This row becomes the current row.

If controls or variables are associated with the columns of query result (SQLAssociate), the values found in the current row are automatically assigned to these elements.

In most cases, SQLFirst is used in a read loop with SQLNext.

Caution: This function must be used during a SQLFirst/SQLCol browse of query result. See Types of SQL browse for more details.

The partial fetch is automatically performed by the Java framework.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Example

See additional examples

// Initialize the scrollbar parameters at the end of query
ResSQL = SQLExec("SELECT CUSTLASTNAME, FIRSTNAME, ADDR1, ADDR2, CITY, ZIP FROM CUSTOMER", ...
"QRY1")
IF ResSQL = True THEN
// Displays the first row
SQLFirst("QRY1")
// Initializes the upper bound of the scrollbar
SCROLL_SCROLL1..MaxValue = SQL.NbLine
// Positions the scrollbar at the beginning
SCROLL_SCROLL1 = 1
ELSE
// Processes the error
END
SQLClose("QRY1")

Syntax

SQLFirst([<Number of rows>, ] <Query name>)

<Number of rows>: Optional integer

Number of rows that will be loaded in memory every second. This number of rows will constitute a block for the partial Fetch.
Parameter required to perform a read by partial Fetch.
This parameter is ignored. Indeed, the partial Fetch is automatically performed by the Java framework.

<Query name>: Character string (with or without quotes)

Query name:
created and run by SQLExec (with quotes),
run by SQLExecWDR (with or without quotes).
The queries created in the query editor must be specified in the format of a character string with quotes.

Remarks

Loading the query in memory

If SQLFirst is immediately called after SQLExec, the query result is loaded in memory. Two methods are available:

Entirely load the query in memory if <Number of Lines> is not specified. The number of records corresponding to the query result is automatically calculated. The SQL.NbLine variable is updated.
Partially load the query in memory (also called partial fetch) if <Number of rows> is specified.
Only the first block of rows is loaded in memory. The following blocks are automatically loaded in background task (mechanism of partial fetch). The SQL.Retrieving variable (updated by SQLInfo) is used to find out whether the result was entirely retrieved.
Remark: Depending on the process performed, the partial fetch is used to reduce the network bandwidth.

The partial fetch is automatically performed by the Java framework. The SQL.Retrieving variable is never initialized and it always returns False.

Partial Fetch

If you are using the Partial Fetch to retrieve the query result (see the example for this function):

If SQLClose is called while the retrieval is not completed, the retrieval is stopped and the query is closed.
This method can be used with several queries at the same time.
The SQL.Retrieving variable (updated by SQLInfo) is used to find out whether the result was entirely retrieved.

Various

If the pointer is positioned outside the query result, the SQL.Out variable is set to True.
The SQL.Current variable contains the number of the current line.
SQLTable must not be used after SQLFirst. A fatal error is generated.

Component: wd260hf.dll