{"_id":"kysely-sequelize","_rev":"1-a918ee63d4721d260f2bc9916b9b9252","name":"kysely-sequelize","dist-tags":{"latest":"0.2.0"},"versions":{"0.1.0":{"name":"kysely-sequelize","version":"0.1.0","description":"Kysely dialect for Sequelize","repository":{"type":"git","url":"git+https://github.com/igalklebanov/kysely-sequelize.git"},"homepage":"https://github.com/igalklebanov/kysely-sequelize","author":{"name":"Igal Klebanov","email":"igalklebanov@gmail.com"},"license":"MIT","main":"./dist/cjs/index.js","module":"./dist/esm/index.js","exports":{".":{"import":"./dist/esm/index.js","require":"./dist/cjs/index.js"}},"keywords":["kysely","sequelize","postgres","mysql","postgresql","mariadb","sqlite","mssql","dialect"],"peerDependencies":{"kysely":">= 0.24.0 < 1","sequelize":">= 6.0.0 < 7"},"devDependencies":{"@tsconfig/node20":"^20.1.2","@types/chai":"^4.3.4","@types/chai-as-promised":"^7.1.5","@types/chai-subset":"^1.3.3","@types/mocha":"^10.0.1","@types/mocha-each":"^2.0.0","@types/node":"^18.15.11","@types/pg":"^8.10.9","@types/validator":"^13.11.7","@typescript-eslint/eslint-plugin":"^5.57.1","@typescript-eslint/parser":"^5.57.1","chai":"^4.3.7","chai-subset":"^1.6.0","esbuild":"^0.17.15","esbuild-runner":"^2.2.2","eslint":"^8.38.0","eslint-config-prettier":"^8.8.0","eslint-plugin-import":"^2.27.5","eslint-plugin-prettier":"^4.2.1","kysely":"^0.26.3","kysely-master":"git+https://github.com/kysely-org/kysely.git#master","mariadb":"^3.2.2","mocha":"^10.2.0","mocha-each":"^2.0.1","mysql2":"^3.6.5","pg":"^8.11.3","pg-hstore":"^2.3.4","prettier":"^2.8.7","prettier-plugin-organize-imports":"^3.2.2","prettier-plugin-pkg":"^0.17.1","reflect-metadata":"^0.2.1","sequelize-typescript":"^2.1.6","sqlite3":"^5.1.6","tedious":"^16.6.1","tsup":"^6.7.0","typescript":"^5.0.4"},"sideEffects":false,"scripts":{"build":"tsup && node ./scripts/dist-fix.js","clean":"rm -rf dist","fmt":"prettier --write .","fmt:check":"prettier --check .","lint":"eslint src --ext .ts","test:nodejs":"mocha ./tests/nodejs","type-check":"tsc --noEmit"},"types":"./dist/cjs/index.d.ts","bugs":{"url":"https://github.com/igalklebanov/kysely-sequelize/issues"},"_id":"kysely-sequelize@0.1.0","_integrity":"sha512-A1/pPfU8zymSR9rxGwqaGfrMvHsMkHlC2hJpOlk/dNfyGsIN35NVrBvelZDYXisZt43lJ7UsvG4vBA1/HyCtgA==","_resolved":"/tmp/f589c2fce5cbb1852cb837f9cc7e5eba/kysely-sequelize-0.1.0.tgz","_from":"file:kysely-sequelize-0.1.0.tgz","_nodeVersion":"18.16.1","_npmVersion":"9.5.1","dist":{"integrity":"sha512-A1/pPfU8zymSR9rxGwqaGfrMvHsMkHlC2hJpOlk/dNfyGsIN35NVrBvelZDYXisZt43lJ7UsvG4vBA1/HyCtgA==","shasum":"51285685cef2e638b795446f9c83d0efeacef73a","tarball":"https://registry.npmjs.org/kysely-sequelize/-/kysely-sequelize-0.1.0.tgz","fileCount":11,"unpackedSize":56161,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDiCUt2UaLkXB1nltJsO7cBvDExQtevKJyCaF/oYH+Z2QIgQA7pLdoguE0JgP5PAUvA1lmKcWcqV5vtb/uUWUTvQdE="}]},"_npmUser":{"name":"igalklebanov","email":"igalklebanov@gmail.com"},"directories":{},"maintainers":[{"name":"igalklebanov","email":"igalklebanov@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/kysely-sequelize_0.1.0_1703292762847_0.9069875754055696"},"_hasShrinkwrap":false},"0.2.0":{"name":"kysely-sequelize","version":"0.2.0","description":"Kysely dialect for Sequelize","repository":{"type":"git","url":"git+https://github.com/igalklebanov/kysely-sequelize.git"},"homepage":"https://github.com/igalklebanov/kysely-sequelize","author":{"name":"Igal Klebanov","email":"igalklebanov@gmail.com"},"license":"MIT","main":"./dist/cjs/index.js","module":"./dist/esm/index.js","exports":{".":{"import":"./dist/esm/index.js","require":"./dist/cjs/index.js"}},"keywords":["kysely","sequelize","postgres","mysql","postgresql","mariadb","sqlite","mssql","dialect"],"peerDependencies":{"kysely":">= 0.24.0 < 1","sequelize":">= 6.0.0 < 7"},"devDependencies":{"@tsconfig/node20":"^20.1.2","@types/chai":"^4.3.4","@types/chai-as-promised":"^7.1.5","@types/chai-subset":"^1.3.3","@types/mocha":"^10.0.1","@types/mocha-each":"^2.0.0","@types/node":"^18.15.11","@types/pg":"^8.10.9","@types/validator":"^13.11.7","@typescript-eslint/eslint-plugin":"^5.57.1","@typescript-eslint/parser":"^5.57.1","chai":"^4.3.7","chai-subset":"^1.6.0","esbuild":"^0.17.15","esbuild-runner":"^2.2.2","eslint":"^8.38.0","eslint-config-prettier":"^8.8.0","eslint-plugin-import":"^2.27.5","eslint-plugin-prettier":"^4.2.1","kysely":"^0.27.3","mariadb":"^3.2.2","mocha":"^10.2.0","mocha-each":"^2.0.1","mysql2":"^3.6.5","pg":"^8.11.3","pg-hstore":"^2.3.4","prettier":"^2.8.7","prettier-plugin-organize-imports":"^3.2.2","prettier-plugin-pkg":"^0.17.1","reflect-metadata":"^0.2.1","sequelize-typescript":"^2.1.6","sqlite3":"^5.1.6","tedious":"^16.6.1","tsd":"^0.30.7","tsup":"^6.7.0","type-fest":"^4.12.0","typescript":"^5.0.4"},"sideEffects":false,"scripts":{"build":"tsup && node ./scripts/dist-fix.js","clean":"rm -rf dist","fmt":"prettier --write .","fmt:check":"prettier --check .","lint":"eslint src --ext .ts","test":"pnpm test:nodejs && pnpm test:typings","test:nodejs":"mocha ./tests/nodejs","test:typings":"tsd tests/typings","type-check":"tsc --noEmit"},"types":"./dist/cjs/index.d.ts","bugs":{"url":"https://github.com/igalklebanov/kysely-sequelize/issues"},"_id":"kysely-sequelize@0.2.0","_integrity":"sha512-ihggiT7rAMv/HumjJOhlra2qYdY0BqGTmHf50sj2hDDy2YR3CysfzNxUWVjdo3ueWAvv7/yDO3f+b1JI94yj+Q==","_resolved":"/tmp/2e818985911c0b7f2a750316d095be8b/kysely-sequelize-0.2.0.tgz","_from":"file:kysely-sequelize-0.2.0.tgz","_nodeVersion":"20.4.0","_npmVersion":"9.7.2","dist":{"integrity":"sha512-ihggiT7rAMv/HumjJOhlra2qYdY0BqGTmHf50sj2hDDy2YR3CysfzNxUWVjdo3ueWAvv7/yDO3f+b1JI94yj+Q==","shasum":"c2e04afd3d7b71850f2a18401b4d93c312674c87","tarball":"https://registry.npmjs.org/kysely-sequelize/-/kysely-sequelize-0.2.0.tgz","fileCount":11,"unpackedSize":69147,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD/4sTx4Hc0MZg8t/qEWp0Hi9kde2A1yVFm+NHgaX+1GAIhAO3TSj2oh67AT4ln6X71YvBpZpiUOt6Ph2VLwrh7OXSE"}]},"_npmUser":{"name":"igalklebanov","email":"igalklebanov@gmail.com"},"directories":{},"maintainers":[{"name":"igalklebanov","email":"igalklebanov@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/kysely-sequelize_0.2.0_1710580753054_0.858558331771835"},"_hasShrinkwrap":false}},"time":{"created":"2023-12-23T00:52:42.846Z","0.1.0":"2023-12-23T00:52:43.003Z","modified":"2024-03-16T09:19:14.052Z","0.2.0":"2024-03-16T09:19:13.238Z"},"maintainers":[{"name":"igalklebanov","email":"igalklebanov@gmail.com"}],"description":"Kysely dialect for Sequelize","homepage":"https://github.com/igalklebanov/kysely-sequelize","keywords":["kysely","sequelize","postgres","mysql","postgresql","mariadb","sqlite","mssql","dialect"],"repository":{"type":"git","url":"git+https://github.com/igalklebanov/kysely-sequelize.git"},"author":{"name":"Igal Klebanov","email":"igalklebanov@gmail.com"},"bugs":{"url":"https://github.com/igalklebanov/kysely-sequelize/issues"},"license":"MIT","readme":"# kysely-sequelize\n\nSequelize is a modern TypeScript and Node.js ORM for Oracle, Postgres, MySQL, MariaDB, SQLite and SQL Server, and more. Featuring solid transaction support, relations, eager and lazy loading, read replication and more.\n\nAs of Mar 16, 2024, Sequelize is gearing up for v7 (currently in alpha) and [has 2,107,202 weekly downloads on npm](https://npmtrends.com/prisma-vs-sequelize-vs-typeorm) (most popular ORM). It is a very popular ORM for Node.js and TypeScript (thanks to `sequelize-typescript`).\n\nJust like most ORMs for Node.js, Sequelize has poor TypeScript support when it comes to writing queries outside of the ORM's CRUD methods - something that happens more often than you might imagine - usually due to performance optimizations OR as a general escape hatch. This is where Kysely comes in.\n\nKysely (pronounced “Key-Seh-Lee”) is a type-safe and autocompletion-friendly TypeScript SQL query builder. Inspired by Knex. Mainly developed for Node.js but also runs on Deno and in the browser.\n\nA match made in heaven, on paper. Let’s see how it works in practice, with `kysely-sequelize` - a toolkit (dialect, type translators, etc.) that allows using your existing Sequelize instance with Kysely.\n\n## Installation\n\nMain dependencies:\n\n```sh\nnpm i kysely kysely-sequelize sequelize sequelize-typescript\n```\n\nPostgreSQL:\n\n```sh\nnpm i pg\n```\n\nMySQL:\n\n```sh\nnpm i mysql2\n```\n\nMS SQL Server (MSSQL):\n\n```sh\nnpm i tedious\n```\n\nSQLite:\n\nATTTENTION: While Kysely supports `better-sqlite3` with its core SQLite dialect, Sequelize uses `sqlite3` under the hood. This library doesn't use Kysely's own drivers.\n\n```sh\nnpm i sqlite3\n```\n\n## Usage\n\n### Models & Types\n\nAs of today, there are two ways to define Sequelize models in TypeScript. This\nlibrary supports both.\n\n#### Sequelize >= v6.14.0\n\nDefine your model with `InferAttributes`, `InferCreationAttributes`, `CreationOptional`, `NonAttribute`, `ForeignKey`, etc.\n\n`src/models/person.model.ts`:\n\n```ts\nimport type {GeneratedAlways} from 'kysely-sequelize'\nimport type {CreationOptional, InferAttributes, InferCreationAttributes, NonAttribute} from 'sequelize'\nimport {Column, DataType, HasMany, Model, Table} from 'sequelize-typescript'\nimport {PetModel} from './pet.model'\n\n@Table({modelName: 'Person', tableName: 'person', timestamps: false, underscored: true})\nexport class PersonModel extends Model<InferAttributes<PersonModel>, InferCreationAttributes<PersonModel>> {\n  declare id: GeneratedAlways<CreationOptional<number>>\n\n  @Column(DataType.STRING(255))\n  firstName: string | null\n\n  @Column(DataType.STRING(255))\n  middleName: string | null\n\n  @Column(DataType.STRING(255))\n  lastName: string | null\n\n  @Column({allowNull: false, type: DataType.STRING(50)})\n  gender: 'male' | 'female' | 'other'\n\n  @Column(DataType.STRING(50))\n  maritalStatus: 'single' | 'married' | 'divorced' | 'widowed' | null\n\n  @HasMany(() => PetModel)\n  pets: NonAttribute<PetModel[]>\n}\n```\n\n`src/models/pet.model.ts`:\n\n```ts\nimport type {CreationOptional, ForeignKey, InferAttributes, InferCreationAttributes, NonAttribute} from 'sequelize'\nimport {BelongsTo, Column, DataType, HasMany, Model, Table} from 'sequelize-typescript'\nimport {PersonModel} from './person.model.js'\nimport {ToyModel} from './toy.model.js'\n\n@Table({\n  modelName: 'Pet',\n  indexes: [{fields: ['owner_id'], name: 'pet_owner_id_index'}],\n  tableName: 'pet',\n  timestamps: false,\n  underscored: true,\n})\nexport class PetModel extends Model<InferAttributes<PetModel>, InferCreationAttributes<PetModel>> {\n  declare id: GeneratedAlways<CreationOptional<number>>\n\n  @Column({allowNull: false, type: DataType.STRING(255)})\n  name: string\n\n  declare ownerId: ForeignKey<number>\n\n  @Column({allowNull: false, type: DataType.STRING(50)})\n  species: 'dog' | 'cat' | 'hamster'\n\n  @BelongsTo(() => PersonModel, 'ownerId')\n  owner: NonAttribute<PersonModel>\n\n  @HasMany(() => ToyModel)\n  toys: NonAttribute<ToyModel[]>\n}\n```\n\n`src/models/toy.model.ts`:\n\n```ts\nimport type {CreationOptional, ForeignKey, InferAttributes, InferCreationAttributes, NonAttribute} from 'sequelize'\nimport {BelongsTo, Column, DataType, Model, Table} from 'sequelize-typescript'\nimport {PetModel} from './pet.model'\n\nexport interface ToyAttributes {\n  id: number\n  name: string\n  price: number\n  petId: number\n}\n\nexport type ToyCreationAttributes = Optional<ToyAttributes, 'id'>\n\n@Table({modelName: 'Toy', tableName: 'toy', timestamps: false, underscored: true})\nexport class ToyModel extends Model<InferAttributes<ToyModel>, InferCreationAttributes<ToyModel>> {\n  declare id: GeneratedAlways<CreationOptional<number>>\n\n  @Column({allowNull: false, type: DataType.STRING(255)})\n  name: string\n\n  declare petId: ForeignKey<number>\n\n  @Column({allowNull: false, type: DataType.DOUBLE})\n  price: number\n\n  @BelongsTo(() => PetModel, 'petId')\n  pet: NonAttribute<PetModel>\n}\n```\n\nUse `KyselifyModel` to transform your Sequelize models into Kysely-compatible table schema.\n\n`src/types/database.ts`:\n\n```ts\nimport type {KyselifyModel} from 'kysely-sequelize'\nimport type {PersonModel, PetModel, ToyModel} from '../models'\n\nexport type PersonTable = KyselifyModel<PersonModel>\n//              ^? { id: GeneratedAlways<number>, firstName: string | null, ... }\nexport type PetTable = KyselifyModel<PetCreationAttributes>\nexport type ToyTable = KyselifyModel<ToyCreationAttributes>\n\nexport interface Database {\n  person: PersonTable\n  pet: PetTable\n  toy: ToyTable\n}\n```\n\n#### Sequelize < v6.14.0 (the old verbose way)\n\nDefine your models using `sequelize-typescript` and manual attribute typing.\n\n`src/models/person.model.ts`:\n\n```ts\nimport type {Optional} from 'sequelize'\nimport {Column, DataType, HasMany, Model, Table} from 'sequelize-typescript'\nimport {PetModel} from './pet.model'\n\nexport interface PersonAttributes {\n  id: number\n  firstName: string | null\n  middleName: string | null\n  lastName: string | null\n  gender: 'male' | 'female' | 'other'\n  maritalStatus: 'single' | 'married' | 'divorced' | 'widowed' | null\n}\n\nexport type PersonCreationAttributes = Optional<PersonAttributes, 'id'>\n\n@Table({modelName: 'Person', tableName: 'person', timestamps: false, underscored: true})\nexport class PersonModel extends Model<PersonAttributes, PersonCreationAttributes> {\n  declare id: PersonAttributes['id']\n\n  @Column(DataType.STRING(255))\n  firstName: PersonAttributes['firstName']\n\n  @Column(DataType.STRING(255))\n  middleName: PersonAttributes['middleName']\n\n  @Column(DataType.STRING(255))\n  lastName: PersonAttributes['lastName']\n\n  @Column({allowNull: false, type: DataType.STRING(50)})\n  gender: PersonAttributes['gender']\n\n  @Column(DataType.STRING(50))\n  maritalStatus: PersonAttributes['maritalStatus']\n\n  @HasMany(() => PetModel)\n  pets: PetModel[]\n}\n```\n\n`src/models/pet.model.ts`:\n\n```ts\nimport type {Optional} from 'sequelize'\nimport {BelongsTo, Column, DataType, ForeignKey, HasMany, Model, Table} from 'sequelize-typescript'\nimport {PersonModel} from './person.model.js'\nimport {ToyModel} from './toy.model.js'\n\nexport interface PetAttributes {\n  id: number\n  name: string\n  ownerId: number\n  species: 'dog' | 'cat' | 'hamster'\n}\n\nexport type PetCreationAttributes = Optional<PetAttributes, 'id'>\n\n@Table({\n  modelName: 'Pet',\n  indexes: [{fields: ['owner_id'], name: 'pet_owner_id_index'}],\n  tableName: 'pet',\n  timestamps: false,\n  underscored: true,\n})\nexport class PetModel extends Model<PetAttributes, PetCreationAttributes> {\n  declare id: PetAttributes['id']\n\n  @Column({allowNull: false, type: DataType.STRING(255)})\n  name: PetAttributes['name']\n\n  @Column({allowNull: false, onDelete: 'CASCADE', type: DataType.INTEGER})\n  @ForeignKey(() => PersonModel)\n  ownerId: PetAttributes['ownerId']\n\n  @Column({allowNull: false, type: DataType.STRING(50)})\n  species: PetAttributes['species']\n\n  @BelongsTo(() => PersonModel)\n  owner: PersonModel\n\n  @HasMany(() => ToyModel)\n  toys: ToyModel[]\n}\n```\n\n`src/models/toy.model.ts`:\n\n```ts\nimport type {Optional} from 'sequelize'\nimport {BelongsTo, Column, DataType, ForeignKey, Model, Table} from 'sequelize-typescript'\nimport {PetModel} from './pet.model'\n\nexport interface ToyAttributes {\n  id: number\n  name: string\n  price: number\n  petId: number\n}\n\nexport type ToyCreationAttributes = Optional<ToyAttributes, 'id'>\n\n@Table({modelName: 'Toy', tableName: 'toy', timestamps: false, underscored: true})\nexport class ToyModel extends Model<ToyAttributes, ToyCreationAttributes> {\n  declare id: ToyAttributes['id']\n\n  @Column({allowNull: false, type: DataType.STRING(255)})\n  name: ToyAttributes['name']\n\n  @Column({allowNull: false, type: DataType.INTEGER})\n  @ForeignKey(() => PetModel)\n  petId: ToyAttributes['petId']\n\n  @Column({allowNull: false, type: DataType.DOUBLE})\n  price: ToyAttributes['price']\n\n  @BelongsTo(() => PetModel)\n  pet: PetModel\n}\n```\n\nUse `KyselifyCreationAttributes` to transform your Sequelize models' attributes into Kysely-compatible types.\n\n`src/types/database.ts`:\n\n```ts\nimport type {KyselifyCreationAttributes} from 'kysely-sequelize'\nimport type {PersonCreationAttributes, PetCreationAttributes, ToyCreationAttributes} from '../models'\n\nexport type PersonTable = KyselifyCreationAttributes<PersonCreationAttributes>\n//              ^? { id: GeneratedAlways<number>, firstName: string | null, ... }\nexport type PetTable = KyselifyCreationAttributes<PetCreationAttributes>\nexport type ToyTable = KyselifyCreationAttributes<ToyCreationAttributes>\n\nexport interface Database {\n  person: PersonTable\n  pet: PetTable\n  toy: ToyTable\n}\n```\n\n### Sequelize Instance\n\nCreate a Sequelize instance.\n\n`src/sequelize.ts`:\n\n```ts\nimport {Sequelize} from 'sequelize-typescript'\nimport {PersonModel, PetModel, ToyModel} from './models'\n\nlet sequelize: Sequelize\n\nasync function getSequelize(): Promise<Sequelize> {\n  if (sequelize) {\n    return sequelize\n  }\n\n  // this create a new Sequelize instance for Postgres\n  // kysely-sequelize also supports MySQL, SQLite, and MS SQL Server.\n  const sqlz = new Sequelize({\n    database: '{{database}}',\n    dialect: 'postgres',\n    host: '{{host}}',\n    models: [PersonModel, PetModel, ToyModel],\n    pool: {max: 20, min: 0},\n    port: 5434,\n    username: '{{username}}',\n  })\n\n  await sqlz.authenticate({\n    retry: {\n      backoffBase: 1_000,\n      backoffExponent: 1,\n      max: (5 * 60 * 1_000) / 5,\n      timeout: 5 * 60 * 1_000,\n    },\n  })\n\n  await sequelize.sync()\n\n  sequelize = sqlz\n}\n```\n\n### Kysely Instance\n\nCreate a Kysely instance.\n\n`src/kysely.ts`:\n\n```ts\nimport {CamelCasePlugin, Kysely, PostgresAdapter, PostgresIntrospector, PostgresQueryCompiler} from 'kysely'\nimport {KyselySequelizeDialect} from 'kysely-sequelize'\nimport type {Database} from './types/database'\n\nlet kysely: Kysely<Database>\n\nasync function getKysely(): Promise<Kysely<Database>> {\n  if (kysely) {\n    return kysely\n  }\n\n  const sequelize = await getSequelize()\n\n  kysely = new Kysely<Database>({\n    dialect: new KyselySequelizeDialect({\n      // kysely-sequelize also supports MySQL, SQLite, and MS SQL Server.\n      // Since Kysely's MS SQL Server dialect is unreleased, you'll have to install Kysely directly from Github for now.\n      kyselyDialect: {\n        createAdapter: () => PostgresAdapter(),\n        createIntrospector: (db) => new PostgresIntrospector(db),\n        createQueryCompiler: () => new PostgresQueryCompiler(),\n      },\n      sequelize,\n    }),\n    // `CamelCasePlugin` is used to align with Sequelize's `underscored` option.\n    plugins: [new CamelCasePlugin()],\n  })\n\n  return kysely\n}\n```\n","readmeFilename":"README.md"}