Skip to main content

Working with Json fields

Use the Json Prisma ORM field type to read, write, and perform basic filtering on JSON types in the underlying database. In the following example, the User model has an optional Json field named extendedPetsData:

model User {
  id               Int     @id @default(autoincrement())
  email            String  @unique
  name             String?
  posts            Post[]
  extendedPetsData Json?
}

Example field value:

{
  "pet1": {
    "petName": "Claudine",
    "petType": "House cat"
  },
  "pet2": {
    "petName": "Sunny",
    "petType": "Gerbil"
  }
}

Note: The Json field is only supported if the underlying database has a corresponding JSON data type.

The Json field supports a few additional types, such as string and boolean. These additional types exist to match the types supported by JSON.parse():

export declare type JsonValue =
  | string
  | number
  | boolean
  | null
  | JsonObject
  | JsonArray

Use cases for JSON fields​

Reasons to store data as JSON rather than representing data as related models include:

  • You need to store data that does not have a consistent structure
  • You are importing data from another system and do not want to map that data to Prisma models

Reading a Json field​

You can use the Prisma.JsonArray and Prisma.JsonObject utility classes to work with the contents of a Json field:

const { PrismaClient, Prisma } = require('@prisma/client')

const user = await prisma.user.findFirst({
  where: {
    id: 9,
  },
})

// Example extendedPetsData data:
// [{ name: 'Bob the dog' }, { name: 'Claudine the cat' }]

if (
  user?.extendedPetsData &&
  typeof user?.extendedPetsData === 'object' &&
  Array.isArray(user?.extendedPetsData)
) {
  const petsObject = user?.extendedPetsData as Prisma.JsonArray

  const firstPet = petsObject[0]
}

See also: Advanced example: Update a nested JSON key value

Writing to a Json field​

The following example writes a JSON object to the extendedPetsData field:

var json = [
  { name: 'Bob the dog' },
  { name: 'Claudine the cat' },
] as Prisma.JsonArray

const createUser = await prisma.user.create({
  data: {
    email: '[email protected]',
    extendedPetsData: json,
  },
})

Note: JavaScript objects (for example, { extendedPetsData: "none"}) are automatically converted to JSON.

See also: Advanced example: Update a nested JSON key value

Filter on a Json field (simple)​

You can filter rows of Json type.

Filter on exact field value​

The following query returns all users where the value of extendedPetsData matches the json variable exactly:

var json = { [{ name: 'Bob the dog' }, { name: 'Claudine the cat' }] }

const getUsers = await prisma.user.findMany({
  where: {
    extendedPetsData: {
      equals: json,
    },
  },
})

The following query returns all users where the value of extendedPetsData does not match the json variable exactly:

var json = {
  extendedPetsData: [{ name: 'Bob the dog' }, { name: 'Claudine the cat' }],
}

const getUsers = await prisma.user.findMany({
  where: {
    extendedPetsData: {
      not: json,
    },
  },
})

Filter on a Json field (advanced)​

You can also filter rows by the data inside a Json field. We call this advanced Json filtering. This functionality is supported by PostgreSQL and MySQL only with different syntaxes for the path option.

warning

PostgreSQL does not support filtering on object key values in arrays.

info

The availability of advanced Json filtering depends on your Prisma version:

path syntax depending on database​

The filters below use a path option to select specific parts of the Json value to filter on. The implementation of that filtering differs between connectors:

For example, the following is a valid MySQL path value:

$petFeatures.petName

The following is a valid PostgreSQL path value:

["petFeatures", "petName"]

Filter on object property​

You can filter on a specific property inside a block of JSON. In the following examples, the value of extendedPetsData is a one-dimensional, unnested JSON object:

{
  "petName": "Claudine",
  "petType": "House cat"
}

The following query returns all users where the value of petName is "Claudine":

const getUsers = await prisma.user.findMany({
  where: {
    extendedPetsData: {
      path: ['petName'],
      equals: 'Claudine',
    },
  },
})

The following query returns all users where the value of petType contains "cat":

const getUsers = await prisma.user.findMany({
  where: {
    extendedPetsData: {
      path: ['petType'],
      string_contains: 'cat',
    },
  },
})

The following string filters are available:

Filter on nested object property​

You can filter on nested JSON properties. In the following examples, the value of extendedPetsData is a JSON object with several levels of nesting.

{
  "pet1": {
    "petName": "Claudine",
    "petType": "House cat"
  },
  "pet2": {
    "petName": "Sunny",
    "petType": "Gerbil",
    "features": {
      "eyeColor": "Brown",
      "furColor": "White and black"
    }
  }
}

The following query returns all users where "pet2" → "petName" is "Sunny":

const getUsers = await prisma.user.findMany({
  where: {
    extendedPetsData: {
      path: ['pet2', 'petName'],
      equals: 'Sunny',
    },
  },
})

The following query returns all users where:

  • "pet2" → "petName" is "Sunny"
  • "pet2" → "features" → "furColor" contains "black"
const getUsers = await prisma.user.findMany({
  where: {
    AND: [
      {
        extendedPetsData: {
          path: ['pet2', 'petName'],
          equals: 'Sunny',
        },
      },
      {
        extendedPetsData: {
          path: ['pet2', 'features', 'furColor'],
          string_contains: 'black',
        },
      },
    ],
  },
})

Filtering on an array value​

You can filter on the presence of a specific value in a scalar array (strings, integers). In the following example, the value of extendedPetsData is an array of strings:

["Claudine", "Sunny"]

The following query returns all users with a pet named "Claudine":

const getUsers = await prisma.user.findMany({
  where: {
    extendedPetsData: {
      array_contains: ['Claudine'],
    },
  },
})
info

Note: In PostgreSQL, the value of array_contains must be an array and not a string, even if the array only contains a single value.

The following array filters are available:

Filtering on nested array value​

You can filter on the presence of a specific value in a scalar array (strings, integers). In the following examples, the value of extendedPetsData includes nested scalar arrays of names:

{
  "cats": { "owned": ["Bob", "Sunny"], "fostering": ["Fido"] },
  "dogs": { "owned": ["Ella"], "fostering": ["Prince", "Empress"] }
}

Scalar value arrays​

The following query returns all users that foster a cat named "Fido":

const getUsers = await prisma.user.findMany({
  where: {
    extendedPetsData: {
      path: ['cats', 'fostering'],
      array_contains: ['Fido'],
    },
  },
})
info

Note: In PostgreSQL, the value of array_contains must be an array and not a string, even if the array only contains a single value.

The following query returns all users that foster cats named "Fido" and "Bob":

const getUsers = await prisma.user.findMany({
  where: {
    extendedPetsData: {
      path: ['cats', 'fostering'],
      array_contains: ['Fido', 'Bob'],
    },
  },
})

JSON object arrays​

const json = [{ status: 'expired', insuranceID: 92 }]

const checkJson = await prisma.user.findMany({
  where: {
    extendedPetsData: {
      path: ['insurances'],
      array_contains: json,
    },
  },
})

  • If you are using PostgreSQL, you must pass in an array of objects to match, even if that array only contains one object:

    [{ status: 'expired', insuranceID: 92 }]
    // PostgreSQL

    If you are using MySQL, you must pass in a single object to match:

    { status: 'expired', insuranceID: 92 }
    // MySQL

  • If your filter array contains multiple objects, PostgreSQL will only return results if all objects are present - not if at least one object is present.

  • You must set array_contains to a JSON object, not a string. If you use a string, Prisma Client escapes the quotation marks and the query will not return results. For example:

    array_contains: '[{"status": "expired", "insuranceID": 92}]'

    is sent to the database as:

    [{\"status\": \"expired\", \"insuranceID\": 92}]

Targeting an array element by index​

You can filter on the value of an element in a specific position.

{ "owned": ["Bob", "Sunny"], "fostering": ["Fido"] }
const getUsers = await prisma.user.findMany({
  where: {
    comments: {
      path: ['owned', '1'],
      string_contains: 'Bob',
    },
  },
})

Filtering on object key value inside array​

Depending on your provider, you can filter on the key value of an object inside an array.

warning

Filtering on object key values within an array is only supported by the MySQL database connector. However, you can still filter on the presence of entire JSON objects.

In the following example, the value of extendedPetsData is an array of objects with a nested insurances array, which contains two objects:

[
  {
    "petName": "Claudine",
    "petType": "House cat",
    "insurances": [
      { "insuranceID": 92, "status": "expired" },
      { "insuranceID": 12, "status": "active" }
    ]
  },
  {
    "petName": "Sunny",
    "petType": "Gerbil"
  },
  {
    "petName": "Gerald",
    "petType": "Corn snake"
  },
  {
    "petName": "Nanna",
    "petType": "Moose"
  }
]

The following query returns all users where at least one pet is a moose:

const getUsers = await prisma.user.findMany({
  where: {
    extendedPetsData: {
      path: '$[*].petType',
      array_contains: 'Moose',
    },
  },
})
  • $[*] is the root array of pet objects
  • petType matches the petType key in any pet object

The following query returns all users where at least one pet has an expired insurance:

const getUsers = await prisma.user.findMany({
  where: {
    extendedPetsData: {
      path: '$[*].insurances[*].status',
      array_contains: 'expired',
    },
  },
})
  • $[*] is the root array of pet objects
  • insurances[*] matches any insurances array inside any pet object
  • status matches any status key in any insurance object

Advanced example: Update a nested JSON key value​

The following example assumes that the value of extendedPetsData is some variation of the following:

{
  "petName": "Claudine",
  "petType": "House cat",
  "insurances": [
    { "insuranceID": 92, "status": "expired" },
    { "insuranceID": 12, "status": "active" }
  ]
}

The following example:

  1. Gets all users
  2. Change the "status" of each insurance object to "expired"
  3. Get all users that have an expired insurance where the ID is 92
const userQueries: string | any[] = []

getUsers.forEach((user) => {
  if (
    user.extendedPetsData &&
    typeof user.extendedPetsData === 'object' &&
    !Array.isArray(user.extendedPetsData)
  ) {
    const petsObject = user.extendedPetsData as Prisma.JsonObject

    const i = petsObject['insurances']

    if (i && typeof i === 'object' && Array.isArray(i)) {
      const insurancesArray = i as Prisma.JsonArray

      insurancesArray.forEach((i) => {
        if (i && typeof i === 'object' && !Array.isArray(i)) {
          const insuranceObject = i as Prisma.JsonObject

          insuranceObject['status'] = 'expired'
        }
      })

      const whereClause = Prisma.validator<Prisma.UserWhereInput>()({
        id: user.id,
      })

      const dataClause = Prisma.validator<Prisma.UserUpdateInput>()({
        extendedPetsData: petsObject,
      })

      userQueries.push(
        prisma.user.update({
          where: whereClause,
          data: dataClause,
        })
      )
    }
  }
})

if (userQueries.length > 0) {
  console.log(userQueries.length + ' queries to run!')
  await prisma.$transaction(userQueries)
}

const json = [{ status: 'expired', insuranceID: 92 }]

const checkJson = await prisma.user.findMany({
  where: {
    extendedPetsData: {
      path: ['insurances'],
      array_contains: json,
    },
  },
})

console.log(checkJson.length)

Using null Values​

There are two types of null values possible for a JSON field in an SQL database.

  • Database NULL: The value in the database is a NULL.
  • JSON null: The value in the database contains a JSON value that is null.

To differentiate between these possibilities, we've introduced three null enums you can use:

  • JsonNull: Represents the null value in JSON.
  • DbNull: Represents the NULL value in the database.
  • AnyNull: Represents both null JSON values and NULL database values. (Only when filtering)
info

From v4.0.0, JsonNull, DbNull, and AnyNull are objects. Before v4.0.0, they were strings.

info
  • When filtering using any of the null enums you can not use a shorthand and leave the equals operator off.
  • These null enums do not apply to MongoDB because there the difference between a JSON null and a database NULL does not exist.
  • The null enums do not apply to the array_contains operator in all databases because there can only be a JSON null within a JSON array. Since there cannot be a database NULL within a JSON array, { array_contains: null } is not ambiguous.

For example:

model Log {
  id   Int  @id
  meta Json
}

Here is an example of using AnyNull:

import { Prisma } from '@prisma/client'

prisma.log.findMany({
  where: {
    data: {
      meta: {
        equals: Prisma.AnyNull,
      },
    },
  },
})

Inserting null Values​

This also applies to create, update and upsert. To insert a null value into a Json field, you would write:

import { Prisma } from '@prisma/client'

prisma.log.create({
  data: {
    meta: Prisma.JsonNull,
  },
})

And to insert a database NULL into a Json field, you would write:

import { Prisma } from '@prisma/client'

prisma.log.create({
  data: {
    meta: Prisma.DbNull,
  },
})

Filtering by null Values​

To filter by JsonNull or DbNull, you would write:

import { Prisma } from '@prisma/client'

prisma.log.findMany({
  where: {
    meta: {
      equals: Prisma.AnyNull,
    },
  },
})
info

These null enums do not apply to MongoDB because MongoDB does not differentiate between a JSON null and a database NULL. They also do not apply to the array_contains operator in all databases because there can only be a JSON null within a JSON array. Since there cannot be a database NULL within a JSON array, { array_contains: null } is not ambiguous.

Typed Json​

By default, Json fields are not typed in Prisma models. To accomplish strong typing inside of these fields, you will need to use an external package like prisma-json-types-generator to accomplish this.

Using prisma-json-types-generator​

First, install and configure prisma-json-types-generator according to the package's instructions.

Then, assuming you have a model like the following:

model Log {
  id   Int  @id
  meta Json
}

You can update it and type it by using abstract syntax tree comments

schema.prisma
model Log {
  id Int @id

  /// [LogMetaType]
  meta Json
}

Then, make sure you define the above type in a type declaration file included in your tsconfig.json

types.ts
declare global {
  namespace PrismaJson {
    type LogMetaType = { timestamp: number; host: string }
  }
}

Now, when working with Log.meta it will be strongly typed!

Json FAQs​

Can you select a subset of JSON key/values to return?​

No - it is not yet possible to select which JSON elements to return. Prisma Client returns the entire JSON object.

Can you filter on the presence of a specific key?​

No - it is not yet possible to filter on the presence of a specific key.

Is case insensitive filtering supported?​

No - case insensitive filtering is not yet supported.