Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


New_in
Version7.9.4

 


Scripting_function



Panel
titleDescription

Runs a named query and returns the results. Note that the number of parameters in the function is determined by scope. Both versions of the function are listed below.


Panel
titleClient Permission Restrictions

This scripting function has no Client Permission restrictions.


Panel
titleProject Scope Syntax

system.db. runNamedQuery(path, parameters )

  • Parameters

String  path  -  The path to the named query to run. Note that this is the full path to the query, including any folders.

PyDictionary  parameters  -  A Python dictionary of parameters for the named query to use.

  • Returns

Object The results of the query. The exact object returned depends on the Query Type property of the Named Query: typically either a dataset when set to Query, an integer representing the number of rows affected when set to Update Query, or an object matching the datatype of the value returned by a Scalar Query.

  • Scope

All


Panel
titleGateway Scope Syntax

system.db. runNamedQuery(project, path, parameters )

  • Parameters

String  project The project name the query exists in.

String  path  -  The path to the named query to run. Note that this is the full path to the query, including any folders.

PyDictionary  parameters  -  A Python dictionary of parameters for the named query to use.

  • Returns

Object The results of the query. The exact object returned depends on the Query Type property of the Named Query: typically either a dataset when set to Query, an integer representing the number of rows affected when set to Update Query, or an object matching the datatype of the value returned by a Scalar Query.

  • Scope

All



Panel
titleCode Examples


Code Block
languagepy
titleSimple Example - Without Parameters
#This# This example will run a Named Query without any parameters in the Project scope.
#The# The second argument in the function is NOT optional, so named queries that do not require a parameter must still pass an empty dictionary as an argument.

#Request# Request the Named Query with an empty dictionary as the second parameter. 
system.db.runNamedQuery("folderName/myNamedQuery", {})


Code Block
languagepy
titleGateway Scope Example
#This# This example will run a Named Query without any parameters in the Gateway scope.
#The# The last argument in the function is NOT optional, so named queries that do not require a parameter must still pass an empty dictionary as an argument.

#Request# Request the Named Query to execute. 
system.db.runNamedQuery("ProjectName", "folderName/myNamedQuery", {})


Code Block
languagepy
titleSimple Example - With Parameters
#This# This example will run a Named Query while passing some parameters in the Project scope.
#The# The Named Query is assumed to have two parameters already defined on the Named Query:
#param1# param1 : A string
#param2# param2 : An integer

#Create# Create a python dictionary of parameters to pass
params = {"param1":"my string", "param2":10}
 
#Run# Run the Named Query
system.db.runNamedQuery("myUpdateQuery", params)