Skip to main content

ListWorkspaces

Summary

Returns a list of workspaces in the current workspace.

Discussion

The workspace environment must be set before using several of the list functions, including ListDatasets, ListFeatureClasses, ListFiles, ListRasters, ListTables, and ListWorkspaces.

Syntax

ListWorkspaces({wild_card}, {workspace_type})

Parameter Explanation Data Type

wild_card

Limits the results returned. If a value is not specified, all values are returned. The wildcard is not case sensitive.

Use an asterisk (*) to represent zero or more characters. For example, Te* finds Tennessee and Texas.

String

workspace_type

The workspace type that will limit the results returned.

  • Coverage—Coverage workspaces will be returned.

  • FileGDB—File geodatabases (.gdb) will be returned.

  • Folder—Shapefile workspaces will be returned.

  • SDE—Enterprise databases (.sde) will be returned.

  • SQLite—SQLite databases (.sqlite, .gpkg) will be returned.

  • All—All workspaces will be returned. This is the default.

String

Return value

Data Type Explanation

String

The list containing workspace names that is returned from the function, limited by the wild_card and workspace_type arguments.

Code sample

ListWorkspaces example

Compact all file geodatabases in the workspace.

import arcpy

arcpy.env.workspace = "c:/data"

# List all file geodatabases in the current workspace
workspaces = arcpy.ListWorkspaces("*", "FileGDB")

for workspace in workspaces:
    # Compact each geodatabase
    arcpy.management.Compact(workspace)