class.FieldsService.md

directus-monorepo ( Readme | API )

---

directus-monorepo > FieldsService

Class: FieldsService

Constructors

constructor()

new FieldsService(options): FieldsService

Parameters

Parameter	Type
options	AbstractServiceOptions

Returns

FieldsService

Source

api/src/services/fields.ts:39

Properties

accountability

accountability: any

Source

api/src/services/fields.ts:31

---

cache

cache: null | Keyv< any, Record< string, unknown > >

Source

api/src/services/fields.ts:36

---

helpers

helpers: object

Type declaration

helpers.date

date: DateHelperMySQL | DateHelperDefault | DateHelperSQLite | DateHelperOracle | DateHelperMSSQL

helpers.schema

schema: SchemaHelperMySQL | SchemaHelperDefault | SchemaHelperCockroachDb | SchemaHelperSQLite | SchemaHelperOracle | SchemaHelperMSSQL

helpers.sequence

sequence: AutoIncrementHelperDefault | AutoIncrementHelperPostgres

helpers.st

st: GeometryHelperMySQL | GeometryHelperPostgres | GeometryHelperSQLite | GeometryHelperOracle | GeometryHelperMSSQL | GeometryHelperRedshift

Source

api/src/services/fields.ts:30

---

itemsService

itemsService: ItemsService< Item >

Source

api/src/services/fields.ts:32

---

knex

knex: Knex< any, any[] >

Source

api/src/services/fields.ts:29

---

payloadService

payloadService: PayloadService

Source

api/src/services/fields.ts:33

---

schema

schema: SchemaOverview

Source

api/src/services/fields.ts:35

---

schemaInspector

schemaInspector: SchemaInspector

Source

api/src/services/fields.ts:34

---

systemCache

systemCache: Keyv< any, Record< string, unknown > >

Source

api/src/services/fields.ts:37

Accessors

hasReadAccess

private get hasReadAccess(): boolean

Source

api/src/services/fields.ts:54

Methods

addColumnToTable()

addColumnToTable( table, field, alter = null): void

Parameters

Parameter	Type	Default value
table	CreateTableBuilder	undefined
field	any	undefined
alter	any	null

Returns

void

Source

api/src/services/fields.ts:665

---

createField()

createField( collection, field, table?, opts?): Promise< void >

Parameters

Parameter	Type
collection	string
field	any
table?	CreateTableBuilder
opts?	MutationOptions

Returns

Promise< void >

Source

api/src/services/fields.ts:249

---

deleteField()

deleteField( collection, field, opts?): Promise< void >

Parameters

Parameter	Type
collection	string
field	string
opts?	MutationOptions

Returns

Promise< void >

Source

api/src/services/fields.ts:499

---

readAll()

readAll(collection?): Promise< Field[] >

Parameters

Parameter	Type
collection?	string

Returns

Promise< Field[] >

Source

api/src/services/fields.ts:60

---

readOne()

readOne(collection, field): Promise< Record< string, any > >

Parameters

Parameter	Type
collection	string
field	string

Returns

Promise< Record< string, any > >

Source

api/src/services/fields.ts:192

---

updateField()

updateField( collection, field, opts?): Promise< string >

Parameters

Parameter	Type
collection	string
field	RawField
opts?	MutationOptions

Returns

Promise< string >

Source

api/src/services/fields.ts:376

---

Generated using TypeDoc and typedoc-plugin-markdown