Skip to main content

Inventory

List of all UCX objects and their respective metadata.

Overview

Table utilization per workflow:

TableGenerate AssessmentUpdate Migration ProgressMigrate GroupsMigrate External TablesUpgrade JobsMigrate tablesMigrate Data Reconciliation
tablesRWRWRWRW
grantsRWRWRWRW
mountsRWRORORO
permissionsRWRWRORO
jobsRWRWRO
clustersRWRW
directfs_in_pathsRWRW
directfs_in_queriesRWRW
external_locationsRWRO
workspaceRWRORO
workspace_objectsRW
azure_service_principalsRW
global_init_scriptsRW
pipelinesRWRW
groupsRWRO
table_sizeRW
submit_runsRW
policiesRWRW
migration_statusRWRWRW
query_problemsRWRW
workflow_problemsRWRW
udfsRWRWRO
logsRWRWRWRWRWRWRW
recon_resultsRW
redash_dashboardsRWRW
lakeview_dashboardsRWRW
  • RW - Read/Write, the job generates or updates the table.
  • RO - Read Only

Inventory Database

_$inventory_.tables

Holds Inventory of all tables in all databases and their relevant metadata.

ColumnDatatypeDescriptionComments
catalogstringOriginal catalog of the table. hive_metastore by default
databasestringOriginal schema of the table
namestringName of the table
object_typestringMANAGED, EXTERNAL, or VIEW
table_formatstringTable provider. Like delta or json or parquet.
locationstringLocation of the data for table
view_textnullable stringIf the table is the view, then this column holds the definition of the view
upgraded_tostringUpgrade Target (3 level namespace)

_$inventory_.grants

Inventory of all Table ACLs for tables indexed in tables table.

ColumnDatatypeDescriptionComments
principalstringUser name, group name, or service principal name
action_typestringName of GRANT action
catalogstringOriginal catalog of the table. hive_metastore by default
databaseNullable stringOriginal schema of the table
tableNullable stringName of the table
viewNullable stringName of the view
any_fileboolAny file
anonymous_functionstringGrant for the anonymous function

_$inventory_.mounts

List of DBFS mount points.

ColumnDatatypeDescriptionComments
namestringName of the mount point
sourcestringLocation of the backing dataset
instance_profileNullable stringThis mount point is accessible only with this AWS IAM instance profile

_$inventory_.permissions

Workspace object level permissions

ColumnDatatypeDescriptionComments
object_idstringEither:
Group ID
Workspace Object ID
Redash Object ID
Scope name
supportsstringOne of:
AUTHORIZATION

CLUSTERS
CLUSTER_POLICIES
DIRECTORIES
EXPERIMENTS
FILES
INSTANCE_POOLS
JOBS
NOTEBOOKS
PIPELINES
REGISTERED_MODELS
REPOS
SERVING_ENDPOINTS
SQL_WAREHOUSES
raw_object_permissionsJSONJSON-serialized response of:
Generic Permissions
Secret ACL
Group roles and entitlements
Redash permissions

_$inventory_.jobs

Holds a list of all jobs with a notation of potential issues.

ColumnDatatypeDescriptionComments
job_idstringJob ID
job_namestringJob Name
job_creatorstringUserID of the Job Creator
compatibleint1 or 0, used for percentage reporting
failuresstringList of issues identified by the assessment in JSON format

_$inventory_.clusters

Holds a list of all clusters with a notation of potential issues.

ColumnDatatypeDescriptionComments
cluster_idstringCluster Id
cluster_namestringCluster Name
cluster_creatorstringUserID of the Cluster Creator
compatibleint1 or 0, used for percentage reporting
failuresstringList of issues identified by the assessment in JSON format

_$inventory_.external_locations

Holds a list of all external locations that will be required for the migration.

ColumnDatatypeDescriptionComments
external_locationstringExternal Location URL

_$inventory_.workspace_objects

Holds a list of all workspace objects (notebooks, directories, files, repos and libraries) from the workspace. This is used by the permission crawler.

ColumnDatatypeDescriptionComments
object_idstringunique id of the object
object_typestringtype of object (NOTEBOOK, DIRECTORY, REPO, FILE, LIBRARY)
pathstringfull path of the object in the workspace
languagestringlanguage of the object (applicable for notebooks only)

_$inventory_.redash_dashboards and _$inventory_.lakeview_dashboards

Holds a list of all Redash or Lakeview dashboards. This is used by the QueryLinter and Redash migration.

ColumnDatatypeDescriptionComments
idstringThe ID for this dashboard.
namestringThe title of the dashboard that appears in list views and at the top of the dashboard page.
parentstringThe identifier of the workspace folder containing the object.
query_idslist[string]The IDs of the queries referenced by this dashboard.
tagslist[string]The tags set on this dashboard.