Custom Database Adapter

[dignifiedprediction]

Documentation Issue

I want to create a custom payload database adapter, but I could not find anything about it in the database documentation, although there is a guide for custom storage adapters. Am I missing something? Is there a minimum interface that needs to be implemented ? Say, select insert select where delete, or equivalent NoSQL interfaces etc?

Additional Details

(Specifically I want to use Iroh, but I'm not asking for help with Iroh)

I can see the following being exported from db-mongodb/dist/index.js. Maybe thats a good place to start. Src is in db-mongodb/src

            beginTransaction: transactionOptions === false ? defaultBeginTransaction() : beginTransaction,
            collectionsSchemaOptions,
            commitTransaction,
            connect,
            count,
            countGlobalVersions,
            countVersions,
            create,
            createGlobal,
            createGlobalVersion,
            createMigration,
            createVersion,
            defaultIDType: 'text',
            deleteMany,
            deleteOne,
            deleteVersions,
            destroy,
            find,
            findGlobal,
            findGlobalVersions,
            findOne,
            findVersions,
            init,
            migrateFresh,
            migrationDir,
            packageName: '@payloadcms/db-mongodb',
            payload,
            prodMigrations,
            queryDrafts,
            rollbackTransaction,
            updateGlobal,
            updateGlobalVersion,
            updateOne,
            updateVersion,
            upsert

[yunus-emre-zengin]

You can check this file to get an idea about the DatabaseAdapter interface.
https://github.com/payloadcms/payload/blob/main/packages/payload/src/database/types.ts

[paulpopus]

Yep that file above is a good starting spot!

These are the types that the config requires, should give you a clear outline for what's needed and then yeah you can use the mongodb as inspiration since that one is encapsulated. pg and sqlite ones use our drizzle package as a base.

If you set up your adapter within a fork of our repo you could also run our int tests against your db adapter with some custom setup if you wanted to make sure you've got test coverage!

Let us know if you have any more questions around this topic, it's not a lightweight undertaking at all so good luck

[github-actions]

This issue has been automatically locked.
Please open a new issue if this issue persists with any additional detail.