Change collection status or visibility override — update_collection_settings • artutils

Updates settings for a single collection in the database.

Usage

update_collection_settings(
  collection_uuid,
  status = NULL,
  visibility_override = NULL,
  extended_settings = NULL,
  cn = NULL
)

Arguments

collection_uuid: Character. Collection UUID (required).
status: Character. Collection status. Must be 'wip' or 'complete'. Default: NULL.
visibility_override: Character or NA. Visibility override. Must be NA (to clear), 'visible', or 'hidden'. Default: NULL.
extended_settings: List. Additional settings stored as JSONB. Default: NULL.
cn: Database connection. If NULL, creates and closes connection. Default: NULL.

Value

Logical. TRUE on success, FALSE on failure or if no record found.

Details

Updates fields in settings.collection_settings table. Only non-NULL parameters are updated. The updated_at timestamp is always set to NOW().

See also

Other settings: get_collect_visibility(), get_collection_settings(), get_collections_settings(), is_collection_visible(), upsert_artist_preferences()