diff --git a/packages/db-example/.eslintignore b/examples/db-example/.eslintignore similarity index 100% rename from packages/db-example/.eslintignore rename to examples/db-example/.eslintignore diff --git a/packages/db-example/.eslintrc.js b/examples/db-example/.eslintrc.js similarity index 100% rename from packages/db-example/.eslintrc.js rename to examples/db-example/.eslintrc.js diff --git a/packages/db-example/.gitignore b/examples/db-example/.gitignore similarity index 100% rename from packages/db-example/.gitignore rename to examples/db-example/.gitignore diff --git a/packages/db-example/.prettierignore b/examples/db-example/.prettierignore similarity index 100% rename from packages/db-example/.prettierignore rename to examples/db-example/.prettierignore diff --git a/packages/db-example/.swcrc b/examples/db-example/.swcrc similarity index 100% rename from packages/db-example/.swcrc rename to examples/db-example/.swcrc diff --git a/packages/db-example/README.md b/examples/db-example/README.md similarity index 51% rename from packages/db-example/README.md rename to examples/db-example/README.md index 5c14ab52f7..e1a6b17863 100644 --- a/packages/db-example/README.md +++ b/examples/db-example/README.md @@ -3,6 +3,12 @@ - [Main Repository](https://github.com/payloadcms/payload) - [Payload Docs](https://payloadcms.com/docs) +To build a fully working database adapter for Payload you must implement the database adapter interface. There is a mix +of required and not required methods depending on the areas you need to support. Payload will call the adapter's `init` +function followed by the `connect` method if it exists. The adapter must create any schema necessary on the target +database in the init function. The adapter can be extended as needed to keep track of models for collections and other +artifacts necessary to perform all the needed operations. + ## Installation ```bash diff --git a/packages/db-example/package.json b/examples/db-example/package.json similarity index 56% rename from packages/db-example/package.json rename to examples/db-example/package.json index 95b1067617..8baf5f594a 100644 --- a/packages/db-example/package.json +++ b/examples/db-example/package.json @@ -6,7 +6,7 @@ "repository": { "type": "git", "url": "https://github.com/payloadcms/payload.git", - "directory": "packages/db-example" + "directory": "examples/db-example" }, "license": "MIT", "homepage": "https://payloadcms.com", @@ -25,34 +25,16 @@ "prepublishOnly": "pnpm clean && pnpm build" }, "dependencies": { - "bson-objectid": "2.0.4", - "deepmerge": "4.3.1", - "get-port": "5.1.1", - "mongoose": "6.12.3", - "mongoose-aggregate-paginate-v2": "1.0.6", - "mongoose-paginate-v2": "1.7.22", - "prompts": "2.4.2", - "http-status": "1.6.2", - "uuid": "9.0.0" }, "devDependencies": { - "@payloadcms/eslint-config": "workspace:*", - "@types/mongoose-aggregate-paginate-v2": "1.0.9", - "mongodb": "4.17.1", - "mongodb-memory-server": "^9", - "payload": "workspace:*" + "@payloadcms/eslint-config": "^1.1.1", + "payload": "^2.18.3", + "rimraf": "^4.1.2" }, "peerDependencies": { "payload": "^2.0.0" }, - "publishConfig": { - "main": "./dist/index.js", - "registry": "https://registry.npmjs.org/", - "types": "./dist/index.d.ts" - }, "files": [ - "dist", - "mock.js", - "predefinedMigrations" + "dist" ] } diff --git a/packages/db-example/src/connect.ts b/examples/db-example/src/connect.ts similarity index 100% rename from packages/db-example/src/connect.ts rename to examples/db-example/src/connect.ts diff --git a/packages/db-example/src/count.ts b/examples/db-example/src/count.ts similarity index 100% rename from packages/db-example/src/count.ts rename to examples/db-example/src/count.ts diff --git a/packages/db-example/src/create.ts b/examples/db-example/src/create.ts similarity index 100% rename from packages/db-example/src/create.ts rename to examples/db-example/src/create.ts diff --git a/packages/db-example/src/createGlobal.ts b/examples/db-example/src/createGlobal.ts similarity index 100% rename from packages/db-example/src/createGlobal.ts rename to examples/db-example/src/createGlobal.ts diff --git a/packages/db-example/src/createGlobalVersion.ts b/examples/db-example/src/createGlobalVersion.ts similarity index 100% rename from packages/db-example/src/createGlobalVersion.ts rename to examples/db-example/src/createGlobalVersion.ts diff --git a/packages/db-example/src/createVersion.ts b/examples/db-example/src/createVersion.ts similarity index 100% rename from packages/db-example/src/createVersion.ts rename to examples/db-example/src/createVersion.ts diff --git a/packages/db-example/src/deleteMany.ts b/examples/db-example/src/deleteMany.ts similarity index 100% rename from packages/db-example/src/deleteMany.ts rename to examples/db-example/src/deleteMany.ts diff --git a/packages/db-example/src/deleteOne.ts b/examples/db-example/src/deleteOne.ts similarity index 100% rename from packages/db-example/src/deleteOne.ts rename to examples/db-example/src/deleteOne.ts diff --git a/packages/db-example/src/deleteVersions.ts b/examples/db-example/src/deleteVersions.ts similarity index 100% rename from packages/db-example/src/deleteVersions.ts rename to examples/db-example/src/deleteVersions.ts diff --git a/packages/db-example/src/destroy.ts b/examples/db-example/src/destroy.ts similarity index 100% rename from packages/db-example/src/destroy.ts rename to examples/db-example/src/destroy.ts diff --git a/packages/db-example/src/errors/handleError.ts b/examples/db-example/src/errors/handleError.ts similarity index 100% rename from packages/db-example/src/errors/handleError.ts rename to examples/db-example/src/errors/handleError.ts diff --git a/packages/db-example/src/find.ts b/examples/db-example/src/find.ts similarity index 100% rename from packages/db-example/src/find.ts rename to examples/db-example/src/find.ts diff --git a/packages/db-example/src/findGlobal.ts b/examples/db-example/src/findGlobal.ts similarity index 100% rename from packages/db-example/src/findGlobal.ts rename to examples/db-example/src/findGlobal.ts diff --git a/packages/db-example/src/findGlobalVersions.ts b/examples/db-example/src/findGlobalVersions.ts similarity index 100% rename from packages/db-example/src/findGlobalVersions.ts rename to examples/db-example/src/findGlobalVersions.ts diff --git a/packages/db-example/src/findOne.ts b/examples/db-example/src/findOne.ts similarity index 100% rename from packages/db-example/src/findOne.ts rename to examples/db-example/src/findOne.ts diff --git a/packages/db-example/src/findVersions.ts b/examples/db-example/src/findVersions.ts similarity index 100% rename from packages/db-example/src/findVersions.ts rename to examples/db-example/src/findVersions.ts diff --git a/packages/db-example/src/index.ts b/examples/db-example/src/index.ts similarity index 100% rename from packages/db-example/src/index.ts rename to examples/db-example/src/index.ts diff --git a/packages/db-example/src/init.ts b/examples/db-example/src/init.ts similarity index 100% rename from packages/db-example/src/init.ts rename to examples/db-example/src/init.ts diff --git a/packages/db-example/src/queryDrafts.ts b/examples/db-example/src/queryDrafts.ts similarity index 100% rename from packages/db-example/src/queryDrafts.ts rename to examples/db-example/src/queryDrafts.ts diff --git a/packages/db-example/src/transactions/beginTransaction.ts b/examples/db-example/src/transactions/beginTransaction.ts similarity index 100% rename from packages/db-example/src/transactions/beginTransaction.ts rename to examples/db-example/src/transactions/beginTransaction.ts diff --git a/packages/db-example/src/transactions/commitTransaction.ts b/examples/db-example/src/transactions/commitTransaction.ts similarity index 100% rename from packages/db-example/src/transactions/commitTransaction.ts rename to examples/db-example/src/transactions/commitTransaction.ts diff --git a/packages/db-example/src/transactions/rollbackTransaction.ts b/examples/db-example/src/transactions/rollbackTransaction.ts similarity index 100% rename from packages/db-example/src/transactions/rollbackTransaction.ts rename to examples/db-example/src/transactions/rollbackTransaction.ts diff --git a/packages/db-example/src/updateGlobal.ts b/examples/db-example/src/updateGlobal.ts similarity index 100% rename from packages/db-example/src/updateGlobal.ts rename to examples/db-example/src/updateGlobal.ts diff --git a/packages/db-example/src/updateGlobalVersion.ts b/examples/db-example/src/updateGlobalVersion.ts similarity index 100% rename from packages/db-example/src/updateGlobalVersion.ts rename to examples/db-example/src/updateGlobalVersion.ts diff --git a/packages/db-example/src/updateOne.ts b/examples/db-example/src/updateOne.ts similarity index 100% rename from packages/db-example/src/updateOne.ts rename to examples/db-example/src/updateOne.ts diff --git a/packages/db-example/src/updateVersion.ts b/examples/db-example/src/updateVersion.ts similarity index 100% rename from packages/db-example/src/updateVersion.ts rename to examples/db-example/src/updateVersion.ts diff --git a/packages/db-example/tsconfig.json b/examples/db-example/tsconfig.json similarity index 100% rename from packages/db-example/tsconfig.json rename to examples/db-example/tsconfig.json