集合配置

Collection（集合）是一组共享相同 schema 的记录，称为 Document（文档）。你可以根据应用需求定义任意数量的 Collections。每个 Collection 中的 Document 都会基于你定义的 Fields 存储在 Database 中，并自动生成用于管理文档的 Local API、REST API 和 GraphQL API。

Collections 也用于实现 Payload 中的 Authentication。通过定义带有 auth 选项的 Collection，该 Collection 将获得支持用户认证的额外操作。

Collections 是构建应用中重复数据的主要方式，例如用户、产品、页面、文章以及其他你可能需要管理的内容类型。每个 Collection 都可以拥有自己独特的 Access Control、Hooks、Admin Options 等功能。

要定义 Collection Config，请在你的 Payload Config 中使用 collection 属性：

import { buildConfig } from 'payload'

export default buildConfig({
  // ...
  collections: [
    // highlight-line
    // 你的 Collections 定义在这里
  ],
})

配置选项

最佳实践通常是将你的 Collections 写在单独的文件中，然后导入到主 Payload 配置 中。

以下是一个简单的 Collection 配置示例：

import type { CollectionConfig } from 'payload'

export const Posts: CollectionConfig = {
  slug: 'posts',
  fields: [
    {
      name: 'title',
      type: 'text',
    },
  ],
}

以下是可用的配置选项：

* 星号表示该属性是必填项。

字段

Fields（字段）定义了 Collection 中 Documents 的数据结构。要了解更多信息，请参阅 Fields 文档。

访问控制

Collection Access Control（集合访问控制）决定了用户可以对 Collection 中的任何给定 Document 执行哪些操作。要了解更多信息，请参阅 Access Control 文档。

钩子

Collection Hooks（集合钩子）允许你挂接到 Documents 的生命周期中，从而在特定事件期间执行自定义逻辑。要了解更多信息，请参阅 Hooks 文档。

管理选项

Admin Panel 中的 Collections 行为可以完全自定义，以满足你的应用需求。这包括分组或隐藏导航链接、添加自定义组件、选择在列表视图中显示哪些字段等。

要为 Collections 配置管理选项，请在 Collection Config 中使用 admin 属性：

import type { CollectionConfig } from 'payload'

export const MyCollection: CollectionConfig = {
  // ...
  admin: {
    // highlight-line
    // ...
  },
}

可用选项如下：

自定义组件

Collections（集合）可以设置自己的自定义组件，这些组件仅适用于Admin Panel中特定于集合的UI界面。这包括诸如保存按钮等元素，或者整个布局如编辑视图。

要覆盖集合组件，可以在集合配置中使用 admin.components 属性：

import type { CollectionConfig } from 'payload'

export const MyCollection: CollectionConfig = {
  // ...
  admin: {
    components: {
      // highlight-line
      // ...
    },
  },
}

以下是可用的配置选项：

编辑视图选项

import type { CollectionConfig } from 'payload'

export const MyCollection: CollectionConfig = {
  // ...
  admin: {
    components: {
      edit: {
        // highlight-line
        // ...
      },
    },
  },
}

以下是可用的选项：

分页

所有 Collections 都会获得自己的列表视图(List View)，该视图显示可分页、可排序和可筛选的文档列表。列表视图的分页行为可以针对每个 Collection 进行自定义，并使用 Payload 提供的相同 Pagination API。

要配置分页选项，可以在 Collection Config 中使用 admin.pagination 属性：

import type { CollectionConfig } from 'payload'

export const Posts: CollectionConfig = {
  // ...
  admin: {
    // highlight-start
    pagination: {
      defaultLimit: 10,
      limits: [10, 20, 50],
    },
    // highlight-end
  },
}

可用的配置选项如下：

可搜索字段列表

在列表视图(List View)中，有一个"搜索"框允许你通过简单的文本搜索快速查找文档。默认情况下，它会搜索 ID 字段。如果定义了 admin.useAsTitle 字段，则会使用该字段。或者，你可以根据应用需求明确指定要搜索的字段。

要定义哪些字段应该被搜索，可以在 Collection Config 中使用 admin.listSearchableFields 属性：

import type { CollectionConfig } from 'payload'

export const Posts: CollectionConfig = {
  // ...
  admin: {
    // highlight-start
    listSearchableFields: ['title', 'slug'],
    // highlight-end
  },
}

GraphQL

你可以通过在 collection 配置中设置 graphQL: false 来完全禁用该 collection 的 GraphQL 功能。这将完全禁用所有对应的查询(query)、变更(mutation)和类型(type)出现在 GraphQL 模式中。

你也可以向 collection 的 graphQL 属性传递一个对象，该对象允许你定义以下属性：

TypeScript

你可以从 Payload 导入类型，这有助于更轻松且类型安全地编写 Collection 配置。主要有两种类型代表 Collection Config：CollectionConfig 和 SanitizedCollectionConfig。

CollectionConfig 类型表示原始的完整 Collection Config，其中只有最基本的属性被标记为必需。SanitizedCollectionConfig 类型表示经过完全清理后的 Collection Config。通常，这个类型仅在 Payload 内部使用。

import type { CollectionConfig, SanitizedCollectionConfig } from 'payload'