OptionalbranchThe resource path of the branch associated with the catalog.
Format: projects/{project_id}/branches/{branch_id}.
OptionalcreateIf set to true, the specified postgres_database is created on behalf of the calling user if it does not already exist. In this case, the calling user has a role created for them in Postgres if they do not already have one.
Defaults to false, meaning that the request fails if the specified postgres_database does not already exist.
OptionalpostgresThe name of the Postgres database inside the specified Lakebase project and branch to be associated with the UC catalog. This database must already exist, unless create_database_if_missing is set to true on creation.
A database can only be registered with one UC catalog at a time. To re-register a database with a different catalog, the existing catalog must be deleted first.
A child branch inherits the fact of parent's registration. This means the same-named database in a child branch cannot be registered with a second catalog while the parent's registration exists. To allow registering the database of a child branch, drop and recreate the database on the child branch. This removes the fact of parent's registration from this branch only.
Doing Point In Time Restore (PITR) prior to the moment before the Postgres DB was registered in the Catalog drops the fact of registration of the database. So the user should avoid doing so.
The desired state of the Catalog.