Company Events Academic NI Developer Zone Support Solutions Products & Services Contact NI MyNI

DB Tools Execute Query VI

Owning Palette: Advanced VIs

Installed With: Database Connectivity Toolkit

Executes an SQL query and returns a recordset reference that you must eventually free with the DB Tools Free Object VI. Wire data to the reference input to determine the polymorphic instance to use or manually select the instance.

Use the pull-down menu to select an instance of this VI.

Connection

cache size specifies the number of records to store in local memory. After you retrieve the number of records in local memory and you request the next record, the current set of records is discarded from local memory and the next set are retrieved into local memory. The default is 1. Adjusting this setting might improve performance when fetching records. However, if the cursor type input is set to forward-only, you must use the default cache size of 1. If you select a different cursor type, you can set cache size to any value greater than 0.
connection reference specifies a reference to an ADO Connection object.
SQL query specifies the SQL statement to execute.
cursor type specifies the method for navigating the recordset. Some providers and/or databases do not support all cursors.
dynamicAllows forward and backward navigation. You are able to see all changes other users make to the database.
forward-onlyPermits only forward movement through the recordset. Any changes other users make to the database during navigation are not visible. This method provides the highest performance.
keysetAllows forward and backward navigation. You are able to see records that other users add, but records deleted by other users are not removed from view.
staticAllows forward and backward navigation with no ability to see any changes that other users make during navigation.
error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use exception control to treat what is normally an error as no error or to treat a warning as an error. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
recordset reference is a reference to an ADO Recordset object.
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Command

cache size specifies the number of records to store in local memory. After you retrieve the number of records in local memory and you request the next record, the current set of records is discarded from local memory and the next set are retrieved into local memory. The default is 1. Adjusting this setting might improve performance when fetching records. However, if the cursor type input is set to forward-only, you must use the default cache size of 1. If you select a different cursor type, you can set cache size to any value greater than 0.
command reference specifies a reference to an ADO Command object.
cursor type specifies the method for navigating the recordset. Some providers and/or databases do not support all cursors.
dynamicAllows forward and backward navigation. You are able to see all changes other users make to the database.
forward-onlyPermits only forward movement through the recordset. Any changes other users make to the database during navigation are not visible. This method provides the highest performance.
keysetAllows forward and backward navigation. You are able to see records that other users add, but records deleted by other users are not removed from view.
staticAllows forward and backward navigation with no ability to see any changes that other users make during navigation.
error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use exception control to treat what is normally an error as no error or to treat a warning as an error. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
command-recordset reference is a reference that combines an ADO Command object and an ADO Recordset object.
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Resources


 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit