Skip to content

Latest commit

 

History

History
 
 

json

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
CHANGELOG.md
CHANGELOG.md
 
 
README.md
README.md
 
 
keystone.ts
keystone.ts
 
 
package.json
package.json
 
 
schema.graphql
schema.graphql
 
 
schema.prisma
schema.prisma
 
 
schema.ts
schema.ts
 
 

README.md

Feature Example - JSON Field

This project demonstrates the usage of the json field type. It builds on the Task Manager starter project.

Instructions

To run this project, clone the Keystone repository locally then navigate to this directory and run:

yarn dev

This will start the Admin UI at localhost:3000. You can use the Admin UI to create items in your database.

You can also access a GraphQL Playground at localhost:3000/api/graphql, which allows you to directly run GraphQL queries and mutations.

🚀 Congratulations, you're now up and running with Keystone!

Features

This example implements a Packages list. In this field we specify a pkgjson field which is a required json field type. This accepts any valid JSON including:

  • string node
  • number node
  • array node
  • object node

As this is required, both inputting null in the Admin UI as well as leaving the input empty are not accepted. However try removing the isRequired config option from the field config. In doing so, you'll notice that both inputting the string null as well as an empty field will result in a null database value being stored.

The JSON field type stores its value in the jsonb format, as specified by Prisma. However if sqlite is specified as the database type instead, then the value is stored as a string.