Skip to content

class.ExportService.md

Latest commit

 

History

History
115 lines (66 loc) · 2.92 KB

class.ExportService.md

File metadata and controls

115 lines (66 loc) · 2.92 KB

directus-monorepo ( Readme | API )

directus-monorepo > ExportService

Class: ExportService

Constructors

constructor()

new ExportService(options): ExportService

Parameters

Parameter Type
options AbstractServiceOptions

Returns

ExportService

Source

api/src/services/import-export/index.ts:196

Properties

accountability

accountability: any

Source

api/src/services/import-export/index.ts:193

knex

knex: Knex< any, any[] >

Source

api/src/services/import-export/index.ts:192

schema

schema: SchemaOverview

Source

api/src/services/import-export/index.ts:194

Methods

exportToFile()

exportToFile( collection, query, format, options?): Promise< void >

Export the query results as a named file. Will query in batches, and keep appending a tmp file until all the data is retrieved. Uploads the result as a new file using the regular FilesService upload method.

Parameters

Parameter Type
collection string
query Query
format ExportFormat
options? object
options.file? any

Returns

Promise< void >

Source

api/src/services/import-export/index.ts:207

transform()

transform( input, format, options?): string

Transform a given input object / array to the given type

Parameters

Parameter Type
input Record< string, any >[]
format ExportFormat
options? object
options.includeFooter? boolean
options.includeHeader? boolean

Returns

string

Source

api/src/services/import-export/index.ts:364

Generated using TypeDoc and typedoc-plugin-markdown