Delen via

FeedOptions interface

  • Referentie
Pakket:
@azure/cosmos

De feedopties en querymethoden.

Uitbreiding
SharedOptions

Eigenschappen

accessCondition

Voorwaarden die aan de aanvraag zijn gekoppeld.
allowUnboundedNonStreamingQueries

Alleen geldig voor niet-streamingvolgorde per query. Standaard: onwaar; Als deze optie is ingesteld op true, kunnen query's het standaardgedrag omzeilen dat niet-streamingquery's zonder boven- of limietclausules blokkeert.
bufferItems

Schakel buffering van extra items in tijdens query's. Standaard: onwaar

Hiermee wordt een extra pagina tegelijk gebufferd (vermenigvuldigd met maxDegreeOfParallelism) van de server op de achtergrond. Dit verbetert de latentie door pagina's op te halen voordat deze nodig zijn voor de client. Als u alle resultaten van de server leegloopt, zoals .fetchAll, moet u dit meestal inschakelen. Als u slechts één pagina tegelijk ophaalt via een vervolgtoken, moet u dit vermijden. Als u meer dan één pagina leegloopt, maar niet de volledige resultatenset, kan dit helpen de latentie te verbeteren, maar wordt de totale hoeveelheid RU/s verhoogd om de hele query te verwerken (omdat sommige pagina's meer dan één keer worden opgehaald).
continuation

Ondoorzichtig token voor het voortzetten van de opsomming. Standaard: niet gedefinieerd
continuationToken

Ondoorzichtig token voor het voortzetten van de opsomming. Standaard: niet gedefinieerd
continuationTokenLimitInKB

Hiermee beperkt u de grootte van het vervolgtoken in het antwoord. Standaard: niet gedefinieerd

Vervolgtokens bevatten optionele gegevens die uit de serialisatie kunnen worden verwijderd voordat ze naar een header worden geschreven. Dit wordt standaard beperkt tot 1 kB om lange kopteksten te voorkomen (Node.js een limiet heeft voor de grootte van globale headers). Een gebruiker kan dit veld instellen om langere headers toe te staan, waardoor de back-end de uitvoering van query's kan optimaliseren."
disableNonStreamingOrderByQuery

Schakel de nietStreamingOrderBy-queryfunctie uit in ondersteunde queryfuncties. Standaard: false. Ingesteld op True om fouten te voorkomen van een oude gateway die deze functie niet ondersteunt.
enableScanInQuery

Scan toestaan op de query's die niet kunnen worden uitgevoerd als indexering, is afgemeld voor de aangevraagde paden. Standaard: onwaar

Over het algemeen is het raadzaam om te voorkomen dat u deze instelling gebruikt. Scans zijn relatief duur en het duurt lang om te dienen.
forceQueryPlan

Met deze instelling wordt de query gedwongen een queryplan te gebruiken. Standaard: onwaar

Opmerking: hiermee wordt ondersteuning voor vervolgtoken uitgeschakeld, zelfs voor query's met één partitie.

Voor query's zoals aggregaties en de meeste query's voor meerdere partities gebeurt dit toch. Omdat de bibliotheek echter niet weet welk type query het is totdat we het eerste antwoord terugkrijen, kan sommige optimalisatie pas later plaatsvinden.

Als deze instelling is ingeschakeld, wordt het queryplan voor de query afgedwongen, waardoor sommige netwerkaanvragen worden opgeslagen en ervoor wordt gezorgd dat parallellisme kan plaatsvinden. Handig als u weet dat u query's tussen partities of statistische query's uitvoert.
maxDegreeOfParallelism

Het maximum aantal gelijktijdige bewerkingen waarop clientzijde wordt uitgevoerd tijdens parallelle uitvoering van query's in de Azure Cosmos DB-databaseservice. Negatieve waarden zorgen ervoor dat het systeem automatisch bepaalt hoeveel gelijktijdige bewerkingen moeten worden uitgevoerd. Standaard: 0 (geen parallelle uitvoering)
maxItemCount

Maximum aantal items dat moet worden geretourneerd in de opsommingsbewerking. Standaard: niet gedefinieerd (door de server gedefinieerde nettolading)

Expirimenting met deze waarde kan meestal leiden tot de grootste prestatiewijzigingen in de query.

Hoe kleiner het aantal items, hoe sneller het eerste resultaat wordt geleverd (voor niet-aggregaties). Voor grotere hoeveelheden duurt het langer om de aanvraag te verwerken, maar meestal krijgt u een betere doorvoer voor grote query's (bijvoorbeeld als u 1000 items nodig hebt voordat u andere acties kunt uitvoeren, stelt u maxItemCount in op 1000. Als u na de eerste 100 aan het werk kunt gaan, stelt u maxItemCount in op 100.)
partitionKey

Hiermee wordt de query beperkt tot een specifieke partitiesleutel. Standaard: niet gedefinieerd

Het bereik van een query naar één partitie kan op twee manieren worden uitgevoerd:

container.items.query('SELECT * from c', { partitionKey: "foo" }).toArray() container.items.query('SELECT * from c WHERE c.yourPartitionKey = "foo"').toArray()

Het eerste is handig wanneer de hoofdtekst van de query buiten uw besturingselement valt, maar u deze nog steeds wilt beperken tot één partitie. Voorbeeld: een door de eindgebruiker opgegeven query.
populateIndexMetrics

Schakel metrische indexgegevens in antwoordheaders in. Standaard: onwaar
populateQueryMetrics

Schakel metrische querygegevens in antwoordheaders in. Standaard: onwaar

Wordt gebruikt voor het opsporen van fouten in trage of dure query's. Verhoogt ook de antwoordgrootte en als u een lage maximale headergrootte in Node.jsgebruikt, kunt u sneller problemen ondervinden.
useIncrementalFeed

Opmerking: overweeg in plaats daarvan changeFeed te gebruiken.

Hiermee wordt een aanvraag voor een wijzigingenfeed aangegeven. Moet worden ingesteld op 'Incrementele feed' of anders worden weggelaten. Standaard: onwaar
vectorSearchBufferSize

Hiermee geeft u een aangepaste maximale buffergrootte op voor het opslaan van uiteindelijke resultaten voor nietStreamingOrderBy-query's. Deze waarde wordt genegeerd als de query top-/offset+limit-componenten bevat.

Overgenomen eigenschappen

abortSignal

abortSignal om alle onderliggende netwerkaanvragen door te geven die door deze methodeaanroep zijn gemaakt. Zie https://developer.mozilla.org/en-US/docs/Web/API/AbortController

voorbeeld van

Een leesaanvraag annuleren

const controller = new AbortController()
const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal});
controller.abort()
bypassIntegratedCache

Sets als geïntegreerde cache moet worden overgeslagen of ingeschakeld voor de aanvraag in de Azure CosmosDB-service.

De standaardwaarde is onwaar. Standaard is geïntegreerde cache ingeschakeld
initialHeaders

(Geavanceerd gebruiksvoorbeeld) Eerste headers om mee te beginnen bij het verzenden van aanvragen naar Cosmos
maxIntegratedCacheStalenessInMs

Hiermee stelt u de verouderingswaarde in die is gekoppeld aan de aanvraag in de Azure CosmosDB-service. Voor aanvragen waarbij de <xref:com.azure.cosmos.ConsistencyLevel> is <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> of <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, zijn reacties van de geïntegreerde cache gegarandeerd niet verlopen dan de waarde die wordt aangegeven door deze maxIntegratedCacheStaleness. Als het consistentieniveau niet is ingesteld, wordt deze eigenschap genegeerd.

De standaardwaarde is null

Cache veroudering wordt ondersteund in milliseconden granulariteit. Alles wat kleiner is dan milliseconden, wordt genegeerd.
priorityLevel

Prioriteitsniveau (laag/hoog) voor elke aanvraag. Aanvragen met een lage prioriteit worden altijd beperkt voordat aanvragen met een hoge prioriteit worden ingediend.

De standaardwaarde is null. Standaard hebben alle aanvragen een hoge prioriteit
sessionToken

Hiermee schakelt u het ophalen van aan documentcontainerquotum gerelateerde statistieken voor leesaanvragen voor documentcontainers in of uit.

Eigenschapdetails

accessCondition

Voorwaarden die aan de aanvraag zijn gekoppeld.

accessCondition?: { condition: string, type: string }

Waarde van eigenschap

{ condition: string, type: string }

allowUnboundedNonStreamingQueries

Alleen geldig voor niet-streamingvolgorde per query. Standaard: onwaar; Als deze optie is ingesteld op true, kunnen query's het standaardgedrag omzeilen dat niet-streamingquery's zonder boven- of limietclausules blokkeert.

allowUnboundedNonStreamingQueries?: boolean

Waarde van eigenschap

boolean

bufferItems

Schakel buffering van extra items in tijdens query's. Standaard: onwaar

Hiermee wordt een extra pagina tegelijk gebufferd (vermenigvuldigd met maxDegreeOfParallelism) van de server op de achtergrond. Dit verbetert de latentie door pagina's op te halen voordat deze nodig zijn voor de client. Als u alle resultaten van de server leegloopt, zoals .fetchAll, moet u dit meestal inschakelen. Als u slechts één pagina tegelijk ophaalt via een vervolgtoken, moet u dit vermijden. Als u meer dan één pagina leegloopt, maar niet de volledige resultatenset, kan dit helpen de latentie te verbeteren, maar wordt de totale hoeveelheid RU/s verhoogd om de hele query te verwerken (omdat sommige pagina's meer dan één keer worden opgehaald).

bufferItems?: boolean

Waarde van eigenschap

boolean

continuation

Waarschuwing

Deze API is nu afgeschaft.

Use continuationToken instead.

Ondoorzichtig token voor het voortzetten van de opsomming. Standaard: niet gedefinieerd

continuation?: string

Waarde van eigenschap

string

continuationToken

Ondoorzichtig token voor het voortzetten van de opsomming. Standaard: niet gedefinieerd

continuationToken?: string

Waarde van eigenschap

string

continuationTokenLimitInKB

Hiermee beperkt u de grootte van het vervolgtoken in het antwoord. Standaard: niet gedefinieerd

Vervolgtokens bevatten optionele gegevens die uit de serialisatie kunnen worden verwijderd voordat ze naar een header worden geschreven. Dit wordt standaard beperkt tot 1 kB om lange kopteksten te voorkomen (Node.js een limiet heeft voor de grootte van globale headers). Een gebruiker kan dit veld instellen om langere headers toe te staan, waardoor de back-end de uitvoering van query's kan optimaliseren."

continuationTokenLimitInKB?: number

Waarde van eigenschap

number

disableNonStreamingOrderByQuery

Schakel de nietStreamingOrderBy-queryfunctie uit in ondersteunde queryfuncties. Standaard: false. Ingesteld op True om fouten te voorkomen van een oude gateway die deze functie niet ondersteunt.

disableNonStreamingOrderByQuery?: boolean

Waarde van eigenschap

boolean

enableScanInQuery

Scan toestaan op de query's die niet kunnen worden uitgevoerd als indexering, is afgemeld voor de aangevraagde paden. Standaard: onwaar

Over het algemeen is het raadzaam om te voorkomen dat u deze instelling gebruikt. Scans zijn relatief duur en het duurt lang om te dienen.

enableScanInQuery?: boolean

Waarde van eigenschap

boolean

forceQueryPlan

Met deze instelling wordt de query gedwongen een queryplan te gebruiken. Standaard: onwaar

Opmerking: hiermee wordt ondersteuning voor vervolgtoken uitgeschakeld, zelfs voor query's met één partitie.

Voor query's zoals aggregaties en de meeste query's voor meerdere partities gebeurt dit toch. Omdat de bibliotheek echter niet weet welk type query het is totdat we het eerste antwoord terugkrijen, kan sommige optimalisatie pas later plaatsvinden.

Als deze instelling is ingeschakeld, wordt het queryplan voor de query afgedwongen, waardoor sommige netwerkaanvragen worden opgeslagen en ervoor wordt gezorgd dat parallellisme kan plaatsvinden. Handig als u weet dat u query's tussen partities of statistische query's uitvoert.

forceQueryPlan?: boolean

Waarde van eigenschap

boolean

maxDegreeOfParallelism

Het maximum aantal gelijktijdige bewerkingen waarop clientzijde wordt uitgevoerd tijdens parallelle uitvoering van query's in de Azure Cosmos DB-databaseservice. Negatieve waarden zorgen ervoor dat het systeem automatisch bepaalt hoeveel gelijktijdige bewerkingen moeten worden uitgevoerd. Standaard: 0 (geen parallelle uitvoering)

maxDegreeOfParallelism?: number

Waarde van eigenschap

number

maxItemCount

Maximum aantal items dat moet worden geretourneerd in de opsommingsbewerking. Standaard: niet gedefinieerd (door de server gedefinieerde nettolading)

Expirimenting met deze waarde kan meestal leiden tot de grootste prestatiewijzigingen in de query.

Hoe kleiner het aantal items, hoe sneller het eerste resultaat wordt geleverd (voor niet-aggregaties). Voor grotere hoeveelheden duurt het langer om de aanvraag te verwerken, maar meestal krijgt u een betere doorvoer voor grote query's (bijvoorbeeld als u 1000 items nodig hebt voordat u andere acties kunt uitvoeren, stelt u maxItemCount in op 1000. Als u na de eerste 100 aan het werk kunt gaan, stelt u maxItemCount in op 100.)

maxItemCount?: number

Waarde van eigenschap

number

partitionKey

Hiermee wordt de query beperkt tot een specifieke partitiesleutel. Standaard: niet gedefinieerd

Het bereik van een query naar één partitie kan op twee manieren worden uitgevoerd:

container.items.query('SELECT * from c', { partitionKey: "foo" }).toArray() container.items.query('SELECT * from c WHERE c.yourPartitionKey = "foo"').toArray()

Het eerste is handig wanneer de hoofdtekst van de query buiten uw besturingselement valt, maar u deze nog steeds wilt beperken tot één partitie. Voorbeeld: een door de eindgebruiker opgegeven query.

partitionKey?: PartitionKey

Waarde van eigenschap

PartitionKey

populateIndexMetrics

Schakel metrische indexgegevens in antwoordheaders in. Standaard: onwaar

populateIndexMetrics?: boolean

Waarde van eigenschap

boolean

populateQueryMetrics

Schakel metrische querygegevens in antwoordheaders in. Standaard: onwaar

Wordt gebruikt voor het opsporen van fouten in trage of dure query's. Verhoogt ook de antwoordgrootte en als u een lage maximale headergrootte in Node.jsgebruikt, kunt u sneller problemen ondervinden.

populateQueryMetrics?: boolean

Waarde van eigenschap

boolean

useIncrementalFeed

Opmerking: overweeg in plaats daarvan changeFeed te gebruiken.

Hiermee wordt een aanvraag voor een wijzigingenfeed aangegeven. Moet worden ingesteld op 'Incrementele feed' of anders worden weggelaten. Standaard: onwaar

useIncrementalFeed?: boolean

Waarde van eigenschap

boolean

vectorSearchBufferSize

Hiermee geeft u een aangepaste maximale buffergrootte op voor het opslaan van uiteindelijke resultaten voor nietStreamingOrderBy-query's. Deze waarde wordt genegeerd als de query top-/offset+limit-componenten bevat.

vectorSearchBufferSize?: number

Waarde van eigenschap

number

Details van overgenomen eigenschap

abortSignal

abortSignal om alle onderliggende netwerkaanvragen door te geven die door deze methodeaanroep zijn gemaakt. Zie https://developer.mozilla.org/en-US/docs/Web/API/AbortController

voorbeeld van

Een leesaanvraag annuleren

const controller = new AbortController()
const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal});
controller.abort()

abortSignal?: AbortSignal

Waarde van eigenschap

AbortSignal

overgenomen vanSharedOptions.abortSignal-

bypassIntegratedCache

Sets als geïntegreerde cache moet worden overgeslagen of ingeschakeld voor de aanvraag in de Azure CosmosDB-service.

De standaardwaarde is onwaar. Standaard is geïntegreerde cache ingeschakeld

bypassIntegratedCache?: boolean

Waarde van eigenschap

boolean

overgenomen vanSharedOptions.bypassIntegratedCache

initialHeaders

(Geavanceerd gebruiksvoorbeeld) Eerste headers om mee te beginnen bij het verzenden van aanvragen naar Cosmos

initialHeaders?: CosmosHeaders

Waarde van eigenschap

CosmosHeaders

overgenomen vanSharedOptions.initialHeaders

maxIntegratedCacheStalenessInMs

Hiermee stelt u de verouderingswaarde in die is gekoppeld aan de aanvraag in de Azure CosmosDB-service. Voor aanvragen waarbij de <xref:com.azure.cosmos.ConsistencyLevel> is <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> of <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, zijn reacties van de geïntegreerde cache gegarandeerd niet verlopen dan de waarde die wordt aangegeven door deze maxIntegratedCacheStaleness. Als het consistentieniveau niet is ingesteld, wordt deze eigenschap genegeerd.

De standaardwaarde is null

Cache veroudering wordt ondersteund in milliseconden granulariteit. Alles wat kleiner is dan milliseconden, wordt genegeerd.

maxIntegratedCacheStalenessInMs?: number

Waarde van eigenschap

number

overgenomen vanSharedOptions.maxIntegratedCacheStalenessInMs

priorityLevel

Prioriteitsniveau (laag/hoog) voor elke aanvraag. Aanvragen met een lage prioriteit worden altijd beperkt voordat aanvragen met een hoge prioriteit worden ingediend.

De standaardwaarde is null. Standaard hebben alle aanvragen een hoge prioriteit

priorityLevel?: PriorityLevel

Waarde van eigenschap

PriorityLevel

overgenomen vanSharedOptions.priorityLevel

sessionToken

Hiermee schakelt u het ophalen van aan documentcontainerquotum gerelateerde statistieken voor leesaanvragen voor documentcontainers in of uit.

sessionToken?: string

Waarde van eigenschap

string

overgenomen vanSharedOptions.sessionToken