search string side menu

Объект фильтрации и загрузки элементов отчёта

Type parameters

Hierarchy

  • ReportSearch

Methods

all

  • all(): Promise<Partial<TData>[]>

  • Метод позволяет загрузить элементы отчёта.

    По умолчанию размер выборки ограничен 10 записями. Если нужно выбрать больше элементов, используйте метод ReportSearch.size.

    const reportItems = await Context.fields.report.search().all();

    Returns Promise<Partial<TData>[]>

from

  • from(value: number): this

  • Метод позволяет пропустить заданное количество элементов.

    Parameters

    • value: number

      Количество элементов, которое необходимо пропустить.

      Например, при работе с большим количеством элементов отчёта можно разбить поиск на порции и динамически определять начало выборки.

      for (var i = 0; i < 10; i++) {
    const from = 100 * i;
    const reportItems = await Context.fields.report.search()
        .from(from)
        .all();
}

    Returns this

having

  • having(fc: FilterClosure<THaving>): this

  • Метод позволяет задать фильтрацию для колонок отчёта с агрегацией.

    Parameters

    • fc: FilterClosure<THaving>

      Фильтры для поиска.

      Поиск по одному полю.

      const reportItems = await Context.fields.report.search()
    .having(f => f.document_count.gte(50))
    .all();

      Поиск по нескольким полям.

      const reportItems = await Context.fields.report.search()
    .having((f, g) => g.and (
        f.document_count.gte(50),
        f.document_count.lte(100),
    ))
    .all();

    Returns this

size

  • size(value: number): this

  • Метод позволяет задать ограничение выборки элементов.

    Parameters

    • value: number

      Размер выборки (по умолчанию 10, максимум 10000).

      const reportItems = await Context.fields.report.search()
    .size(500)
    .all();

    Returns this

sort

  • sort(column: string, ascending?: undefined | false | true): this

  • Метод позволяет выполнить сортировку результатов поиска.

    Parameters

    • column: string

      Код колонки, по которой выполняется сортировка.

    • Optional ascending: undefined | false | true

      Если значение параметра — true, сортировка выполняется по возрастанию, если false — по убыванию.

      const reportItems = await Context.fields.report.search()
    .sort("name", true)
    .all();

    Returns this

where

  • where(fc: FilterClosure<TWhere>): this

  • Метод позволяет задать фильтрацию для колонок отчёта без агрегации.

    Parameters

    • fc: FilterClosure<TWhere>

      Фильтры для поиска.

      Поиск по одному полю.

      const reportItems = await Context.fields.report.search()
    .where(f => f.price.gte(10000))
    .all();

      Поиск по нескольким полям.

      const reportItems = await Context.fields.report.search()
    .where((f, g) => g.and (
        f.price.gte(10000),
        f.price.lte(20000),
    ))
    .all();

    Returns this