Addtional scope post is outdated, please replace with newer

[peter.b]

How to use additional scope (additionalScope) in your queries

Why use additionalScope When writing queries you'd like to reuse with different input value(s), Retool's additionalScope might be helpful! See our docs here and some more in depth examples below. How to use additionalScope The additionalScope option allows you to pass variables to the query that aren't already defined in the global scope (e.g. text1.value). In order to use additionalScope, you must first trigger a query in an event handler or using the .trigger() method in a JS query. [imag…

The post refers to additional scope in the event handler, but that is no longer avialable (screenshot provided)

• also guys please mention which version of Retool, saying 'a later version' isnt really helpful.

Thanks

[MiguelOrtiz]

@How to use additional scope (additionalScope) in your queries

12/23/24: A recent update to the Retool UI allows you to specify the subset of variables in the query definition that will be provided via additionalScope upon query execution.

Hey @peter.b, i just double checked and it is working for me. Did you add it to the UI for "Additional scope" in the query?

[peter.b]

We dont use the additional scope directly in the resource query. we prefer to create a JS query and use :
getResourceQuery.trigger({ additionalScope: { sectionId: 1 } })
to pass the additionalScope into the query. Mainly because often we. cascade these queries using onSuccess

Pete

[MiguelOrtiz]

Hey @peter.b,

Yeah, definitely a preferred approach.

I thought you were asking about the additional scope options being visible in the event handler. But if that's not the case, could you rephrase what is it you're looking for?

[Darren]

@peter.b

please mention which version of Retool, saying 'a later version' isnt really helpful

That's extremely valid feedback! I've updated the topic in question to specify the exact version.

@MiguelOrtiz

Did you add it to the UI for "Additional scope" in the query?

I've also updated the topic to hopefully make it more clear that the option to specify "Additional Scope" when triggering a query via an event handler is only present when the query itself is configured with "Additional scope" variables.

Let me know if you have any additional comments or questions!