The number of rows to scan when dynamically determining columns for the table.

Data Type

string

Default Value

"1000"

Remarks

This property applies only to the SuiteQL schema. SuiteQL has no metadata service available outside of custom records and custom fields. Standard tables and fields must be hardcoded in some fashion. However, this comes with a downside in that NetSuite will throw exceptions when columns and tables that are not available based on your user permissions or NetSuite company settings are attempted to be selected.

In order to try and ensure at least that the columns displayed are available to you in your connection, a RowScan can be performed during column listing. This will ensure that any columns that are displayed for a given table are actually available based on your user credentials. Note that NetSuite does not return columns that are null. Therefore, this method may result in tables that do not have complete column information. Please be aware that SuiteQL has a maximum pagesize of 1000. Setting this value higher than 1000 will result in multiple page requests. Setting RowScanDepth to 0 will result in no rows being scanned (all available columns will be listed regardless). RowScanDepth may not be set higher than 100000.