topic Re: Delete vs deactivate layer definition query in Python Questions

Delete vs deactivate layer definition query

JeffThomasILM — Fri, 10 Dec 2021 20:07:37 GMT

I'm trying to automate clearing an existing layer definition query and setting a new one. The code I wrote does successfully set the new def query, but it deactivates the old query rather than actually deleting it. The Layer class code sample 2 shows how it presumably would be done, but it doesn't actually delete it. ArcGIS Pro - Modifying Layer Definition query via ArcPY also essentially asks the same question, but it was never fully answered.

for map in aprx.listMaps():
    lyr = map.listLayers("Zoning History")[0]
    lyr.definitionQuery = None  ## have also tried ""
    lyr.definitionQuery = "CaseNumber = '" + case + "'"‍‍‍‍‍‍‍‍‍‍‍‍

I've tried setting it as None and "" - both result in deactivating rather than deleting the old query. It's not a showstopper, but it's kind of weird. If I change the def query again, it will overwrite the old-new query, but the old-old query (which was not set using ArcPy, if it matters) still remains present but inactive.

I started thinking about other scenarios, such as what if I wanted to deactivate rather than delete a query? I haven't found any documentation for how to do that properly (rather than unintentionally) with ArcPy.

Re: Delete vs deactivate layer definition query

JeffThomasILM — Fri, 17 Apr 2020 20:41:48 GMT

Update: there's clearly something buggy with the original query on my map layers. After I manually deleted all the queries through the UI, ArcPy worked correctly when I added a new query, then changed the query to a new query, leaving no previous query as inactive. The new question is whether it's just me or if it's a bug that any layer with an existing query set through the UI has the same issue when attempting update with ArcPy. And my other question: what if I wanted to deactivate the def query with ArcPy?

Re: Delete vs deactivate layer definition query

JoshuaBixby — Fri, 17 Apr 2020 22:51:06 GMT

See ArcGIS Pro - Modifying Layer Definition query via ArcPY , you will need to work with the Python CIM access—ArcPy | Documentation .

Re: Delete vs deactivate layer definition query

LindsayRaabe_FPCWA — Thu, 11 Mar 2021 02:59:55 GMT

I've just tested the below line in our python script that looks at a set map (Data Editing) in the Current project, and had the last 2 lines repeated for all the different layer names that I wanted it to update. Successfully deleted the definition query from each layer.

aprx = arcpy.mp.ArcGISProject("CURRENT") m = aprx.listMaps("Data Editing")[0] for lyr in m.listLayers("Layer 1"): ###Repeat these 2 lines for each layer lyr.definitionQuery = None for lyr in m.listLayers("Layer 2"): lyr.definitionQuery = None

I plan to write a simple script that can be used on any project and map which will just go through all layers in the current map and wipe and definition queries.

Re: Delete vs deactivate layer definition query

adamwade1 — Thu, 23 Jun 2022 00:19:17 GMT

Did this issue ever get resolved? I tried using the listDefinitionQueries, setting the 'isActive' field to False and then using then using the updateDefinitionQueries function. But that just does the same thing as lyr.definitionQuery = None. So if you are iterating through multiple definition queries there is no way to automate their removal.

Re: Delete vs deactivate layer definition query

CatherineHall678 — Fri, 06 Jan 2023 04:13:43 GMT

Hi, I tried this method but did not clear the definition query for me...

Re: Delete vs deactivate layer definition query

RogerDunnGIS — Thu, 02 Feb 2023 16:37:39 GMT

In my Python scripts, I use the following function to overwrite existing definition queries with new ones:

def setDefinitionQuery(layer, sqlFilter): layer.updateDefinitionQueries( [ {'name': 'Query 1', 'sql': sqlFilter, 'isActive': True} ] )

Re: Delete vs deactivate layer definition query

SH_DH — Thu, 16 Feb 2023 21:25:45 GMT

this works! thank you

Re: Delete vs deactivate layer definition query

BobCapezza — Wed, 26 Jul 2023 17:59:29 GMT

Worked like a charm. Thanks !

Re: Delete vs deactivate layer definition query

Shauna-RaeBrown — Mon, 31 Jul 2023 16:34:06 GMT

@RogerDunnGIS, Thanks for providing this function. I'm really new to python, so please correct me if I'm wrong. If I understand your function correctly, I need to provide two variables to the function: "layer", and "sqlFilter" that the function uses? How do I call/use your function? Thanks so much for your help.

Re: Delete vs deactivate layer definition query

RogerDunnGIS — Mon, 31 Jul 2023 17:02:14 GMT

So, the layer has to be a Layer object, and typically these are obtained by getting a reference to layer within a map within a project. The sqlFilter object is a string and must contain an SQL statement that functions on the layer, given its workspace type. So, here's an example of how that might be used where the layer is in an enterprise geodatabase and quotes around field names are unnecessary. The fields CHILLS, CONTROL, and SUPPLIED_POWER are numeric fields and it is hoped that they are non-null.

proj = arcpy.mp.ArcGISProject("CURRENT") # or "C:\Grease.aprx", etc. my_map = proj.activeMap # or proj.listMaps("Map"). Do not create a variable named map because map is a certain function in Python my_layer = my_map.ListLayers("TheOneThatIWant") my_filter = "CHILLS * CHILLS - CONTROL = SUPPLIED_POWER" # Do not create a variable called filter because filter is a certain function in Python setDefinitionQuery(my_layer, my_filter)

Once this code executes, the layer named TheOneThatIWant inside the active map (or the map named "Map") inside the currently-open project (or the project at C:\Grease.aprx) will now only show features in the map and in the attribute table where a given feature's CHILLS value squared minus its CONTROL value are equal to its SUPPLIED_POWER field.

This is perfect for when you've got chills, they're multiplyin', and you're losing control, because the power you're supplying, is electrifying. Your map will really shape up after this. Let me know if you have any more questions.

Re: Delete vs deactivate layer definition query

Shauna-RaeBrown — Mon, 31 Jul 2023 20:50:45 GMT

I finally figured out how to REMOVE/DELETE the definition query from a specific layer in a specific map. Ultimately, I used the Cartographic Information Model (cim) to access the definitionExpression.

I read through the Python CIM access web page. https://pro.arcgis.com/en/pro-app/2.9/arcpy/mapping/python-cim-access.htm

In my aprx file, I right-clicked the map's name and selected "Save As Map File" the map(s), and them opened the *.mapx file as a *.json file. Next, I searched through the file for the "definitionExpression" field. After trying a bunch of things, I finally found that I want to change the layers "featureTable.definitionExpression" to equal "".

Here's my code.

import arcpy # Reference a project, map, and layer using arcpy.mp aprx = arcpy.mp.ArcGISProject('current') m = aprx.listMaps("Inset")[0] lyr = m.listLayers("AZ811 BlueStake")[0] # Return the layer's CIM definition cim_lyr = lyr.getDefinition('V2') # Modify the featureTable.definitionExpression cim_lyr.featureTable.definitionExpression = "" # Push the changes back to the layer object lyr.setDefinition(cim_lyr)

Re: Delete vs deactivate layer definition query

RogerDunnGIS — Mon, 31 Jul 2023 23:00:47 GMT

Oh, I didn't know you wanted to remove the definition query; I thought you wanted to do what the OP was asking: set a new definition query and forget the old ones. To remove definition queries on a layer, you set the layer's definitionQuery property to None. If you're new to Python, I would advise staying away from the Cartographic Information Model. Even with years of Python experience under my belt, and even more in other languages, I stay away from it myself. It's very sensitive to prodding and changes.

Re: Delete vs deactivate layer definition query

Shauna-RaeBrown — Mon, 31 Jul 2023 23:11:59 GMT

I tried to set the definitionQuery property to "" and None. All that happened was the layer's definition query was made inactive and the new definition query was created and made active. Thanks for your advice. I will just have to accept that I will have to delete the old definition query from within the aprx.

Re: Delete vs deactivate layer definition query

Shauna-RaeBrown — Wed, 16 Aug 2023 19:00:29 GMT

@adamwade1 , the only solution that I found to work was to use the function provided by @RogerDunnGIS‎ on 02-02-2023 08:37 AM (see above in this thread).

Re: Delete vs deactivate layer definition query

Joseph_Kinyon — Sat, 23 Sep 2023 00:22:48 GMT

This is great stuff, thanks for sharing.
Another thanks to Roger Dunn and Joshua Bixby
While it isn't the prettiest or even complete, I shoe horned it into a script tool in model builder to make use of the Iterate Multivalue tool in ArcGIS 3
The script is called Definition Query Update in the model image.
I thought I'd add back how it worked for my needs.

""" Script documentation - Tool parameters are accessed using arcpy.GetParameter() or arcpy.GetParameterAsText() - Update derived parameter values using arcpy.SetParameter() or arcpy.SetParameterAsText() """ import arcpy def script_tool(param0, param1, param3): """Script code goes below""" return #get the input paramaters passed from the model output and variables param0 = arcpy.GetParameterAsText(0) param1 = arcpy.GetParameterAsText(1) param3 = arcpy.GetParameterAsText(3) aprx = arcpy.mp.ArcGISProject('current') m = aprx.listMaps()[0] l = m.listLayers()[0] #limit changes to the list of layers selected, in this version layers cannot be in a layer group to work for l in m.listLayers(param0): if l.supports('DefinitionQuery'): #Get the list of definition queries dql = l.listDefinitionQueries() #Clear active definition queries otherwise the update will fail if there is already an active query for dq in dql: dq['isActive'] = False #Create a new definition query and append it to the list dql.append({'name': param3, 'sql' : param1, 'isActive': True}) #Update the definition queries with the newly modified list l.updateDefinitionQueries(dql) arcpy.SetParameterAsText(2, param1) arcpy.AddMessage(param0) arcpy.AddMessage(param1) arcpy.AddMessage(param3) #consider inserting a file picker variable that allows you to select an existing definition query .exp file for the sql input

Re: Delete vs deactivate layer definition query

edward33 — Tue, 20 Feb 2024 14:31:49 GMT

I am not super familiar with functions so I ended up going this route based on @RogerDunnGIS tip above

#Set definition query for Main Map map_obj = aprx.listMaps(map_name)[0] layer_obj = map_obj.listLayers(layer_name)[0] definition_query = f"{field_name} = '{query_value}'" layer_obj.updateDefinitionQueries([ {'name': 'Query 1', 'sql': definition_query, 'isActive': True} ])

Re: Delete vs deactivate layer definition query

Bastien — Wed, 22 May 2024 09:21:33 GMT

In order to delete (not deactivate) a definition query:

import arcpy # Choose your layer layer = r"MyLayer" # Choose your project project = arcpy.mp.ArcGISProject("CURRENT") # Choose your map m = project.listMaps()[0] # Remove definition queries for lyr in m.listLayers(layer): lyr.updateDefinitionQueries([])

As we can see above that updateDefinitionQueries() take a list as parameter, so an empty list will result in an empty definition query. We could also set multiple definition queries if needed:

lyr.updateDefinitionQueries([ {'name': 'Query 1', 'sql': "myfield1 = 'stuff1', 'isActive': True}, {'name': 'Query 2', 'sql': "myfield2 = 'stuff2', 'isActive': True} ])

Re: Delete vs deactivate layer definition query

MK13 — Fri, 02 Aug 2024 19:08:37 GMT

Works perfectly! Thanks!

Re: Delete vs deactivate layer definition query

Miralem_Zeljo — Wed, 11 Dec 2024 19:39:23 GMT

Here is the code that should do what you want:

import arcpy

# Access the active project
aprx = arcpy.mp.ArcGISProject("CURRENT")

# Access the active map
map_obj = aprx.activeMap

# Check if there is an active map
if map_obj is None:
print("No active map found.")
else:
# Access layers in the active map
layers = map_obj.listLayers()

# Loop through all layers and remove their definition queries
for layer in layers:
if layer.supports("DEFINITIONQUERY"):
try:
# Update the definition query with an empty list to remove it
layer.updateDefinitionQueries([]) # Attempt to clear the query
print(f"Definition query for '{layer.name}' removed.")
except Exception as e:
print(f"Failed to update definition query for '{layer.name}': {e}")

# Save the project
aprx.save()

# Clean up
del aprx