@payloadcms/db-mongodb

Payload MongoDB Adapter

Official MongoDB adapter for Payload.

• Main Repository
• Payload Docs

Installation

npm install @payloadcms/db-mongodb

Usage

import { buildConfig } from 'payload/config'
import { mongooseAdapter } from '@payloadcms/db-mongodb'

export default buildConfig({
  db: mongooseAdapter({
    url: process.env.DATABASE_URI,
  }),
  // ...rest of config
})

More detailed usage can be found in the Payload Docs.

Changelog

1.2.0 (2022-11-18)

🐛 Bug Fixes

• build errors (65f0e1c)
• components optional chaining (d5e725c)
• corrects exported custom component type (2878b4b)
• corrects type for CollapsibleLabel example type, adjusts custom component filenames (ccb4231)
• sets pointer-events to none so the entire label bar is clickable (e458087)

✨ Features

• add i18n to admin panel (#1326) (bab34d8)
• adds docs example (2bf0fff)
• adds playwright tests for array fields (57a8c35)
• converts rowHeader to collapsibleLabel, extends data passed to functions/components (13ec1e0)
• customizable header-labels (d45de99)
• simplifies collapsible label API, adds e2e tests (d9df98f)
• specifies component names for arrays/collapsibles, simplifies threaded data (b74ea21)

🚨 BREAKING CHANGES

• You might need to update your config. This change affects collections, globals and block fields with custom labeling.

  • Collections: are affected if you have a custom labels.singular defined that differs from your collection slug.

    // ExampleCollection.ts
    
    // Before
    const ExampleCollection: CollectionConfig = {
      slug: 'case-studies',
      labels: {
        // Before Payload used `labels.singular` to generate types/graphQL schema
        singular: 'Project',
        plural: 'Projects',
      },
    }
    
    // After
    const ExampleCollection: CollectionConfig = {
      // Now Payload uses `slug` to generate types/graphQL schema
      slug: 'case-studies',
      labels: {
        singular: 'Project',
        plural: 'Projects',
      },
      // To override the usage of slug in graphQL schema generation
      graphQL: {
        singularName: 'Project',
        pluralName: 'Projects',
      },
      // To override the usage of slug in type file generation
      typescript: {
        interface: 'Project',
      },
    }
    

  • Globals: are affected if you have a label defined that differs from your global slug.

    // ExampleGlobal.ts
    
    // Before
    const ExampleGlobal: GlobalConfig = {
      slug: 'footer',
      // Before Payload used `label` to generate types/graphQL schema
      label: 'Page Footer',
    }
    
    // After
    const ExampleGlobal: GlobalConfig = {
      // Now Payload uses `slug` to generate types/graphQL schema
      slug: 'footer',
      label: 'Page Footer',
      // To override the usage of slug in graphQL schema generation
      graphQL: {
        name: 'PageFooter',
      },
      // To override the usage of slug in type file generation
      typescript: {
        interface: 'PageFooter',
      },
    }
    

  • Block Fields: are affected if you have a label defined that differs from your block slug.

    // ExampleBlock.ts
    
        // Before
        const ExampleBlock: Block = {
          slug: 'content',
          // Before Payload used `label` to generate graphQL schema
          label: 'Content Block',
        }
    
        // After
        const ExampleBlock: Block = {
          // Now Payload uses `slug` to generate graphQL schema
          slug: 'content',
          label: 'Content Block',
          // To override the usage of slug in graphQL schema generation
          graphQL: {
            singularName: 'ContentBlock',
          },
        }
        ```
    
    **Breaking changes recap**:
    

• On Collections

  • Use graphQL.singularName, graphQL.pluralName for GraphQL schema names.
  • Use typescript.interface for typescript generation name.

• On Globals

  • Use graphQL.name for GraphQL Schema name.
  • Use typescript.interface for typescript generation name.

• On Blocks (within Block fields)

  • Use graphQL.singularName for graphQL schema names.