Skip to contents

Retrieves detailed metadata about a specific share in MotherDuck, including the objects it contains, their types, and privileges granted.

Usage

describe_share(.con, share_name)

Arguments

.con

A valid DBI connection (DuckDB / MotherDuck).

share_name

Character. The name of the shared path to describe.

Value

A tibble containing metadata about the share, including object names, types, and privileges associated with the share.

Details

This function executes the md_describe_database_share system function to obtain comprehensive information about the specified share. The result is returned as a tibble for easy inspection and manipulation in R.

Examples

if (FALSE) { # \dontrun{
con <- DBI::dbConnect(duckdb::duckdb())
share_info <- describe_share(con, "analytics.sales_share")
print(share_info)
} # }