class.ItemsService.md

directus-monorepo ( Readme | API )

---

directus-monorepo > ItemsService

Class: ItemsService<Item>

Extended By

• ActivityService
• DashboardsService
• FilesService
• FlowsService
• FoldersService
• NotificationsService
• OperationsService
• PanelsService
• PermissionsService
• PresetsService
• RevisionsService
• RolesService
• SettingsService
• SharesService
• TranslationsService
• UsersService
• VersionsService
• WebhooksService

Type parameters

Parameter	Default
Item extends AnyItem	AnyItem

Implements

• AbstractService

Constructors

constructor()

new ItemsService<Item>(collection, options): ItemsService< Item >

Type parameters

Parameter	Default
Item extends Item	Item

Parameters

Parameter	Type
collection	string
options	AbstractServiceOptions

Returns

ItemsService< Item >

Source

api/src/services/items.ts:48

Properties

accountability

accountability: any

Source

api/src/services/items.ts:43

Implementation of

AbstractService.accountability

---

cache

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

Source

api/src/services/items.ts:46

---

collection

collection: string

Source

api/src/services/items.ts:41

---

eventScope

eventScope: string

Source

api/src/services/items.ts:44

---

knex

knex: Knex< any, any[] >

Source

api/src/services/items.ts:42

Implementation of

AbstractService.knex

---

schema

schema: SchemaOverview

Source

api/src/services/items.ts:45

Methods

createMany()

createMany(data, opts = {}): Promise< PrimaryKey[] >

Create multiple new items at once. Inserts all provided records sequentially wrapped in a transaction.

Parameters

Parameter	Type
data	Partial< Item >[]
opts	MutationOptions

Returns

Promise< PrimaryKey[] >

Implementation of

AbstractService.createMany

Source

api/src/services/items.ts:337

---

createMutationTracker()

createMutationTracker(initialCount = 0): MutationTracker

Parameters

Parameter	Type	Default value
initialCount	number	0

Returns

MutationTracker

Source

api/src/services/items.ts:59

---

createOne()

createOne(data, opts = {}): Promise< PrimaryKey >

Create a single new item.

Parameters

Parameter	Type
data	Partial< Item >
opts	MutationOptions

Returns

Promise< PrimaryKey >

Implementation of

AbstractService.createOne

Source

api/src/services/items.ts:96

---

deleteByQuery()

deleteByQuery(query, opts?): Promise< PrimaryKey[] >

Delete multiple items by query

Parameters

Parameter	Type
query	Query
opts?	MutationOptions

Returns

Promise< PrimaryKey[] >

Source

api/src/services/items.ts:859

---

deleteMany()

deleteMany(keys, opts = {}): Promise< PrimaryKey[] >

Delete multiple items by primary key

Parameters

Parameter	Type
keys	PrimaryKey[]
opts	MutationOptions

Returns

Promise< PrimaryKey[] >

Implementation of

AbstractService.deleteMany

Source

api/src/services/items.ts:882

---

deleteOne()

deleteOne(key, opts?): Promise< PrimaryKey >

Delete a single item by primary key

Parameters

Parameter	Type
key	PrimaryKey
opts?	MutationOptions

Returns

Promise< PrimaryKey >

Implementation of

AbstractService.deleteOne

Source

api/src/services/items.ts:871

---

getKeysByQuery()

getKeysByQuery(query): Promise< PrimaryKey[] >

Parameters

Parameter	Type
query	Query

Returns

Promise< PrimaryKey[] >

Source

api/src/services/items.ts:76

---

readByQuery()

readByQuery(query, opts?): Promise< Item[] >

Get items by query

Parameters

Parameter	Type
query	Query
opts?	QueryOptions

Returns

Promise< Item[] >

Implementation of

AbstractService.readByQuery

Source

api/src/services/items.ts:395

---

readMany()

readMany( keys, query = {}, opts?): Promise< Item[] >

Get multiple items by primary keys

Parameters

Parameter	Type
keys	PrimaryKey[]
query	Query
opts?	QueryOptions

Returns

Promise< Item[] >

Implementation of

AbstractService.readMany

Source

api/src/services/items.ts:501

---

readOne()

readOne( key, query = {}, opts?): Promise< Item >

Get single item by primary key

Parameters

Parameter	Type
key	PrimaryKey
query	Query
opts?	QueryOptions

Returns

Promise< Item >

Implementation of

AbstractService.readOne

Source

api/src/services/items.ts:482

---

readSingleton()

readSingleton(query, opts?): Promise< Partial< Item > >

Read/treat collection as singleton

Parameters

Parameter	Type
query	Query
opts?	QueryOptions

Returns

Promise< Partial< Item > >

Source

api/src/services/items.ts:982

---

updateBatch()

updateBatch(data, opts = {}): Promise< PrimaryKey[] >

Update multiple items in a single transaction

Parameters

Parameter	Type
data	Partial< Item >[]
opts	MutationOptions

Returns

Promise< PrimaryKey[] >

Source

api/src/services/items.ts:544

---

updateByQuery()

updateByQuery( query, data, opts?): Promise< PrimaryKey[] >

Update multiple items by query

Parameters

Parameter	Type
query	Query
data	Partial< Item >
opts?	MutationOptions

Returns

Promise< PrimaryKey[] >

Source

api/src/services/items.ts:521

---

updateMany()

updateMany( keys, data, opts = {}): Promise< PrimaryKey[] >

Update many items by primary key, setting all items to the same change

Parameters

Parameter	Type
keys	PrimaryKey[]
data	Partial< Item >
opts	MutationOptions

Returns

Promise< PrimaryKey[] >

Implementation of

AbstractService.updateMany

Source

api/src/services/items.ts:581

---

updateOne()

updateOne( key, data, opts?): Promise< PrimaryKey >

Update a single item by primary key

Parameters

Parameter	Type
key	PrimaryKey
data	Partial< Item >
opts?	MutationOptions

Returns

Promise< PrimaryKey >

Implementation of

AbstractService.updateOne

Source

api/src/services/items.ts:533

---

upsertMany()

upsertMany(payloads, opts = {}): Promise< PrimaryKey[] >

Upsert many items

Parameters

Parameter	Type
payloads	Partial< Item >[]
opts	MutationOptions

Returns

Promise< PrimaryKey[] >

Source

api/src/services/items.ts:829

---

upsertOne()

upsertOne(payload, opts?): Promise< PrimaryKey >

Upsert a single item

Parameters

Parameter	Type
payload	Partial< Item >
opts?	MutationOptions

Returns

Promise< PrimaryKey >

Source

api/src/services/items.ts:803

---

upsertSingleton()

upsertSingleton(data, opts?): Promise< PrimaryKey >

Upsert/treat collection as singleton

Parameters

Parameter	Type
data	Partial< Item >
opts?	MutationOptions

Returns

Promise< PrimaryKey >

Source

api/src/services/items.ts:1018

---

Generated using TypeDoc and typedoc-plugin-markdown