Returns the row read size for a remote cursor.

Syntax

---

edb_getreadsize(<CursorHandle>)

<CursorHandle> =

Handle of cursor returned by edb_execute function

Returns

---

Row read size (INTEGER) for the cursor if successful, or
FALSE if there are any errors

Usage

---

The edb_getreadsize function returns the row read size for a cursor whose parent connection is a remote connection to an ElevateDB Server. The row read size determines how many rows are read in one chunk whenever ElevateDB needs to read more rows from an ElevateDB Server. Using a larger read size can result in better performance when navigating a large number of rows using a cursor. The default row read size for any cursor is 1.

Examples

---

<?php

// The following script connects to an ElevateDB
// Server and database, prepares and executes a
// direct table open, sets the row read size using
// the edb_setreadsize() function, goes to the start
// of the cursor, and navigates to the end of the cursor
// by using the edb_eof() function to test when to
// stop navigating

$con = edb_connect("type=remote;charset=Ansi;address=127.0.0.1;"+
                   "uid=Administrator;pwd=EDBDefault;database=Test");
if (!$con)
  {
  die("Could not connect: " . edb_errmsg());
  }

$cmd = edb_prepare($con,"customer",EDB_COMMAND_TABLE);
$cursor = edb_execute($cmd);

edb_setreadsize($cursor,50);

edb_first($cursor);

while (!edb_eof($cursor)):
   edb_next($cursor);
endwhile;

echo edb_state($cursor);

edb_disconnect($con);
?>