https://github.com/floydspace/prisma-sequelize-generator

🏳️‍🌈⃤ Sequelize models generator for prisma schema
https://github.com/floydspace/prisma-sequelize-generator

code-generation generator prisma prisma-client prisma2 sequelize sequelize-models sequelize-orm typescript

Last synced: 3 months ago
JSON representation

🏳️‍🌈⃤ Sequelize models generator for prisma schema

• Host: GitHub
• URL: https://github.com/floydspace/prisma-sequelize-generator
• Owner: floydspace
• License: mit
• Created: 2021-08-17T22:00:09.000Z (about 3 years ago)
• Default Branch: beta
• Last Pushed: 2021-09-17T09:39:43.000Z (about 3 years ago)
• Last Synced: 2024-04-14T05:33:10.505Z (7 months ago)
• Topics: code-generation, generator, prisma, prisma-client, prisma2, sequelize, sequelize-models, sequelize-orm, typescript
• Language: TypeScript
• Homepage:
• Size: 187 KB
• Stars: 14
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-prisma - prisma-sequelize-generator

README

        
# 🏳️‍🌈⃤ Prisma Sequelize Generator

A generator, which takes a Prisma 2 `schema.prisma` and generates Sequelize Models.

[![Generic badge](https://img.shields.io/badge/Generator%20for-◭%20Prisma-9F7AEA.svg)](https://www.prisma.io)

[![npm version](https://img.shields.io/npm/v/prisma-sequelize-generator?label=npm%20package)](https://www.npmjs.com/package/prisma-sequelize-generator)

[![npm downloads](https://img.shields.io/npm/dm/prisma-sequelize-generator)](https://www.npmjs.com/package/prisma-sequelize-generator)

[![build status](https://img.shields.io/github/workflow/status/floydspace/prisma-sequelize-generator/release)](https://github.com/floydspace/prisma-sequelize-generator/actions/workflows/release.yml)

[![Code QL](https://github.com/floydspace/prisma-sequelize-generator/workflows/CodeQL/badge.svg)](https://github.com/floydspace/prisma-sequelize-generator/actions/workflows/codeql-analysis.yml)

[![Coverage Status](https://coveralls.io/repos/github/floydspace/prisma-sequelize-generator/badge.svg?branch=beta)](https://coveralls.io/github/floydspace/prisma-sequelize-generator?branch=beta)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![GitHub license](https://img.shields.io/github/license/Naereen/StrapDown.js.svg)](https://github.com/floydspace/prisma-sequelize-generator/blob/master/LICENSE)

## Getting Started

### 1. Install

npm:

```shell

npm install prisma-sequelize-generator --save-dev

```

yarn:

```shell

yarn add -D prisma-sequelize-generator

```

### 2. Add the generator to the schema

```prisma

generator client {

  provider = "prisma-sequelize-generator"

}

```

With a custom output path (`./sequelize` - default)

```prisma

generator client {

  provider = "prisma-sequelize-generator"

  output = "custom-output-path"

}

```

Additional options

```prisma

generator client {

  provider = "prisma-sequelize-generator"

  outputFormat = "typescript"

}

```

Supported output formats are `javascript` (alias `js` - default) and `typescript` (alias `ts`).

### 3. Run generation

prisma:

```shell

prisma generate

```

### 3. Use Sequelize Models to interact with your database

```typescript

import { createSequelizeInstance } from './prisma/sequelize';

const { sequelize, models } = createSequelizeInstance({

  ssl: true,

  dialectOptions: {

    connectTimeout: 1000,

  },

});

// use `sequelize` instance and `models` in your application to read and write data in your DB

```

No need to set a connection string, it is set form the `datasource` configuration in your `schema.prisma` by default.

## Supported Node Versions

|         Node Version | Support            |

| -------------------: | :----------------- |

| (Maintenance LTS) 12 | :heavy_check_mark: |

|      (Active LTS) 14 | :heavy_check_mark: |

|         (Current) 16 | :heavy_check_mark: |