ravendb

import { SearchOperator } from "../Queries/SearchOperator.js"; import { OrderingType } from "./OrderingType.js"; import { MethodCall } from "./MethodCall.js"; import { WhereParams } from "./WhereParams.js"; import { DynamicSpatialField } from "../Queries/Spatial/DynamicSpatialField.js"; import { SpatialCriteria } from "../Queries/Spatial/SpatialCriteria.js"; import { GroupBy } from "../Queries/GroupBy.js"; import { DocumentType } from "../DocumentAbstractions.js"; import { MoreLikeThisScope } from "../Queries/MoreLikeThis/MoreLikeThisScope.js"; import { SuggestionBase } from "../Queries/Suggestions/SuggestionBase.js"; import { HighlightingParameters } from "../Queries/Highlighting/HighlightingParameters.js"; import { ValueCallback } from "../../Types/Callbacks.js"; import { Highlightings } from "../Queries/Highlighting/Hightlightings.js"; import { IncludeBuilderBase } from "./Loaders/IncludeBuilderBase.js"; import { DocumentConventions } from "../Conventions/DocumentConventions.js"; export interface IAbstractDocumentQuery<T> { indexName: string; collectionName: string; /** * Gets the document convention from the query session */ conventions: DocumentConventions; /** * Determines if it is a dynamic map-reduce query */ isDynamicMapReduce(): boolean; /** * Instruct the query to wait for non stale result for the specified wait timeout. */ _waitForNonStaleResults(waitTimeout: number): void; /** * Gets the fields for projection */ getProjectionFields(): string[]; /** * Order the search results randomly */ _randomOrdering(): void; /** * Order the search results randomly using the specified seed * this is useful if you want to have repeatable random queries */ _randomOrdering(seed: string): void; /** * Includes the specified path in the query, loading the document specified in that path */ _include(path: string): void; /** * Includes the specified documents and/or counters in the query, specified by IncludeBuilder * @param includes builder */ _include(includes: IncludeBuilderBase): void; /** * Takes the specified count. */ _take(count: number): void; /** * Skips the specified count. */ _skip(count: number): void; /** * Matches value */ _whereEquals(fieldName: string, value: any): void; /** * Matches value */ _whereEquals(fieldName: string, value: any, exact: boolean): void; /** * Matches value */ _whereEquals(fieldName: string, method: MethodCall): void; /** * Matches value */ _whereEquals(fieldName: string, method: MethodCall, exact: boolean): void; /** * Matches value */ _whereEquals(whereParams: WhereParams): void; /** * Not matches value */ _whereNotEquals(fieldName: string, value: any): void; /** * Not matches value */ _whereNotEquals(fieldName: string, value: any, exact: boolean): void; /** * Not matches value */ _whereNotEquals(fieldName: string, method: MethodCall): void; /** * Not matches value */ _whereNotEquals(fieldName: string, method: MethodCall, exact: boolean): void; /** * Not matches value */ _whereNotEquals(whereParams: WhereParams): void; /** * Simplified method for opening a new clause within the query */ _openSubclause(): void; /** * Simplified method for closing a clause within the query */ _closeSubclause(): void; /** * Negate the next operation */ _negateNext(): void; /** * Check that the field has one of the specified value */ _whereIn(fieldName: string, values: any[]): void; /** * Check that the field has one of the specified value */ _whereIn(fieldName: string, values: any[], exact: boolean): void; /** * Matches fields which starts with the specified value. */ _whereStartsWith(fieldName: string, value: any): void; /** * Matches fields which starts with the specified value. */ _whereStartsWith(fieldName: string, value: any, exact: boolean): void; /** * Matches fields which ends with the specified value. */ _whereEndsWith(fieldName: string, value: any): void; /** * Matches fields which ends with the specified value. */ _whereEndsWith(fieldName: string, value: any, exact: boolean): void; /** * Matches fields where the value is between the specified start and end, inclusive */ _whereBetween(fieldName: string, start: any, end: any): void; /** * Matches fields where the value is between the specified start and end, inclusive */ _whereBetween(fieldName: string, start: any, end: any, exact: boolean): void; /** * Matches fields where the value is greater than the specified value */ _whereGreaterThan(fieldName: string, value: any): void; /** * Matches fields where the value is greater than the specified value */ _whereGreaterThan(fieldName: string, value: any, exact: boolean): void; /** * Matches fields where the value is greater than or equal to the specified value */ _whereGreaterThanOrEqual(fieldName: string, value: any): void; /** * Matches fields where the value is greater than or equal to the specified value */ _whereGreaterThanOrEqual(fieldName: string, value: any, exact: boolean): void; /** * Matches fields where the value is less than the specified value */ _whereLessThan(fieldName: string, value: any): void; /** * Matches fields where the value is less than the specified value */ _whereLessThan(fieldName: string, value: any, exact: boolean): void; /** * Matches fields where the value is less than or equal to the specified value */ _whereLessThanOrEqual(fieldName: string, value: any): void; /** * Matches fields where the value is less than or equal to the specified value */ _whereLessThanOrEqual(fieldName: string, value: any, exact: boolean): void; _whereExists(fieldName: string): void; _whereRegex(fieldName: string, pattern: string): void; /** * Add an AND to the query */ _andAlso(): void; /** * Add an OR to the query */ _orElse(): void; /** * Specifies a boost weight to the previous where clause. * The higher the boost factor, the more relevant the term will be. * * boosting factor where 1.0 is default, less than 1.0 is lower weight, greater than 1.0 is higher weight * * http://lucene.apache.org/java/2_4_0/queryparsersyntax.html#Boosting%20a%20Term */ _boost(boost: number): void; /** * Specifies a fuzziness factor to the single word term in the last where clause * * 0.0 to 1.0 where 1.0 means closer match * * http://lucene.apache.org/java/2_4_0/queryparsersyntax.html#Fuzzy%20Searches */ _fuzzy(fuzzy: number): void; /** * Specifies a proximity distance for the phrase in the last search clause * * http://lucene.apache.org/java/2_4_0/queryparsersyntax.html#Proximity%20Searches */ _proximity(proximity: number): void; /** * Order the results by the specified fields * The field is the name of the field to sort, defaulting to sorting by ascending. */ _orderBy(field: string): void; /** * Order the results by the specified fields * The field is the name of the field to sort, defaulting to sorting by ascending. */ _orderBy(field: string, ordering: OrderingType): void; /** * Order the results by the specified fields * The field is the name of the field to sort using sorterName */ _orderBy(field: string, options: { sorterName: string; }): void; _orderByDescending(field: string): void; _orderByDescending(field: string, ordering: OrderingType): void; _orderByDescending(field: string, options: { sorterName: string; }): void; _orderByScore(): void; _orderByScoreDescending(): void; _highlight(parameters: HighlightingParameters, highlightingsCallback: ValueCallback<Highlightings>): void; /** * Perform a search for documents which fields that match the searchTerms. * If there is more than a single term, each of them will be checked independently. */ _search(fieldName: string, searchTerms: string): void; /** * Perform a search for documents which fields that match the searchTerms. * If there is more than a single term, each of them will be checked independently. */ _search(fieldName: string, searchTerms: string, operator: SearchOperator): void; toString(): string; _intersect(): void; addRootType(clazz: DocumentType): void; _distinct(): void; /** * Performs a query matching ANY of the provided values against the given field (OR) */ _containsAny(fieldName: string, values: any[]): void; /** * Performs a query matching ALL of the provided values against the given field (AND) */ _containsAll(fieldName: string, values: any[]): void; _groupBy(fieldName: string, ...fieldNames: string[]): void; _groupBy(field: GroupBy, ...fields: GroupBy[]): void; _groupByKey(fieldName: string): void; _groupByKey(fieldName: string, projectedName: string): void; _groupBySum(fieldName: string): void; _groupBySum(fieldName: string, projectedName: string): void; _groupByCount(): void; _groupByCount(projectedName: string): void; _whereTrue(): void; _spatial(field: DynamicSpatialField, criteria: SpatialCriteria): void; _spatial(fieldName: string, criteria: SpatialCriteria): void; _orderByDistance(field: DynamicSpatialField, latitude: number, longitude: number): void; _orderByDistance(fieldName: string, latitude: number, longitude: number): void; _orderByDistance(fieldName: string, latitude: number, longitude: number, roundFactor: number): void; _orderByDistance(field: DynamicSpatialField, shapeWkt: string): void; _orderByDistance(fieldName: string, shapeWkt: string): void; _orderByDistance(fieldName: string, shapeWkt: string, roundFactor: number): void; _orderByDistanceDescending(field: DynamicSpatialField, latitude: number, longitude: number): void; _orderByDistanceDescending(fieldName: string, latitude: number, longitude: number): void; _orderByDistanceDescending(fieldName: string, latitude: number, longitude: number, roundFactor: number): void; _orderByDistanceDescending(field: DynamicSpatialField, shapeWkt: string): void; _orderByDistanceDescending(fieldName: string, shapeWkt: string): void; _orderByDistanceDescending(fieldName: string, shapeWkt: string, roundFactor: number): void; _moreLikeThis(): MoreLikeThisScope; addFromAliasToFilterTokens(fromAlias: string): void; addFromAliasToOrderByTokens(fromAlias: string): void; addAliasToIncludesTokens(fromAlias: string): string; _suggestUsing(suggestion: SuggestionBase): any; parameterPrefix: string; iterator(): Promise<IterableIterator<T>>; } //# sourceMappingURL=IAbstractDocumentQuery.d.ts.map