FQL v4 will be decommissioned on June 30, 2025. Ensure that you complete your migration from FQL v4 to FQL v10 by that date.

For more details, review the migration guide. Contact support@fauna.com with any questions.

Rename a child database

Reading or writing database documents requires an admin key.

Problem

You need to change the name of a child database.

Solution

Use the Update function:

adminClient.query(
  q.Update(q.Database('annuvin'), { name: 'llyr' })
)
.then((ret) => console.log(ret))
.catch((err) => console.error(
  'Error: [%s] %s: %s',
  err.name,
  err.message,
  err.errors()[0].description,
))
{
  ref: Database("llyr"),
  ts: 1622573509460000,
  name: 'llyr',
  global_id: 'yoiji573cydyy'
}
result = adminClient.query(
  q.update(q.database("annuvin"), {"name": "llyr"})
)
print(result)
{'ref': Ref(id=llyr, collection=Ref(id=databases)), 'ts': 1622573512200000, 'name': 'llyr', 'global_id': 'yoijihdqgydyy'}
result, err := adminClient.Query(
	f.Update(
		f.Database("annuvin"),
		f.Obj{"name": "llyr"},
	))

if err != nil {
	fmt.Fprintln(os.Stderr, err)
} else {
	fmt.Println(result)
}
map[global_id:yoiji3uwcybyy name:llyr ref:{llyr 0xc0001804b0 0xc0001804b0 <nil>} ts:1622573472680000]
try
{
    Value result = await client.Query(
        Update(Database("annuvin"), Obj("name", "llyr"))
    );
    Console.WriteLine(result);
}
catch (Exception e)
{
    Console.WriteLine($"ERROR: {e.Message}");
}
ObjectV(ref: RefV(id = "llyr", collection = RefV(id = "databases")),ts: LongV(1622573459830000),name: StringV(llyr),global_id: StringV(yoijia8e1ybyy))
Update(Database('annuvin'), { name: 'llyr' })
{
  ref: Database("llyr"),
  ts: 1624310577150000,
  name: 'llyr',
  global_id: 'yoat8nnggybyy'
}
Query metrics:

  •    bytesIn:   69

  •   bytesOut:  148

  • computeOps:    1

  •    readOps:    0

  •   writeOps:    1

  •  readBytes:  170

  • writeBytes:  477

  •  queryTime: 28ms

  •    retries:    0

Discussion

It is not possible to rename the parent database, the current database, or any of the current database’s peers (that may exist) using Update. You can only rename a child databases.

Is this article helpful? 

Tell Fauna how the article can be improved:
 Visit Fauna's forums or email docs@fauna.com

Thank you for your feedback!