mirror of
https://github.com/SrIzan10/next-auth.git
synced 2026-05-01 10:55:20 +00:00
cb56cd44ca
* docs: beta initial commit * docs(oauth): finish initial tutorial * docs(oauth-tutorial): finish guide * docs(docusaurus): just log broken links * docs: re-organising beta * docs(beta): sort documents for sorting * docs: more re-structure * docs: more re-structure (2) * fix: more WIP * fix: more WIP * chore: more updates * chore: wip * chore: wip * fix lock file * docs(getting-started): credentials * chore: remove json-server file * chore: cleanup * remove mongodb from dev app * chore: cleanup * revert * chore: cleanup * chore: more cleanup changes Co-authored-by: Balázs Orbán <info@balazsorban.com>
89 lines
2.6 KiB
Markdown
89 lines
2.6 KiB
Markdown
---
|
|
id: sequelize
|
|
title: Sequelize
|
|
---
|
|
|
|
# Sequelize
|
|
|
|
This is the Sequelize Adapter for [`next-auth`](https://next-auth.js.org).
|
|
|
|
## Getting Started
|
|
|
|
1. Install the necessary packages
|
|
|
|
```bash npm2yarn
|
|
npm install next-auth @next-auth/sequelize-adapter sequelize
|
|
```
|
|
|
|
:::warning
|
|
You'll also have to manually install [the driver for your database](https://sequelize.org/master/manual/getting-started.html) of choice.
|
|
:::
|
|
|
|
2. Add this adapter to your `pages/api/[...nextauth].js` next-auth configuration object.
|
|
|
|
```javascript title="pages/api/auth/[...nextauth].js"
|
|
import NextAuth from "next-auth"
|
|
import SequelizeAdapter from "@next-auth/sequelize-adapter"
|
|
import { Sequelize } from "sequelize"
|
|
|
|
// https://sequelize.org/master/manual/getting-started.html#connecting-to-a-database
|
|
const sequelize = new Sequelize("yourconnectionstring")
|
|
|
|
// For more information on each option (and a full list of options) go to
|
|
// https://next-auth.js.org/configuration/options
|
|
export default NextAuth({
|
|
// https://next-auth.js.org/providers/overview
|
|
providers: [],
|
|
adapter: SequelizeAdapter(sequelize),
|
|
})
|
|
```
|
|
|
|
## Updating the database schema
|
|
|
|
By default, the sequelize adapter will not create tables in your database. In production, best practice is to create the [required tables](https://next-auth.js.org/adapters/models) in your database via [migrations](https://sequelize.org/master/manual/migrations.html). In development, you are able to call [`sequelize.sync()`](https://sequelize.org/master/manual/model-basics.html#model-synchronization) to have sequelize create the necessary tables, foreign keys and indexes:
|
|
|
|
> This schema is adapted for use in Sequelize and based upon our main [schema](/adapters/models)
|
|
|
|
```js
|
|
import NextAuth from "next-auth"
|
|
import SequelizeAdapter from "@next-auth/sequelize-adapter"
|
|
import Sequelize from 'sequelize'
|
|
|
|
const sequelize = new Sequelize("sqlite::memory:")
|
|
const adapter = SequelizeAdapter(sequelize)
|
|
|
|
// Calling sync() is not recommended in production
|
|
sequelize.sync()
|
|
|
|
export default NextAuth({
|
|
...
|
|
adapter
|
|
...
|
|
})
|
|
```
|
|
|
|
## Using custom models
|
|
|
|
Sequelize models are option to customization like so:
|
|
|
|
```js
|
|
import NextAuth from "next-auth"
|
|
import SequelizeAdapter, { models } from "@next-auth/sequelize-adapter"
|
|
import Sequelize, { DataTypes } from "sequelize"
|
|
|
|
const sequelize = new Sequelize("sqlite::memory:")
|
|
|
|
export default NextAuth({
|
|
// https://next-auth.js.org/providers/overview
|
|
providers: [],
|
|
adapter: SequelizeAdapter(sequelize, {
|
|
models: {
|
|
User: sequelize.define("user", {
|
|
...models.User,
|
|
phoneNumber: DataTypes.STRING,
|
|
}),
|
|
},
|
|
}),
|
|
})
|
|
```
|