database.replace()

Learn: Databases and multi-tenancy

Replace a child database's metadata and settings.

Signature

replace(data: { *: Any }) => DatabaseDef

Description

Replaces all fields in a child database's metadata and settings, represented as an Database document, with fields from a provided data object. Fields not present in the data object, excluding the coll and ts metadata fields, are removed.

Fauna stores child databases as documents in the parent database’s Database system collection. Database documents have the DatabaseDef type.

Metadata fields

You can’t use this method to insert or edit the following metadata fields:

  • coll

  • ts

Database backups

You can’t use this method to enable or disable backups on a child database. You can only enable or disable backups in the Fauna Dashboard. See Database backup and restore .

Parameters

Parameter Type Required Description

data

Object

Fields for the Database document. Fields not present, excluding the coll and ts metadata fields, in the object are removed.

For supported document fields, see Database collection.

The object can’t include the following metadata fields:

  • coll

  • ts

Return value

Type Description

DatabaseDef

Database document with replaced fields.

Examples

Database.byName("childDB")!.replace({name: "childDB2"})
{
  name: "childDB2",
  coll: Database,
  ts: Time("2099-06-24T21:54:13.225Z"),
  global_id: "ysjpyeykhyyr4"
}
\