Summary
Environment settings are exposed as properties on the env class. Geoprocessing environment settings can be thought of as additional parameters that affect a tool's results.
Discussion
Starting at ArcGIS Pro 2.9, setting an invalid environment name will fail with an AttributeError exception.
Properties
| Property | Explanation | Data Type |
| addOutputsToMap (Read and Write) | Specifies whether the output datasets will be added to the application display. This property is only applicable when used directly in the Python window or from a notebook in ArcGIS Pro. | Boolean |
| annotationTextStringFieldLength (Read and Write) | Tools that honor the Annotation Text String Field Length environment will override the default field length on the TextString field in any annotation feature classes created in a database. | Long |
| autoCancelling (Read and Write) | Specifies whether a cancellation will end the script on the current line. If True, it will. If False, a cancellation will set the isCancelled property to True and continue running. The default is True. Use in script tools or Python toolbox tools. | Boolean |
| autoCommit (Read and Write) | Tools that honor the Auto Commit environment will force a commit after the specified number of changes have been made within an enterprise geodatabase transaction. | Long |
| baDataSource (Read and Write) | Tools that honor the Data Source environment comply with how data is summarized from one layer to another. This environment is used by Business Analyst tools only. | String |
| baNetworkSource (Read and Write) | Tools that honor the Network Source environment allow you to set your network dataset or service used for network distance calculation tasks. This is used by Business Analyst tools only. | String |
| baUseDetailedAggregation (Read and Write) | Tools that honor the Use Detailed Aggregation environment will use a detailed data aggregation method for areas beyond a specified radius. This environment is used by Business Analyst tools only. | Boolean |
| buildStatsAndRATForTempRaster (Read and Write) | Specifies whether statistics will be calculated and raster attribute tables (RAT) will be built for temporary rasters created by Spatial Analyst tools. The environment is only used from the interactive Python window in the application. The default is True. When set to False, the statistics will be approximate for the purpose of symbolizing raster layers, and no RAT will be built. | Boolean |
| cartographicCoordinateSystem (Read and Write) | Tools that honor the Cartographic Coordinate System environment will use the specified coordinate system to determine the size, extent, and spatial relationships of features when making calculations. | String |
| cartographicPartitions (Read and Write) | Tools that honor the Cartographic Partitions environment will subdivide input features by the specified partition polygon features for sequential processing to avoid memory limitations that may otherwise be encountered with large datasets. | String |
| cellSize (Read and Write) | Tools that honor the Cell Size environment set the output raster cell size, or resolution, for the operation. The default output resolution is determined by the coarsest of the input raster datasets. | String |
| cellSizeProjectionMethod (Read and Write) | Tools that honor the Cell Size Projection Method environment will use the specified method for calculating the output raster cell size when datasets are projected during analysis. | String |
| coincidentPoints (Read and Write) | Tools that honor the Coincident Points environment define how coincident data is treated in Geostatistical Analyst. | String |
| compression (Read and Write) | Tools that honor the Compression environment will set the compression type when storing output raster datasets. | String |
| configKeyword (Read and Write) | Tools that honor the Output CONFIG Keyword environment will use the specified keyword when creating datasets in a geodatabase. | String |
| daylightSaving (Read and Write) | Tools that honor the Adjust for Daylight Saving environment adjust the values in the date field's time zone to account for daylight saving time. | Boolean |
| extent (Read and Write) | Tools that honor the Extent environment will only process features or rasters that are within the extent specified in this setting. | String |
| geographicTransformations (Read and Write) | Tools that honor the Geographic Transformations environment will use the transformation methods when projecting data. | String |
| gpuId (Read and Write) | Tools that honor the GPU ID environment identify the GPU to use to process your data. | Long |
| isCancelled (Read Only) | When autoCancelling is set to False and the tool has been cancelled, isCancelled will be set to True. isCancelled is False by default and is a read-only property. Use this property in script tools or Python toolbox tools. | Boolean |
| maintainAttachments (Read and Write) | Tools that honor the Maintain Attachments environment will copy attachments from the input features to the output features. An attachment table and a relationship class will be created. | Boolean |
| maintainCurveSegments (Read and Write) | Tools that honor the Maintain Curve Segments environment will maintain input curve segments in the output. | Boolean |
| maintainSpatialIndex (Read and Write) | Legacy:The Maintain Spatial Index environment is not honored in ArcGIS Pro. To have the same behavior as the Maintain Spatial Index environment in ArcGIS Pro when running tools and workflows that perform insert, update, and delete operations on existing data in enterprise geodatabases, control of the spatial index can be accomplished using the Remove Spatial Index tool to remove the spatial index prior to processing and the Add Spatial Index tool to re-create the spatial index after processing. The Append tool also supports this workflow with file geodatabase data. | Boolean |
| mask (Read and Write) | Tools that honor the Mask environment will only consider those cells that fall within the analysis mask in the operation. Learn more about Learn more about mask | String |
| matchMultidimensionalVariable (Read and Write) | Tools that honor the Match Multidimensional Variable environment will generate a multidimensional raster only if the input multidimensional rasters share at least one variable with the same name. | String |
| MDomain (Read and Write) | Tools that honor the Output M Domain environment will generate output datasets with the specified measure domain (m-domain). | String |
| MResolution (Read and Write) | Tools that honor the M Resolution environment will apply the m-resolution to output geodatasets. The m-resolution, expressed as a very small distance, refers to the number of significant digits used to store m-values. | Double |
| MTolerance (Read and Write) | Tools that honor the M Tolerance environment will override the default m-tolerance on geodatasets created in a geodatabase. | Double |
| nodata (Read and Write) | Tools that honor the NoData environment will only process rasters in which the NoData value is valid. | String |
| outputCoordinateSystem (Read and Write) | Tools that honor the Output Coordinate System environment will create output geodatasets with the specified coordinate system. | String |
| outputMFlag (Read and Write) | Tools that honor the Output has M Values environment will control whether the output geodataset will store m-values. | String |
| cellAlignment (Read and Write) | Tools that honor the Cell Alignment environment will adjust the cell alignment of the output to match the cell alignment of the specified processing extent. | String |
| outputZFlag (Read and Write) | Tools that honor the Output has Z Values environment will control whether the output geodataset will store z-values. | String |
| outputZValue (Read and Write) | Tools that honor the Default Output Z Value environment will set the z-coordinate for each output vertex that does not already have a z-coordinate. | String |
| overwriteOutput (Read and Write) | Specifies whether tools will automatically overwrite any existing output when run. When set to True, tools will run and overwrite the output dataset. When set to False, existing outputs will not be overwritten, and the tool will return an error. | Boolean |
| packageWorkspace (Read Only) | The Package Workspace environment setting is the location of a folder that locates the contents of a shared geoprocessing package or service. | String |
| parallelProcessingFactor (Read and Write) | Tools that honor the Parallel Processing Factor environment will divide and perform operations across multiple processes. | Integer |
| processingServer (Read and Write) | Tools that honor the Remote Processing Server set of environments specify the server, username, and password for ArcGIS Server when you use the Parallel Processing Factor environment. The ArcGIS server name or IP address that has the Raster Processing system service enabled. If the Processing Server is a server cluster, use the server name that is the site host. | String |
| processingServerPassword (Read and Write) | Tools that honor the Remote Processing Server set of environments specify the server, username, and password for ArcGIS Server when you use the Parallel Processing Factor environment. The password associated with the user name that is authorized to use the Raster Processing service. | String |
| processingServerUser (Read and Write) | Tools that honor the Remote Processing Server set of environments specify the server, username, and password for ArcGIS Server when you use the Parallel Processing Factor environment. The username that is authorized to use the Raster Processing service. | String |
| processorType (Read and Write) | Tools that honor the Processor Type environment allow you to choose where and how you want to process your data. | Long |
| pyramid (Read and Write) | Tools that honor the Pyramid environment will only process rasters where the pyramids are valid. Pyramids for ERDAS IMAGINE files have limited options that can be set. | String |
| qualifiedFieldNames (Read and Write) | Tools that honor the Maintain fully qualified field names environment use this setting to distinguish between qualified and unqualified field names. Qualified field names are the names of fields in a feature class or table that have the name of the origin feature class or table appended to the field name. This setting is relevant when working with joined data. | Boolean |
| randomGenerator (Read and Write) | Tools that use the Random Number Generator environment use algorithms that use the seed and distribution to produce a sequence of random numbers. | Object |
| rasterStatistics (Read and Write) | Tools that honor the Raster Statistics environment control how statistics are built for output raster datasets. | String |
| recycleProcessingWorkers (Read and Write) | Tools that honor the Recycle Interval Of Processing Workers environment define how many image sections will be processed before restarting worker processes to prevent potential failures in long-running processes. | Long |
| referenceScale (Read and Write) | Tools that honor the Reference Scale environment will consider the graphical size and extent of symbolized features as they appear at the reference scale. | Double |
| resamplingMethod (Read and Write) | Tools that honor the Resampling Method environment interpolate pixel values while transforming your raster dataset. This is used when the input and output do not line up exactly, when the pixel size changes, when the data is shifted, or a combination of these. | String |
| retryOnFailures (Read and Write) | Tools that honor the Number of Retries on Failures environment will retry the same worker process a specified number of attempts when there is a failure processing a particular job. | Long |
| scratchFolder (Read Only) | The Scratch Folder environment setting is the location of a folder you can use to write file-based data, such as shapefiles, text files, and layer files. | String |
| scratchGDB (Read Only) | The Scratch GDB environment setting is the location of a file geodatabase you can use to write temporary data. | String |
| scriptWorkspace (Read Only) | The Script Workspace is the location of a project and is used by geoprocessing tools when they have been included in a project package (.ppkx file) and extracted. | String |
| scratchWorkspace (Read and Write) | Tools that honor the Scratch Workspace environment use the specified location as the default workspace for output datasets. The scratch workspace is intended for output data you do not want to maintain. | String |
| snapRaster (Read and Write) | Tools that honor the Snap Raster environment will adjust the extent of output rasters so that they match the cell alignment of the specified snap raster. | String |
| S100FeatureCatalogueFile (Read and Write) | Tools that honor the S-100 Feature Catalogue File environment use the file specified to map objects, attributes, feature classes, and relationships during data import and the creation of database schemas. | String |
| terrainMemoryUsage (Read and Write) | Tools that honor the Minimize memory use during analysis on terrains environment control memory use during analysis on terrains. | Boolean |
| tileSize (Read and Write) | Tools that honor the Tile Size environment set the tile size for rasters that are stored in blocks of data. | String |
| timeZone (Read and Write) | Tools that honor the Time Zone environment will specify the time zone in which the date fields are stored. | String |
| tinSaveVersion (Read and Write) | Tools that honor the Default TIN Storage Version environment will output TIN surfaces in the specified version. | String |
| transferDomains (Read and Write) | Tools that honor the Transfer field domain descriptions environment control whether the output will include fields containing domain and subtype descriptions, as well as fields containing domain and subtype codes. This setting is relevant when the input to a geoprocessing tool is a geodatabase feature class or table with defined domains and subtypes. | Boolean |
| transferGDBAttributeProperties (Read and Write) | Tools that honor the Transfer Geodatabase Field Properties environment will transfer domains, subtypes, attribute rules, field groups, and contingent values from the input dataset's fields to the output dataset's fields. | Boolean |
| unionDimension (Read and Write) | Tools that honor the Union Dimension environment will generate a multidimensional raster that includes all the dimensions from the input multidimensional rasters. | Boolean |
| useCompatibleFieldTypes (Read and Write) | Specifies whether field types that are compatible with ArcGIS Pro 3.1 will be used. This setting relates to the use of the Date Only, Time Only, Timestamp Offset, and Big Integer field types in CSV tables and unregistered database tables with tools that create layers or table views. When set to True, a layer or table view created from these sources will use field types compatible with ArcGIS Pro 3.1. Date Only, Time Only, and Timestamp Offset fields will be displayed as Date fields, and Big Integer fields will be displayed as Double fields. When set to False, all original data source field types will be used. Note:This property is applicable when used from stand-alone Python or for a geoprocessing service. When used in ArcGIS Pro, this property will always match the Use field types that are compatible with ArcGIS Pro 3.1 and earlier releases when adding query layers and text files option. | Boolean |
| workspace (Read and Write) | Tools that honor the Current Workspace environment use the workspace specified as the default location for geoprocessing tool inputs and outputs. | String |
| XYDomain (Read and Write) | Tools that honor the Output XY Domain environment will set the specified range to the output geodataset's x,y domain. | String |
| XYResolution (Read and Write) | Tools that honor the XY Resolution environment will apply the x,y resolution to output geodatasets. The x,y resolution, expressed as a very small distance, refers to the number of significant digits used to store x,y coordinate values. | String |
| XYTolerance (Read and Write) | Tools that honor the XY Tolerance environment will override the default x,y tolerance on geodatasets created in a geodatabase. | String |
| ZDomain (Read and Write) | Tools that honor the Output Z Domain environment will generate output datasets with the specified z-domain. | String |
| ZResolution (Read and Write) | Tools that honor the Z Resolution environment will apply the z-resolution to output geodatasets. The z-resolution, expressed as a very small distance, refers to the number of significant digits used to store z-coordinate values. | String |
| ZTolerance (Read and Write) | Tools that honor the Z Tolerance environment will override the default z-tolerance on geodatasets created in a geodatabase. | String |