Remove Data From BIS (Bathymetry)

Summary

Removes data from a Bathymetric Information System (BIS) geodatabase.

This tool does not delete or modify the registered datasets.

Usage

• The BIS workspace where the Target BisCatalog parameter value is located must already contain a BIS.

• This tool removes datasets from the BisCatalog catalog dataset and BisBDI mosaic dataset, as appropriate.

• This tool deletes proxy rasters, if relevant.

• You must have edit access to the proxy raster location, if applicable.

• Data removal cannot be undone. To add data back to a BIS, use the Add Data To BIS or Add Point Data To BIS tool.

• Refresh the layers in the List By Data Source tab of the Contents pane to see datasets added by other users when adding data to an enterprise geodatabase BIS.

Parameters

Dialog

Label	Explanation	Data Type
Target BisCatalog	The catalog dataset in the BIS workspace.	Feature Layer
Query Definition (Optional)	An SQL expression to select the datasets that will be removed from the BIS. If no datasets are selected, either from the BisCatalog attributes table or through a definition query, a warning is generated. To delete all records from a BIS, specify a query that selects all datasets; for example, OBJECTID >= 0.	SQL Expression
Delete overview images (Optional)	Specifies whether the overviews associated with the selected rasters will be deleted. Checked—The overviews will be deleted. This is the default. Unchecked—The overviews will not be deleted.	Boolean
Update overviews (Optional)	Specifies whether the overviews and statistics will be updated. Checked—The overviews and statistics for a mosaic dataset will be updated. Unchecked—The overviews and statistics for a mosaic dataset will not be updated. This is the default.	Boolean

Derived Output

Label	Explanation	Data Type
Updated BIS	The updated BIS workspace.	Workspace
Updated BisCatalog	The updated catalog dataset.	Catalog Layer

Python

arcpy.bathymetry.RemoveDataFromBIS(target_biscatalog, {where_clause}, {delete_overview_images}, {update_overviews})

Name	Explanation	Data Type
target_biscatalog	The catalog dataset in the BIS workspace.	Feature Layer
where_clause (Optional)	An SQL expression to select the datasets that will be removed from the BIS. If no datasets are selected, either from the BisCatalog attributes table or through a definition query, a warning is generated. To delete all records from a BIS, specify a query that selects all datasets; for example, OBJECTID >= 0.	SQL Expression
delete_overview_images (Optional)	Specifies whether the overviews associated with the selected rasters will be deleted. DELETE_OVERVIEW_IMAGES—The overviews will be deleted. This is the default. NO_DELETE_OVERVIEW_IMAGES—The overviews will not be deleted.	Boolean
update_overviews (Optional)	Specifies whether the overviews and statistics will be updated. UPDATE_OVERVIEWS—The overviews and statistics for a mosaic dataset will be updated. NO_UPDATE_OVERVIEWS—The overviews and statistics for a mosaic dataset will not be updated. This is the default.	Boolean

Derived Output

Name	Explanation	Data Type
updated_bis	The updated BIS workspace.	Workspace
updated_biscatalog	The updated catalog dataset.	Catalog Layer

Code sample

RemoveDataFromBIS example (Python window)

The following Python window script demonstrates how to use the RemoveDataFromBIS function.

#Import arcpy module and toolbox
import arcpy
arcpy.CheckOutExtension("Bathymetry")

#Identify tool parameters
target_biscatalog = r"C:\Data\BIS.gdb\BisCatalog"
query = "OBJECTID = 27"
delete_overviews = "DELETE_OVERVIEW_IMAGES"
update_overviews = "UPDATE_OVERVIEWS"

#Run the tool
arcpy.bathymetry.RemoveDataFromBIS(target_biscatalog, query, delete_overviews, update_overviews)
arcpy.CheckInExtension("Bathymetry")

Environments

Extent

Licensing information

• Basic: No
• Standard: Requires ArcGIS Bathymetry
• Advanced: Requires ArcGIS Bathymetry