SQLとORM

SQLデータベースは、アプリケーションのデータを永続的なストレージに保存するためによく使われます。AdonisJSアプリケーション内でSQLクエリを実行するために、任意のライブラリやORMを使用できます。

AdonisJSコアチームはLucid ORMを開発しましたが、強制的に使用することはありません。AdonisJSアプリケーション内で他のSQLライブラリやORMを使用することもできます。

他のSQLライブラリとORMの使用

もう1つのSQLライブラリやORMを使用する場合、いくつかのパッケージの設定を手動で変更する必要があります。

認証

AdonisJSの認証モジュールは、認証されたユーザーを取得するためにLucidを使用する機能を備えています。他のSQLライブラリやORMを使用する場合は、ユーザーを取得するためにSessionUserProviderContractまたはAccessTokensProviderContractインターフェイスを実装する必要があります。

これは、Kyselyを使用する場合にSessionUserProviderContractインターフェイスを実装する方法の例です。

import { symbols } from '@adonisjs/auth'
import type { SessionGuardUser, SessionUserProviderContract } from '@adonisjs/auth/types/session'
import type { Users } from '../../types/db.js' // Specific to Kysely

export class SessionKyselyUserProvider implements SessionUserProviderContract<Users> {
  /**
   * Used by the event emitter to add type information to the events emitted by the session guard.
   */   
  declare [symbols.PROVIDER_REAL_USER]: Users

  /**
   * Bridge between the session guard and your provider.
   */
  async createUserForGuard(user: Users): Promise<SessionGuardUser<Users>> {
    return {
      getId() {
        return user.id
      },
      getOriginal() {
        return user
      },
    }
  }

  /**
   * Find a user using the user id using your custom SQL library or ORM.
   */
  async findById(identifier: number): Promise<SessionGuardUser<Users> | null> {
    const user = await db
      .selectFrom('users')
      .selectAll()
      .where('id', '=', identifier)
      .executeTakeFirst()

    if (!user) {
      return null
    }

    return this.createUserForGuard(user)
  }
}

UserProviderインターフェイスを実装したら、設定内でそれを使用できます。

const authConfig = defineConfig({
  default: 'web',

  guards: {
    web: sessionGuard({
      useRememberMeTokens: false,
      provider: sessionUserProvider({
        model: () => import('#models/user'),
      }),
      
      provider: configProvider.create(async () => {
        const { SessionKyselyUserProvider } = await import(
          '../app/auth/session_user_provider.js' // Path to the file
        )

        return new SessionKyselyUserProvider()
      }),
    }),
  },
})

基本

静的ファイルサーバー

データベース

Lucid

SQLとORM

人気のあるオプション

他のSQLライブラリとORMの使用

認証

On this page