Query: flexSearchFiles

Queries for Files using FlexSearch.

Return Type




Args

NameTypeDescription
afterString

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.

filterFileFilter

Renamed to postFilter. Use postFilter instead.

firstInt

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).

flexSearchFilterFileFlexSearchFilter
orderByFileOrderBy

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.

postFilterFileFilter

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.

skipInt

The number of items in the list or collection to skip. Is applied after the after argument if both are specified.


Properties

NameTypeDescription
_childrenMeta_QueryMeta

If this file is a directory, this lists all the children

_cursorString

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

_revisionID

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

contentsLinkString

Link to a location where the full file contents can be downloaded/viewed (if available)

createdAtDateTime

The instant this object has been created

ctxRelationEntityCtx

Context contains fields that are accesible 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

idID

An auto-generated string that identifies this root entity uniquely among others of the same type

modifiedDateDateTime

The date the file was last modified in the original file system

nameString

The file name of the file without the full path

pathString

The full path to this file within the orignal filesystem

permissionsString

The permissions associated with the file in the original file system.

sizeInt

File size in bytes

typeString

MIME type of this file

updatedAtDateTime

The instant this object has been updated the last time (not including relation updates)


This page was generated: 2024-05-17