FeedOptions interface

Villkor som är associerade med begäran.

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

Egenskapsvärde

Gäller endast för icke-direktuppspelningsordning efter fråga. Standard: false; När värdet är true tillåter det att frågor kringgår standardbeteendet som blockerar ickeStreaming-frågor utan topp- eller gränssatser.

allowUnboundedNonStreamingQueries?: boolean

Egenskapsvärde

Aktivera buffring av ytterligare objekt under frågor. Standard: false

Detta buffrar ytterligare en sida i taget (multiplicerat med maxDegreeOfParallelism) från servern i bakgrunden. Detta förbättrar svarstiden genom att hämta sidor innan de behövs av klienten. Om du tömmer alla resultat från servern, till exempel .fetchAll, bör du vanligtvis aktivera detta. Om du bara hämtar en sida i taget via fortsättningstoken bör du undvika detta. Om du tömmer mer än en sida, men inte hela resultatuppsättningen, kan det hjälpa till att förbättra svarstiden, men det ökar den totala mängden RU/s-användning för att hantera hela frågan (eftersom vissa sidor hämtas mer än en gång).

bufferItems?: boolean

Egenskapsvärde

Ogenomskinlig token för att fortsätta uppräkningen. Standard: odefinierad

continuation?: string

Egenskapsvärde

Ogenomskinlig token för att fortsätta uppräkningen. Standard: odefinierad

continuationToken?: string

Egenskapsvärde

Begränsar storleken på fortsättningstoken i svaret. Standard: odefinierad

Fortsättningstoken innehåller valfria data som kan tas bort från serialiseringen innan du skriver ut dem till en rubrik. Som standard begränsar vi detta till 1 kB för att undvika långa rubriker (Node.js har en global storleksgräns för sidhuvuden). En användare kan ange att det här fältet ska tillåta längre rubriker, vilket kan hjälpa serverdelen att optimera frågekörningen."

continuationTokenLimitInKB?: number

Egenskapsvärde

Standard: false. Om värdet är true inaktiveras optimeringen av hybridsökfrågeplanen. Den här optimeringen är aktiverad som standard och används för att förbättra prestanda för hybridsökningsfrågor.

disableHybridSearchQueryPlanOptimization?: boolean

Egenskapsvärde

Inaktivera frågefunktionen nonStreamingOrderBy i frågefunktioner som stöds. Standard: false. Ställ in på true för att undvika fel från en gammal gateway som inte stöder den här funktionen.

disableNonStreamingOrderByQuery?: boolean

Egenskapsvärde

Styr frågekörningsbeteendet. Standard: false. Om värdet är false försöker frågan igen tills resultaten är klara och maxItemCount har nåtts, vilket kan ta tid för stora partitioner med relativt små data. Om värdet är true genomsöker partitioner upp till maxDegreeOfParallelism, lägger till resultat i bufferten och returnerar det som är tillgängligt. Om resultatet inte är klart returneras ett tomt svar.

enableQueryControl?: boolean

Egenskapsvärde

Tillåt genomsökning på de frågor som inte kunde hanteras eftersom indexering avregistrerades på de begärda sökvägarna. Standard: false

I allmänhet är det bäst att undvika att använda den här inställningen. Genomsökningar är relativt dyra och tar lång tid att betjäna.

enableScanInQuery?: boolean

Egenskapsvärde

Den här inställningen tvingar frågan att använda en frågeplan. Standard: false

Obs! Detta inaktiverar stöd för fortsättningstoken, även för frågor med en enskild partition.

För frågor som aggregeringar och de flesta frågor mellan partitioner sker detta ändå. Men eftersom biblioteket inte vet vilken typ av fråga det är förrän vi får tillbaka det första svaret kan viss optimering inte ske förrän senare.

Om den här inställningen är aktiverad framtvingar den frågeplanen för frågan, vilket sparar vissa nätverksbegäranden och säkerställer att parallellitet kan ske. Användbart för när du vet att du gör frågor mellan partitioner eller aggregerade frågor.

forceQueryPlan?: boolean

Egenskapsvärde

Det maximala antalet samtidiga åtgärder som kör klientsidan under parallell frågekörning i Azure Cosmos DB-databastjänsten. Negativa värden gör att systemet automatiskt bestämmer antalet samtidiga åtgärder som ska köras. Standard: 0 (ingen parallellitet)

maxDegreeOfParallelism?: number

Egenskapsvärde

Maximalt antal objekt som ska returneras i uppräkningsåtgärden. Standard: odefinierad (servern definierar nyttolast)

Förfallodatum med det här värdet kan vanligtvis resultera i de största prestandaändringarna i frågan.

Ju mindre antal objekt, desto snabbare levereras det första resultatet (för icke-aggregeringar). För större mängder tar det längre tid att hantera begäran, men du får vanligtvis bättre dataflöde för stora frågor (dvs. om du behöver 1 000 objekt innan du kan utföra andra åtgärder anger du maxItemCount till 1 000. Om du kan börja arbeta efter de första 100 anger du maxItemCount till 100.)

maxItemCount?: number

Egenskapsvärde

Begränsar frågan till en specifik partitionsnyckel. Standard: odefinierad

Omfång för en fråga till en enskild partition kan utföras på två sätt:

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

Det förstnämnda är användbart när frågetexten är utom din kontroll, men du fortfarande vill begränsa den till en enda partition. Exempel: en angiven fråga för slutanvändare.

partitionKey?: PartitionKey

Egenskapsvärde

Aktivera returnerade indexmått i svarshuvuden. Standard: false

populateIndexMetrics?: boolean

Egenskapsvärde

Aktivera returnerade frågemått i svarshuvuden. Standard: false

Används för felsökning av långsamma eller dyra frågor. Ökar även svarsstorleken och om du använder en låg maxhuvudstorlek i Node.jskan du stöta på problem snabbare.

populateQueryMetrics?: boolean

Egenskapsvärde

Obs! Överväg att använda changeFeed i stället.

Anger en ändringsflödesbegäran. Måste anges till "Inkrementell feed" eller utelämnas på annat sätt. Standard: false

useIncrementalFeed?: boolean

Egenskapsvärde

Anger en anpassad maximal buffertstorlek för lagring av slutliga resultat för nonStreamingOrderBy-frågor. Det här värdet ignoreras om frågan innehåller topp-/offset+limit-satser.

vectorSearchBufferSize?: number

Egenskapsvärde

abortSignal för att skicka till alla underliggande nätverksbegäranden som skapats av det här metodanropet. Se https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Exempel

Avbryt en läsbegäran

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const controller = new AbortController();
const results = container.items.query("SELECT * from c", {
  abortSignal: controller.signal,
});

abortSignal?: AbortSignal

Egenskapsvärde

ärvd frånSharedOptions.abortSignal

Anger om integrerad cache ska kringgås eller aktiveras för begäran i Azure CosmosDB-tjänsten.

Standardvärdet är falskt. Som standard är integrerad cache aktiverad

bypassIntegratedCache?: boolean

Egenskapsvärde

ärvd frånSharedOptions.bypassIntegratedCache

Konsekvensnivå som krävs av klienten.

consistencyLevel?: string

Egenskapsvärde

Ärvd frånSharedOptions.consistencyLevel

DisableRUPerMinuteUsage används för att aktivera/inaktivera kapacitet för begärandeenheter/minutkapacitet för att hantera begäran om regelbundna etablerade RU:er/sekund är slut.

disableRUPerMinuteUsage?: boolean

Egenskapsvärde

Ärvd frånSharedOptions.disableRUPerMinuteUsage

Exkluderar en eller flera Azure-regioner för åtgärden.

Det här alternativet tillämpas endast när enableEndPointDiscovery är inställt på true.

excludedLocations?: string[]

Egenskapsvärde

Ärvd frånSharedOptions.excludedLocations

(Avancerat användningsfall) Inledande rubriker att börja med när begäranden skickas till Cosmos

initialHeaders?: CosmosHeaders

Egenskapsvärde

ärvs frånSharedOptions.initialHeaders

Anger det föråldringsvärde som är associerat med begäran i Azure CosmosDB-tjänsten. För begäranden där <xref:com.azure.cosmos.ConsistencyLevel> är <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> eller <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>är svaren från den integrerade cachen garanterat inte inaktuella än det värde som anges av den här maxIntegratedCacheStaleness. När konsekvensnivån inte har angetts ignoreras den här egenskapen.

Standardvärdet är null

Cacheföråldring stöds i millisekunders kornighet. Allt som är mindre än millisekunder ignoreras.

maxIntegratedCacheStalenessInMs?: number

Egenskapsvärde

ärvd frånSharedOptions.maxIntegratedCacheStalenessInMs

Prioritetsnivå (låg/hög) för varje begäran. Begäranden med låg prioritet begränsas alltid före alla begäranden med hög prioritet.

Standardvärdet är null. Som standard har alla begäranden hög prioritet

priorityLevel?: PriorityLevel

Egenskapsvärde

ärvs frånSharedOptions.priorityLevel

Aktiverar/inaktiverar hämtar dokumentcontainerkvotrelaterad statistik för läsbegäranden för dokumentcontainer.

sessionToken?: string

Egenskapsvärde

ärvd frånSharedOptions.sessionToken

Dataflödesbucket för en begäran.

Standardvärdet är null. I det här fallet kan begäran använda 100% av partitionens dataflöde.

Mer information finns i [Cosmos DB dataput Bucketing](https://aka.ms/cosmsodb-bucketing).

throughputBucket?: number

Egenskapsvärde

Ärvd frånSharedOptions.throughputBucket