tiledbsoma.DataFrame.tiledbsoma_upgrade_domain

DataFrame.tiledbsoma_upgrade_domain(newdomain: Sequence[None | Tuple[Any, Any] | List[Any]], check_only: bool = False) → Tuple[bool, str]

Allows you to set the domain of a SOMA DataFrame, when the DataFrame does not have a domain set yet.

The argument must be a tuple of pairs of low/high values for the desired domain, one pair per index column. For string index columns, you must offer the low/high pair as (“”, “”), or as None. If check_only is True, returns whether the operation would succeed if attempted, and a reason why it would not.

The discussion at change_domain applies here in its entirety, with the following exception: The tiledbsoma_upgrade_domain method is used to apply a domain to a dataframe created before TileDB-SOMA 1.15. The change_domain method is used only for a dataframe that already has a domain set, whether it’s an older dataframe that has had tiledbsoma_upgrade_domain applied to it, or it’s a newer dataframe created by TileDB-SOMA 1.15 or later.