Items class
Bewerkingen voor het maken van nieuwe items en het lezen/opvragen van alle items
Zie Item voor het lezen, vervangen of verwijderen van een bestaande container; .item(id)gebruiken.
Eigenschappen
| container |
Methoden
| batch(Operation |
Voer transactionele batchbewerkingen uit op items. Batch gebruikt een matrix met bewerkingen die worden getypt op basis van wat de bewerking doet. Batch is transactioneel en zet alle bewerkingen terug als er een mislukt. De opties zijn: Maken, Upsert, Lezen, Vervangen en Verwijderen Gebruiksvoorbeeld: |
| bulk(Operation |
Voer bulkbewerkingen uit op items. Bulksgewijs gebruikt een matrix met bewerkingen die worden getypt op basis van wat de bewerking doet. De opties zijn: Maken, Upsert, Lezen, Vervangen en Verwijderen Gebruiksvoorbeeld: |
| change |
Een |
| change |
Een voorbeeld van Lees vanaf het begin van de wijzigingenfeed. |
| change |
Een |
| change |
Een |
| create<T>(T, Request |
Maak een item. Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om deze af te dwingen. Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten. |
| get |
Hiermee wordt een iterator geretourneerd om pagina's met wijzigingen te herhalen. De geretourneerde iterator kan worden gebruikt om wijzigingen op te halen voor één partitiesleutel, feedbereik of een hele container. |
| query(string | Sql |
Hiermee worden alle items opgevraagd. voorbeeld van Alle items naar matrix lezen. |
| query<T>(string | Sql |
Hiermee worden alle items opgevraagd. voorbeeld van Alle items naar matrix lezen. |
| read |
Alle items lezen. Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten. voorbeeld van Alle items naar matrix lezen. |
| read |
Alle items lezen. Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om deze af te dwingen. Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten. voorbeeld van Alle items naar matrix lezen. |
| read |
Een |
| read |
Een voorbeeld van Lees vanaf het begin van de wijzigingenfeed. |
| read |
Een |
| read |
Een |
| upsert(unknown, Request |
Upsert een item. Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten. |
| upsert<T>(T, Request |
Upsert een item. Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om deze af te dwingen. Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten. |
Eigenschapdetails
container
Methodedetails
batch(OperationInput[], PartitionKey, RequestOptions)
Voer transactionele batchbewerkingen uit op items.
Batch gebruikt een matrix met bewerkingen die worden getypt op basis van wat de bewerking doet. Batch is transactioneel en zet alle bewerkingen terug als er een mislukt. De opties zijn: Maken, Upsert, Lezen, Vervangen en Verwijderen
Gebruiksvoorbeeld:
// The partitionKey is a required second argument. If it’s undefined, it defaults to the expected partition key format.
const operations: OperationInput[] = [
{
operationType: "Create",
resourceBody: { id: "doc1", name: "sample", key: "A" }
},
{
operationType: "Upsert",
resourceBody: { id: "doc2", name: "other", key: "A" }
}
]
await database.container.items.batch(operations, "A")
function batch(operations: OperationInput[], partitionKey?: PartitionKey, options?: RequestOptions): Promise<Response_2<OperationResponse[]>>Parameters
- operations
Lijst met bewerkingen. Limiet 100
- partitionKey
- PartitionKey
- options
- RequestOptions
Wordt gebruikt voor het wijzigen van de aanvraag
Retouren
Promise<Response_2<OperationResponse[]>>
bulk(OperationInput[], BulkOptions, RequestOptions)
Voer bulkbewerkingen uit op items.
Bulksgewijs gebruikt een matrix met bewerkingen die worden getypt op basis van wat de bewerking doet. De opties zijn: Maken, Upsert, Lezen, Vervangen en Verwijderen
Gebruiksvoorbeeld:
// partitionKey is optional at the top level if present in the resourceBody
const operations: OperationInput[] = [
{
operationType: "Create",
resourceBody: { id: "doc1", name: "sample", key: "A" }
},
{
operationType: "Upsert",
partitionKey: 'A',
resourceBody: { id: "doc2", name: "other", key: "A" }
}
]
await database.container.items.bulk(operations)
function bulk(operations: OperationInput[], bulkOptions?: BulkOptions, options?: RequestOptions): Promise<BulkOperationResponse>Parameters
- operations
Lijst met bewerkingen. Limiet 100
- bulkOptions
- BulkOptions
Optionele optiesobject om bulkgedrag te wijzigen. Pass { continueOnError: false } om te stoppen met het uitvoeren van bewerkingen wanneer er een mislukt. (Standaard ingesteld op true)
- options
- RequestOptions
Wordt gebruikt voor het wijzigen van de aanvraag.
Retouren
Promise<BulkOperationResponse>
changeFeed(ChangeFeedOptions)
Een ChangeFeedIterator maken om pagina's met wijzigingen te herhalen
function changeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>Parameters
- changeFeedOptions
- ChangeFeedOptions
Retouren
ChangeFeedIterator<any>
changeFeed(PartitionKey, ChangeFeedOptions)
Een ChangeFeedIterator maken om pagina's met wijzigingen te herhalen
voorbeeld van
Lees vanaf het begin van de wijzigingenfeed.
const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();
function changeFeed(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>Parameters
- partitionKey
- PartitionKey
- changeFeedOptions
- ChangeFeedOptions
Retouren
ChangeFeedIterator<any>
changeFeed<T>(ChangeFeedOptions)
Een ChangeFeedIterator maken om pagina's met wijzigingen te herhalen
function changeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>Parameters
- changeFeedOptions
- ChangeFeedOptions
Retouren
changeFeed<T>(PartitionKey, ChangeFeedOptions)
Een ChangeFeedIterator maken om pagina's met wijzigingen te herhalen
function changeFeed<T>(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>Parameters
- partitionKey
- PartitionKey
- changeFeedOptions
- ChangeFeedOptions
Retouren
create<T>(T, RequestOptions)
Maak een item.
Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om deze af te dwingen.
Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten.
function create<T>(body: T, options?: RequestOptions): Promise<ItemResponse<T>>Parameters
- body
-
T
Vertegenwoordigt de hoofdtekst van het item. Kan een willekeurig aantal door de gebruiker gedefinieerde eigenschappen bevatten.
- options
- RequestOptions
Wordt gebruikt voor het wijzigen van de aanvraag (bijvoorbeeld het opgeven van de partitiesleutel).
Retouren
Promise<ItemResponse<T>>
getChangeFeedIterator<T>(ChangeFeedIteratorOptions)
Hiermee wordt een iterator geretourneerd om pagina's met wijzigingen te herhalen. De geretourneerde iterator kan worden gebruikt om wijzigingen op te halen voor één partitiesleutel, feedbereik of een hele container.
function getChangeFeedIterator<T>(changeFeedIteratorOptions?: ChangeFeedIteratorOptions): ChangeFeedPullModelIterator<T>Parameters
- changeFeedIteratorOptions
- ChangeFeedIteratorOptions
Retouren
query(string | SqlQuerySpec, FeedOptions)
Hiermee worden alle items opgevraagd.
voorbeeld van
Alle items naar matrix lezen.
const querySpec: SqlQuerySpec = {
query: "SELECT * FROM Families f WHERE f.lastName = @lastName",
parameters: [
{name: "@lastName", value: "Hendricks"}
]
};
const {result: items} = await items.query(querySpec).fetchAll();
function query(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<any>Parameters
- query
-
string | SqlQuerySpec
Queryconfiguratie voor de bewerking. Zie SqlQuerySpec- voor meer informatie over het configureren van een query.
- options
- FeedOptions
Wordt gebruikt voor het wijzigen van de aanvraag (bijvoorbeeld het opgeven van de partitiesleutel).
Retouren
QueryIterator<any>
query<T>(string | SqlQuerySpec, FeedOptions)
Hiermee worden alle items opgevraagd.
voorbeeld van
Alle items naar matrix lezen.
const querySpec: SqlQuerySpec = {
query: "SELECT firstname FROM Families f WHERE f.lastName = @lastName",
parameters: [
{name: "@lastName", value: "Hendricks"}
]
};
const {result: items} = await items.query<{firstName: string}>(querySpec).fetchAll();
function query<T>(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<T>Parameters
- query
-
string | SqlQuerySpec
Queryconfiguratie voor de bewerking. Zie SqlQuerySpec- voor meer informatie over het configureren van een query.
- options
- FeedOptions
Wordt gebruikt voor het wijzigen van de aanvraag (bijvoorbeeld het opgeven van de partitiesleutel).
Retouren
readAll(FeedOptions)
Alle items lezen.
Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten.
voorbeeld van
Alle items naar matrix lezen.
const {body: containerList} = await items.readAll().fetchAll();
function readAll(options?: FeedOptions): QueryIterator<ItemDefinition>Parameters
- options
- FeedOptions
Wordt gebruikt voor het wijzigen van de aanvraag (bijvoorbeeld het opgeven van de partitiesleutel).
Retouren
readAll<T>(FeedOptions)
Alle items lezen.
Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om deze af te dwingen.
Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten.
voorbeeld van
Alle items naar matrix lezen.
const {body: containerList} = await items.readAll().fetchAll();
function readAll<T>(options?: FeedOptions): QueryIterator<T>Parameters
- options
- FeedOptions
Wordt gebruikt voor het wijzigen van de aanvraag (bijvoorbeeld het opgeven van de partitiesleutel).
Retouren
readChangeFeed(ChangeFeedOptions)
Waarschuwing
Deze API is nu afgeschaft.
Use changeFeed instead.
Een ChangeFeedIterator maken om pagina's met wijzigingen te herhalen
function readChangeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>Parameters
- changeFeedOptions
- ChangeFeedOptions
Retouren
ChangeFeedIterator<any>
readChangeFeed(PartitionKey, ChangeFeedOptions)
Waarschuwing
Deze API is nu afgeschaft.
Use changeFeed instead.
Een ChangeFeedIterator maken om pagina's met wijzigingen te herhalen
voorbeeld van
Lees vanaf het begin van de wijzigingenfeed.
const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();
function readChangeFeed(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>Parameters
- partitionKey
- PartitionKey
- changeFeedOptions
- ChangeFeedOptions
Retouren
ChangeFeedIterator<any>
readChangeFeed<T>(ChangeFeedOptions)
Waarschuwing
Deze API is nu afgeschaft.
Use changeFeed instead.
Een ChangeFeedIterator maken om pagina's met wijzigingen te herhalen
function readChangeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>Parameters
- changeFeedOptions
- ChangeFeedOptions
Retouren
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)
Waarschuwing
Deze API is nu afgeschaft.
Use changeFeed instead.
Een ChangeFeedIterator maken om pagina's met wijzigingen te herhalen
function readChangeFeed<T>(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>Parameters
- partitionKey
- PartitionKey
- changeFeedOptions
- ChangeFeedOptions
Retouren
upsert(unknown, RequestOptions)
Upsert een item.
Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten.
function upsert(body: unknown, options?: RequestOptions): Promise<ItemResponse<ItemDefinition>>Parameters
- body
-
unknown
Vertegenwoordigt de hoofdtekst van het item. Kan een willekeurig aantal door de gebruiker gedefinieerde eigenschappen bevatten.
- options
- RequestOptions
Wordt gebruikt voor het wijzigen van de aanvraag (bijvoorbeeld het opgeven van de partitiesleutel).
Retouren
Promise<ItemResponse<ItemDefinition>>
upsert<T>(T, RequestOptions)
Upsert een item.
Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om deze af te dwingen.
Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten.
function upsert<T>(body: T, options?: RequestOptions): Promise<ItemResponse<T>>Parameters
- body
-
T
Vertegenwoordigt de hoofdtekst van het item. Kan een willekeurig aantal door de gebruiker gedefinieerde eigenschappen bevatten.
- options
- RequestOptions
Wordt gebruikt voor het wijzigen van de aanvraag (bijvoorbeeld het opgeven van de partitiesleutel).
Retouren
Promise<ItemResponse<T>>