class.SchemaService.md

directus-monorepo ( Readme | API )

---

directus-monorepo > SchemaService

Class: SchemaService

Constructors

constructor()

new SchemaService(options): SchemaService

Parameters

Parameter	Type
options	Omit< AbstractServiceOptions, "schema" >

Returns

SchemaService

Source

api/src/services/schema.ts:23

Properties

accountability

accountability: any

Source

api/src/services/schema.ts:21

---

knex

knex: Knex< any, any[] >

Source

api/src/services/schema.ts:20

Methods

apply()

apply(payload): Promise< void >

Parameters

Parameter	Type
payload	SnapshotDiffWithHash

Returns

Promise< void >

Source

api/src/services/schema.ts:36

---

diff()

diff(snapshot, options?): Promise< null | SnapshotDiff >

Parameters

Parameter	Type
snapshot	Snapshot
options?	object
options.currentSnapshot?	Snapshot
options.force?	boolean

Returns

Promise< null | SnapshotDiff >

Source

api/src/services/schema.ts:47

---

getHashedSnapshot()

getHashedSnapshot(snapshot): SnapshotWithHash

Parameters

Parameter	Type
snapshot	Snapshot

Returns

SnapshotWithHash

Source

api/src/services/schema.ts:65

---

snapshot()

snapshot(): Promise< Snapshot >

Returns

Promise< Snapshot >

Source

api/src/services/schema.ts:28

---

Generated using TypeDoc and typedoc-plugin-markdown