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.

Token metadata

Problem

Store additional metadata within a token document.

Solution

Set the data field in a token:

client.query(
  q.Update(
    q.Ref(q.Tokens(), '1'),
    {
      data: {
        team: 'Marketing',
      },
    },
  )
)
.then((ret) => console.log(ret))
.catch((err) => console.error(
  'Error: [%s] %s: %s',
  err.name,
  err.message,
  err.errors()[0].description,
))

{
  ref: Ref(Tokens(), "1"),
  ts: 1631739422930000,
  instance: Ref(Collection("users"), "1"),
  data: { team: 'Marketing' }
}

result = client.query(
  q.update(
    q.ref(q.tokens(), "1"),
    {
      "data": {
        "team": "Marketing"
      }
    }
  )
)
print(result)

{'ref': Ref(id=1, collection=Ref(id=tokens)), 'ts': 1631739701090000, 'instance': Ref(id=1, collection=Ref(id=users, collection=Ref(id=collections))), 'data': {'team': 'Marketing'}}

result, err := client.Query(
	f.Update(
		f.Ref(f.Tokens(), "1"),
		f.Obj{
			"data": f.Obj{
				"team": "Marketing",
			},
		},
	))

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

map[data:map[team:Marketing] instance:{1 0xc000200660 0xc000200660 <nil>} ref:{1 0xc0002004b0 0xc0002004b0 <nil>} ts:1631739856660000]

try
{
    Value result = await client.Query(
        Update(
            Ref(Tokens(), "1"),
            Obj(
                "data", Obj(
                    "team", "Marketing"
                )
            )
        )
    );
    Console.WriteLine(result);
}
catch (Exception e)
{
    Console.WriteLine($"ERROR: {e.Message}");
}

ObjectV(ref: RefV(id = "1", collection = RefV(id = "tokens")),ts: LongV(1631740130800000),instance: RefV(id = "1", collection = RefV(id = "users", collection = RefV(id = "collections"))),data: ObjectV(team: StringV(Marketing)))

System.out.println(
    client.query(
        Update(
            Ref(Tokens(), "1"),
            Obj(
                "data", Obj(
                    "team", Value("Marketing")
                )
            )
        )
    ).get());

{ref: ref(id = "1", collection = ref(id = "tokens")), ts: 1631740302150000, instance: ref(id = "1", collection = ref(id = "users", collection = ref(id = "collections"))), data: {team: "Marketing"}}

Update(
  Ref(Tokens(), '1'),
  {
    data: {
      team: "Marketing"
    }
  }
)

{
  ref: Ref(Tokens(), "1"),
  ts: 1631738655590000,
  instance: Ref(Collection("users"), "1"),
  data: { team: 'Marketing' }
}

Query metrics:

bytesIn: 104
bytesOut: 239
computeOps: 1
readOps: 0
writeOps: 1
readBytes: 138
writeBytes: 177
queryTime: 26ms
retries: 0

Discussion

You can add the metadata while creating or updating a token document.

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!