postgresql/consistent-jsonb-over-json

Why this matters

`jsonb` stores a parsed representation, supports GIN indexes, and is what application code almost always wants. `json` is only the right choice if you specifically need byte-exact round-tripping of input text. Pick one direction with the `style` option.

Examples

CREATE TABLE events (payload JSON);

CREATE TABLE events (payload JSONB);

Configure it

// eslint.config.js
import postgresql from "eslint-plugin-postgresql";

export default [
  {
    files: ["**/*.sql"],
    languageOptions: {
      parser: postgresql.configs.recommended.languageOptions.parser,
    },
    plugins: { postgresql },
    rules: {
      "postgresql/consistent-jsonb-over-json": [
        "warn",
        {
          style: "always",
        },
      ],
    },
  },
];

Options

style "always" | "never" default: "always"

`always` (default) requires `jsonb` over `json`. `never` requires `json` over `jsonb` for projects that rely on `json`'s preservation of key order, whitespace, and duplicate keys.