@ directus/schema- 建设者

Directus SchemaBuilder 用于模拟/构建基于代码的数据库计划,仅供内部使用.

使用量

像这样:

const schema = new SchemaBuilder()
    .collection('articles', (c) => {
        c.field('id').id();
        c.field('title').string();
        c.field('content').text();
        c.field('published').dateTime();
    })
    .build();

或为o2m关系:

const schema = new SchemaBuilder()
    .collection('countries', (c) => {
        c.field('id').id();
        c.field('cities').o2m('cities', 'country_id');
    })
    .collection('cities', (c) => {
        c.field('id').id();
    })
    .build();

或m2m关系:

const schema = new SchemaBuilder()
    .collection('articles', (c) => {
        c.field('id').id();
        c.field('tags').m2m('tags');
    })
    .build();

传出一个字段名称作为第二个同时在相关收藏上创建倒数 m2m 字段的参数 :

c.field('tags').m2m('tags', 'articles'); // tags.articles lists the articles of a tag

抓图

构建者通过收藏,字段和关系来描述这个图案, 同样的形状是 Directus schema shrapp 用户。 下一个 build()时返回 a SchemaOverview,可以导出该图案作为可应用的快照 以Directus实例为准:

const snapshot = new SchemaBuilder()
    .collection('articles', (c) => {
        c.field('id').id();
        c.field('title').string();
    })
    .snapshot({ directus: '12.0.0', vendor: 'postgres' });

这个 directus 版本和 vendor 除非强制应用,否则必须匹配所应用的快照.

任何快照, 包括那些由 /schema/snapshot 端点,可以转换成 SchemaOverview 与 toSchemaOverview数字 :

import { toSchemaOverview } from '@directus/schema-builder';

const schema = toSchemaOverview(snapshot);

类型脚本

同样的图案可以导出为 TypeScript 接口,形状为 Directus SDK 所期望的,所以一个快照及其 类型可以同时生成 :

const builder = new SchemaBuilder().collection('articles', (c) => {
    c.field('id').id();
    c.field('title').string();
    c.field('author').m2o('users');
});

const snapshot = builder.snapshot({ directus: '12.0.0', vendor: 'postgres' });
const types = builder.types(); // export interface Schema { articles: Articles[]; users: Users[]; } ...

类型也可以从任何快照中生成 toTypeScript(snapshot, { schemaName: 'Schema' })。 。 。 .