validation/effect

17 notes, read out of this brain and free to use. Each one was extracted from a source and is re-checked against its exam.

Import effect-schema functions from 'drizzle-orm/effect-schema'

The functions createInsertSchema, createSelectSchema, and createUpdateSchema are imported from 'drizzle-orm/effect-schema'.

Override specific fields when creating Effect schemas

When creating Effect schemas with createInsertSchema, createSelectSchema, or createUpdateSchema, you can override specific fields by passing a second argument with field overrides. For example: createInsertSchema(users, { role: Schema.String }).

Refine fields in Effect schemas with transformation functions

You can refine fields when creating Effect schemas by passing a transformation function as the value for a field in the overrides object. The function receives the schema and returns a modified schema. For example: id: (schema) => schema.check(Schema.isGreaterThanOrEqualTo(0)).

Effect schema validation example with Schema.decodeUnknownEffect

To validate data against an Effect schema, use Effect.gen and Schema.decodeUnknownEffect. Example: const program = Effect.gen(function*() { const parsedUser = yield* Schema.decodeUnknownEffect(UserInsert)({ name: 'John Doe', email: 'johndoe@test.com', role: 'admin', }); });

effect-schema overview and features

The effect-schema package allows you to generate Effect schemas from Drizzle ORM schemas. It supports creating select schemas for tables and enums, insert schemas, and update schemas for tables. The supported dialect is CockroachDB.

Create insert, select, and update schemas with effect-schema

Import createInsertSchema, createSelectSchema, and createUpdateSchema from 'drizzle-orm/effect-schema'. These functions generate Effect schemas from Drizzle tables. createInsertSchema is used to validate API requests for inserts, createUpdateSchema for update validation, and createSelectSchema for validating API responses.

Refine fields in effect-schema generation

You can refine generated fields by passing a function as the second argument value to createInsertSchema, createUpdateSchema, or createSelectSchema. The function receives the generated schema and can apply additional checks or transformations. For example: id: (schema) => schema.check(Schema.isGreaterThanOrEqualTo(0)) applies a check that the id must be greater than or equal to 0.

effect-schema usage example with Effect.gen and Schema.decodeUnknownEffect

Example of using effect-schema for validation: import { int4, cockroachTable, text, timestamp } from 'drizzle-orm/cockroach-core'; import { createInsertSchema, createSelectSchema, createUpdateSchema } from 'drizzle-orm/effect-schema'; import { Effect, Schema } from 'effect'; const users = cockroachTable('users', { id: int4().primaryKey().generatedAlwaysAsIdentity(), name: text().notNull(), email: text().notNull(), role: text({ enum: ['admin', 'user'] }).notNull(), createdAt: timestamp('created_at').notNull().defaultNow(), }); const UserInsert = createInsertSchema(users); const UserUpdate = createUpdateSchema(users); const UserSelect = createSelectSchema(users); const UserInsert = createInsertSchema(users, { role: Schema.String }); const UserInsert = createInsertSchema(users, { id: (schema) => schema.check(Schema.isGreaterThanOrEqualTo(0)), role: Schema.String, }); const program = Effect.gen(function*() { const parsedUser = yield* Schema.decodeUnknownEffect(UserInsert)({ name: 'John Doe', email: 'johndoe@test.com', role: 'admin', }); });

drizzle-orm/effect-schema availability

Drizzle+Effect Schema integration is available starting from drizzle-orm@1.0.0-beta.15.

Effect Schema generation features

Effect Schema integration allows creating select schemas for tables, views and enums. It also supports creating insert and update schemas for tables. Supported dialects are CockroachDB, MSSQL, MySQL, PostgreSQL, SingleStore, and SQLite.

createInsertSchema function

The createInsertSchema function is imported from 'drizzle-orm/effect-schema' and generates an Effect schema for inserting data into a table. It can be used to validate API requests. The function accepts a table definition and optional overrides or refinements for fields.

createSelectSchema function

The createSelectSchema function is imported from 'drizzle-orm/effect-schema' and generates an Effect schema for selecting data from a table. It can be used to validate API responses.

createUpdateSchema function

The createUpdateSchema function is imported from 'drizzle-orm/effect-schema' and generates an Effect schema for updating data in a table. It can be used to validate API requests.

Effect Schema field overriding

When creating insert, select, or update schemas, you can override field schemas by passing an object as the second argument to createInsertSchema, createSelectSchema, or createUpdateSchema. For example, passing { role: Schema.String } will override the role field to use Schema.String instead of the inferred schema.

Effect Schema field refinement

You can refine fields in insert, select, or update schemas by passing a function as the value in the overrides object. The function receives the original schema and can transform it using pipe and Schema methods. For example, { id: (schema) => schema.pipe(Schema.greaterThanOrEqualTo(0)) } refines the id field to ensure it is greater than or equal to 0.

Effect Schema validation usage

To validate data against an Effect schema, use Effect.gen with Schema.validate(schema)(data). This returns a parsed result that can be used in Effect programs.

Effect Schema with MySQL tables

Effect Schema generation is supported for MySQL tables in Drizzle ORM, allowing you to create insert, update, and select schemas for MySQL table definitions.

Give your agent this brain