Query: flexSearchFiles

Queries for Files using FlexSearch.

Return Type

File

File

Args

Name	Type	Description
after	String	If this is set to the value of the `_cursor` field of an item, only items after that one will be included in the result. The value of the `after` of this query must match the one where the `_cursor` value has been retrieved from.
filter	FileFilter	Renamed to postFilter. Use postFilter instead.
first	Int	The number of items to include in the result. If omitted, all remaining items will be included (which can cause performance problems on large collections).
flexSearchFilter	FileFlexSearchFilter
orderBy	FileOrderBy	Specifies the how this collection should be sorted. If omitted, the result order is not specified. If cursor-based pagination is used (i.e., the `after` is specified or the `_cursor` is requested), `id_ASC` will be implicitly added as last sort criterion so that the sort order is deterministic.
postFilter	FileFilter	Filters that will be applied in memory after the flexSearchFilter. This will not use any indices and will only work if applied on less than 10 000 objects.
skip	Int	The number of items in the list or collection to skip. Is applied after the `after` argument if both are specified.

Properties

Name	Type	Description
_childrenMeta	_QueryMeta	If this file is a directory, this lists all the children
_cursor	String	Provides a value that can be supplied to the `after` argument for pagination. Depends on the value of the `orderBy` argument.
_hashesMeta	_QueryMeta	Uniquely identifies this file by at least one of several hashes
_revision	ID	An identifier that is updated automatically on each update of this root entity (but not on relation changes)
children	[File]	If this file is a directory, this lists all the children
contentsLink	String	Link to a location where the full file contents can be downloaded/viewed (if available)
createdAt	DateTime	The instant this object has been created
ctx	RelationEntityCtx	Context contains fields that are accessible to the permissions profile. This is an internal field related to user permissions.
hashes	[Hash]	Uniquely identifies this file by at least one of several hashes
id	ID	An auto-generated string that identifies this root entity uniquely among others of the same type
modifiedDate	DateTime	The date the file was last modified in the original file system
name	String	The file name of the file without the full path
path	String	The full path to this file within the original filesystem
permissions	String	The permissions associated with the file in the original file system.
size	Int	File size in bytes
type	String	MIME type of this file
updatedAt	DateTime	The instant this object has been updated the last time (not including relation updates)

This page was generated: 2024-11-06