Dela via


Containers class

Åtgärder för att skapa nya containrar och läsa/fråga alla containrar

Se Container för att läsa, ersätta eller ta bort en befintlig container. använd .container(id).

Obs! Alla dessa åtgärder gör anrop mot en fast budget. Du bör utforma systemet så att dessa anrop skalas sublineärt med ditt program. Anropa containers.readAll() till exempel inte före varje enskilt item.read() anrop för att säkerställa att containern finns. Gör detta en gång när programmet startas.

Konstruktorer

Containers(Database, ClientContext)

Egenskaper

database

Metoder

create(ContainerRequest, RequestOptions)

Skapar en container.

En container är en namngiven logisk container för objekt.

En databas kan innehålla noll eller flera namngivna containrar och varje container består av noll eller flera JSON-objekt.

Eftersom objekten i en container är schemafria behöver de inte dela samma struktur eller fält.

Eftersom containrar är programresurser kan de auktoriseras med antingen huvudnyckeln eller resursnycklarna.

createIfNotExists(ContainerRequest, RequestOptions)

Kontrollerar om det finns en container och skapar den om den inte gör det. Detta gör en läsåtgärd baserat på ID:t i body, och om den inte hittas, en skapandeåtgärd. Du bör bekräfta att utdata matchar brödtexten som du skickade för icke-standardegenskaper (t.ex. indexeringsprincip/etc.)

En container är en namngiven logisk container för objekt.

En databas kan innehålla noll eller flera namngivna containrar och varje container består av noll eller flera JSON-objekt.

Eftersom objekten i en container är schemafria behöver de inte dela samma struktur eller fält.

Eftersom containrar är programresurser kan de auktoriseras med antingen huvudnyckeln eller resursnycklarna.

query(SqlQuerySpec, FeedOptions)

Kör frågor mot alla containrar.

Exempel

Läs alla containrar till matrisen. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *

query<T>(SqlQuerySpec, FeedOptions)

Kör frågor mot alla containrar.

Exempel

Läs alla containrar till matrisen. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *

readAll(FeedOptions)

Läs alla containrar.

Exempel

Läs alla containrar till matrisen. * typescript * const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll(); *

Konstruktorinformation

Containers(Database, ClientContext)

new Containers(database: Database, clientContext: ClientContext)

Parametrar

database
Database
clientContext

ClientContext

Egenskapsinformation

database

database: Database

Egenskapsvärde

Metodinformation

create(ContainerRequest, RequestOptions)

Skapar en container.

En container är en namngiven logisk container för objekt.

En databas kan innehålla noll eller flera namngivna containrar och varje container består av noll eller flera JSON-objekt.

Eftersom objekten i en container är schemafria behöver de inte dela samma struktur eller fält.

Eftersom containrar är programresurser kan de auktoriseras med antingen huvudnyckeln eller resursnycklarna.

function create(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>

Parametrar

body
ContainerRequest

Representerar containerns brödtext.

options
RequestOptions

Använd för att ange alternativ som svarssidans storlek, fortsättningstoken osv.

Returer

createIfNotExists(ContainerRequest, RequestOptions)

Kontrollerar om det finns en container och skapar den om den inte gör det. Detta gör en läsåtgärd baserat på ID:t i body, och om den inte hittas, en skapandeåtgärd. Du bör bekräfta att utdata matchar brödtexten som du skickade för icke-standardegenskaper (t.ex. indexeringsprincip/etc.)

En container är en namngiven logisk container för objekt.

En databas kan innehålla noll eller flera namngivna containrar och varje container består av noll eller flera JSON-objekt.

Eftersom objekten i en container är schemafria behöver de inte dela samma struktur eller fält.

Eftersom containrar är programresurser kan de auktoriseras med antingen huvudnyckeln eller resursnycklarna.

function createIfNotExists(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>

Parametrar

body
ContainerRequest

Representerar containerns brödtext.

options
RequestOptions

Använd för att ange alternativ som svarssidans storlek, fortsättningstoken osv.

Returer

query(SqlQuerySpec, FeedOptions)

Kör frågor mot alla containrar.

Exempel

Läs alla containrar till matrisen. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *

function query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>

Parametrar

query
SqlQuerySpec

Frågekonfiguration för åtgärden. Mer information om hur du konfigurerar en fråga finns i SqlQuerySpec .

options
FeedOptions

Använd för att ange alternativ som svarssidans storlek, fortsättningstoken osv.

Returer

QueryIterator Gör att du kan returnera specifika containrar i en matris eller iterera över dem en i taget. *

query<T>(SqlQuerySpec, FeedOptions)

Kör frågor mot alla containrar.

Exempel

Läs alla containrar till matrisen. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *

function query<T>(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

Parametrar

query
SqlQuerySpec

Frågekonfiguration för åtgärden. Mer information om hur du konfigurerar en fråga finns i SqlQuerySpec .

options
FeedOptions

Använd för att ange alternativ som svarssidans storlek, fortsättningstoken osv.

Returer

QueryIterator Gör att du kan returnera specifika containrar i en matris eller iterera över dem en i taget. *

readAll(FeedOptions)

Läs alla containrar.

Exempel

Läs alla containrar till matrisen. * typescript * const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll(); *

function readAll(options?: FeedOptions): QueryIterator<ContainerDefinition & Resource>

Parametrar

options
FeedOptions

Använd för att ange alternativ som svarssidans storlek, fortsättningstoken osv.

Returer

QueryIterator Gör att du kan returnera alla containrar i en matris eller iterera över dem en i taget. *