Language tool support for named contraints/indexes

[janpio]

In context of our #project-constraint-name-inclusion we will introduce some new attributes on block and field attributes. These will probably have to be added here to show up for auto completion:

language-tools/packages/language-server/src/completion/completions.json

Lines 101 to 214 in 61d6839

	"blockAttributes": [
	{
	"label": "@@map(\"\")",
	"documentation": "Maps a model name from the Prisma schema to a different table name.",
	"fullSignature": "@@map(_ name: String)",
	"params": [
	{
	"label": "name",
	"documentation": "The name of the target database table."
	}
	]
	},
	{
	"label": "@@id([])",
	"documentation": "Defines a multi-field ID on the model.",
	"fullSignature": "@@id(_ fields: FieldReference[])",
	"params": [
	{
	"label": "fields",
	"documentation": "A list of references."
	}
	]
	},
	{
	"label": "@@unique([])",
	"documentation": "Defines a compound unique constraint for the specified fields.",
	"fullSignature": "@@unique(_ fields: FieldReference[])",
	"params": [
	{
	"label": "fields",
	"documentation": "A list of references."
	}
	]
	},
	{
	"label": "@@index([])",
	"documentation": "Defines an index on the model.",
	"fullSignature": "@@index(_ fields: FieldReference[])",
	"params": [
	{
	"label": "fields",
	"documentation": "A list of references."
	}
	]
	},
	{
	"label": "@@ignore",
	"documentation": "A model with an `@@ignore` attribute can be kept in sync with the database schema using Prisma Migrate and Introspection, but won't be exposed in Prisma Client.",
	"fullSignature": "@@ignore",
	"params": []
	}
	],
	"fieldAttributes": [
	{
	"label": "@id",
	"fullSignature": "@id",
	"documentation": "Defines a single-field ID on the model.",
	"params": []
	},
	{
	"label": "@unique",
	"fullSignature": "@unique",
	"documentation": "Defines a unique constraint for this field.",
	"params": []
	},
	{
	"label": "@map(\"\")",
	"documentation": "Maps a field name from the Prisma schema to a different column name.",
	"fullSignature": "@map(_ name: String)",
	"params": [
	{
	"label": "name",
	"documentation": "The name of the target database column."
	}
	]
	},
	{
	"label": "@default()",
	"documentation": "Defines a default value for this field. `@default` takes an expression as an argument.",
	"fullSignature": "@default(_ expression: Expression)",
	"params": [
	{
	"label": "expression",
	"documentation": "An expression (e.g. `5`, `true`, `now()`)."
	}
	]
	},
	{
	"label": "@relation()",
	"documentation": "Defines meta information about the relation. [Learn more](https://www.prisma.io/docs/reference/tools-and-interfaces/prisma-schema/relations#the-relation-attribute).",
	"fullSignature": "@relation(_ name: String?, fields: FieldReference[]?, references: FieldReference[]?)",
	"params": [
	{
	"label": "name",
	"documentation": "Defines the name of the relationship. In an m-n-relation, it also determines the name of the underlying relation table."
	},
	{
	"label": "fields",
	"documentation": "A list of field references of the *current* model."
	},
	{
	"label": "references",
	"documentation": "A list of field references of the model on *the other side of the relation*."
	},
	{
	"label": "onDelete",
	"documentation": "Specifies the action to perform when a referenced entry in the referenced model is being deleted."
	},
	{
	"label": "onUpdate",
	"documentation": "Specifies the action to perform when a referenced field in the referenced model is being updated to a new value."
	}
	]
	},

language-tools/packages/language-server/src/completion/completions.json

Lines 228 to 259 in 61d6839

	"relationArguments": [
	{
	"label": "references: []",
	"fullSignature": "references: []",
	"documentation": "A list of field references of the model on *the other side of the relation*.",
	"params": []
	},
	{
	"label": "fields: []",
	"fullSignature": "fields: []",
	"documentation": "A list of field references of the *current* model.",
	"params": []
	},
	{
	"label": "onDelete: ",
	"fullSignature": "onDelete: ",
	"documentation": "Specifies the action to perform when a referenced entry in the referenced model is being deleted.",
	"params": []
	},
	{
	"label": "onUpdate: ",
	"fullSignature": "onUpdate: ",
	"documentation": "Specifies the action to perform when a referenced field in the referenced model is being updated to a new value.",
	"params": []
	},
	{
	"label": "\"\"",
	"fullSignature": "\"\"",
	"documentation": "Defines the name of the relationship. In an m-n-relation, it also determines the name of the underlying relation table.",
	"params": []
	}
	],

Affected:
@id, @@id, @@index, @unique, @@unique, @default, @relation

[Jolg42]

Note that this was shipped as GA with Prisma v3 https://github.com/prisma/prisma/releases/tag/3.0.1

First as a preview in https://github.com/prisma/prisma/releases/tag/2.29.0

Docs https://www.prisma.io/docs/concepts/components/prisma-schema/names-in-underlying-database

You can see that @id, @relation and @@unique now can take a map argument corresponding to the database name of the primary key/foreign key/constraint.

@@unique can also take a name argument to control the naming of the WhereUnique argument in Prisma Client.

A quick way to remember: The new API is uniform. map: "..." always corresponds to a name in the database, whereas name: "..." always corresponds to names in the Prisma Client API.