Timestamp
A timestamp
field represents a date time value in ISO8601 format.
Options:
defaultValue
(default:undefined
): Can be either a string value with a date time string in ISO8601 format or{ kind: 'now' }
. This value will be used for the field when creating items if no explicit value is set.db.map
: Adds a Prisma@map
attribute to this field which changes the column name in the databasedb.isNullable
(default:validation.isRequired ? false : true
): Iffalse
then this field will be made non-nullable in the database and it will never be possible to set asnull
.validation.isRequired
(default:false
): Iftrue
then this field can never be set tonull
. It validate this when creating and updating an item through the GraphQL API or the Admin UI. It will also defaultdb.isNullable
to false.db.updatedAt
(default:false
) Iftrue
then this field will add the@updatedAt
attribute to this field in the Prisma schema. This will update this field to the current time whenever an item is created/updated with the GraphQL API or any other usage of the Prisma Client if this field is not explicitly set in the request. Note this happens at the Prisma Client level, not at the database so if you update an item in your database directly, fields withdb.updatedAt: true
will not automatically update.isIndexed
(default:false
)- If
true
then this field will be indexed by the database. - If
'unique'
then all values of this field must be unique.
- If
graphql.read.isNonNull
(default:false
): If you have no read access control and you don't intend to add any in the future, you can set this to true and the output field will be non-nullable. This is only allowed when you have no read access control because otherwise, when access is denied,null
will be returned which will cause an error since the field is non-nullable and the error will propagate up until a nullable field is found which means the entire item will be unreadable and when doing anitems
query, all the items will be unreadable.graphql.create.isNonNull
(default:false
): If you have no create access control and you want to explicitly show that this is field is non-nullable in the create input you can set this to true and the create field will be non-nullable and have a default value at the GraphQL level. This is only allowed when you have no create access control because otherwise, the item will always fail access control if a user doesn't have access to create the particular field regardless of whether or not they specify the field in the create.
import { config, list } from '@keystone-6/core';import { timestamp } from '@keystone-6/core/fields';export default config({lists: {SomeListName: list({fields: {someFieldName: timestamp({defaultValue: '1970-01-01T00:00:00.000Z',db: { map: 'my_timestamp' },validation: { isRequired: true },isIndexed: 'unique',}),/* ... */},}),/* ... */},/* ... */});