motherduck (version 0.2.0)

describe_share: Describe a MotherDuck share

Description

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)

Value

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

Arguments

.con

A valid DBI connection (DuckDB / MotherDuck).

share_name

Character. The name of the shared path to describe.

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.

See Also

Other db-manage: alter_table_schema(), copy_tables_to_new_location(), create_database(), create_if_not_exists_share(), create_or_replace_share(), create_schema(), create_table(), delete_and_create_schema(), delete_database(), delete_schema(), delete_table(), drop_share(), list_owned_shares(), list_shared_with_me_shares(), upload_database_to_md()

Examples

if (FALSE) {
con <- DBI::dbConnect(duckdb::duckdb(dbdir = tempfile()))
share_info <- describe_share(con, "analytics.sales_share")
print(share_info)
}