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

Fauna accounts created after August 21, 2024 must use FQL v10. These accounts will not be able to run FQL v4 queries or access the v4 Dashboard.

For more details, see the v4 EOL announcement and migration guide. Contact support@fauna.com with any questions.

Create a key

Reading or writing key definitions requires an admin key.

Problem

You need to create a key in the current database.

Solution

Use the CreateKey function:

adminClient.query(
  q.CreateKey({
    database: q.Database('prydain'),
    role: 'server',
  })
)
.then((ret) => console.log(ret))
.catch((err) => console.error(
  'Error: [%s] %s: %s',
  err.name,
  err.message,
  err.errors()[0].description,
))

{
  ref: Ref(Keys(), "309749247463391744"),
  ts: 1631658751850000,
  database: Database("prydain"),
  role: 'server',
  secret: 'fnAETHNMqIACALQjS6v19qW8M2_gg-JNgn7ygC16',
  hashed_secret: '$2a$05$1SJ9KBqMn.YHXJT0P2VZs.6YrRY0Qx41KL/2A8tAGjJ3bAC4o.L1u'
}

result = adminClient.query(
  q.create_key({
    "database": q.database("prydain"),
    "role": "server"
  })
)
print(result)

{'ref': Ref(id=309751197640688128, collection=Ref(id=keys)), 'ts': 1631660611680000, 'database': Ref(id=prydain, collection=Ref(id=databases)), 'role': 'server', 'secret': 'fnAETHUSuCACAIus1In2Tz3Rv4CIcYCMMzsiFGyM', 'hashed_secret': '$2a$05$gevYk..SvzS3U6cImfQhzuThKJFvlKZP/U89ZgAeK7cXiN5qztwzG'}

result, err := adminClient.Query(
	f.CreateKey(
		f.Obj{
			"database": f.Database("prydain"),
			"role": "server",
		},
	),
)

if err != nil {
	fmt.Fprintln(os.Stderr, err)
} else {
	fmt.Println(result)
}

map[database:{prydain 0xc0001845a0 0xc0001845a0 <nil>} hashed_secret:$2a$05$PYjJZWK/7jhiTNMYzevVP.Ci3HoaxYMUWKJSe7v/Kfd2pM0gNOxzy ref:{309750664624341504 0xc0001844b0 0xc0001844b0 <nil>} role:server secret:fnAETHSWneACAKCJlNYbBidugnzgQW7ZLe1WKuMe ts:1631660103360000]

try
{
    Value result = await adminClient.Query(
        CreateKey(
            Obj(
                "database", Database("prydain"),
                "role", "server"
            )
        )
    );
    Console.WriteLine(result);
}
catch (Exception e)
{
    Console.WriteLine($"ERROR: {e.Message}");
}

ObjectV(ref: RefV(id = "309749531319206400", collection = RefV(id = "keys")),ts: LongV(1631659022560000),database: RefV(id = "prydain", collection = RefV(id = "databases")),role: StringV(server),secret: StringV(fnAETHOOv6ACACCGJIDhYL9aXeLgMCbdn5zw1_Nq),hashed_secret: StringV($2a$05$Gu/nO7wdPDr8pAUZz1g3hOQQYPkLIqCkAUL1tcPWybJApBrEgmqj.))

System.out.println(
    adminClient.query(
        CreateKey(
            Obj(
                "database", Database("prydain"),
                "role", Value("server")
            )
        )
    ).get());

{ref: ref(id = "309752044938330624", collection = ref(id = "keys")), ts: 1631661419730000, database: ref(id = "prydain", collection = ref(id = "databases")), role: "server", secret: "fnAETHXX_wACAMC1JKCDyQlqF3N2xW7_mPF2C6Ap", hashed_secret: "$2a$05$6DEulAKI5LhXlPzHiKoskOsfwtiBWisrG2oXiBtqpO4RWKX51N9JO"}

CreateKey({
  database: Database("prydain"),
  role: "server"
})

{
  ref: Ref(Keys(), "309732159785009664"),
  ts: 1631642455800000,
  database: Database("prydain"),
  role: 'server',
  secret: 'fnAETGPCH4ACAIf9avmbmbXAS7Yl-P-hDbw8QF9y',
  hashed_secret: '$2a$05$U6/orFxArR4o/LmMBabTwuD.SEkkujaxj9q4gb0wRhYP5AXLJNadW'
}

Query metrics:

bytesIn: 77
bytesOut: 340
computeOps: 1
readOps: 0
writeOps: 1
readBytes: 153
writeBytes: 487
queryTime: 324ms
retries: 0

The key’s secret is only ever shown once, in the response from the CreateKey function. If you lose the secret, delete the key and create a new one.

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!