motherduck (version 0.2.0)

create_if_not_exists_share: Create a MotherDuck database share if it does not exist

Description

Creates a new share for a specified database in MotherDuck if it does not already exist. Allows you to configure access, visibility, and update settings for the share.

Usage

create_if_not_exists_share(
  .con,
  share_name,
  database_name,
  access = "PUBLIC",
  visibility = "LISTED",
  update = "AUTOMATIC"
)

Value

A message confirming that the share has been created, if it did not already exist.

Arguments

.con

A valid DBI connection (DuckDB / MotherDuck).

share_name

Character. The name of the new share to create.

database_name

Character. The name of the target database to share.

access

Character. Access level for the share; either "RESTRICTED" or "PUBLIC" (default: "PUBLIC").

visibility

Character. Visibility of the share; either "HIDDEN" or "LISTED" (default: "LISTED").

update

Character. Update policy for the share; either "AUTOMATIC" or "MANUAL" (default: "AUTOMATIC").

Details

This function executes a CREATE IF NOT EXISTS SQL statement on the connected MotherDuck database to create a share for the specified database.

• access controls who can access the share.

• visibility controls whether the share is listed publicly or hidden.

• update controls whether changes to the source database are automatically reflected in the share. After creation, the current user is displayed for confirmation.

See Also

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

Examples

if (FALSE) {
con <- DBI::dbConnect(duckdb::duckdb(dbdir = tempfile()))

create_if_not_exists_share(
  .con = con,
  share_name = "analytics_share",
  database_name = "sales_db",
  access = "PUBLIC",
  visibility = "LISTED",
  update = "AUTOMATIC"
)
}