Items class
Új elemek létrehozására és az összes elem olvasására/lekérdezésére szolgáló műveletek
A meglévő tárolók olvasásához, cseréjéhez vagy törléséhez tekintse meg elem; .item(id)
használata.
Tulajdonságok
container |
Metódusok
batch(Operation |
Tranzakciós kötegműveletek végrehajtása elemeken. A Batch egy művelettömböt vesz fel, amely a művelet működése alapján van begépelve. A Batch tranzakciós, és minden műveletet visszaállít, ha az egyik sikertelen. A lehetőségek a következők: Létrehozás, Felolvasás, Olvasás, Csere és Törlés Használati példa:
|
bulk(Operation |
Tömeges műveletek végrehajtása elemeken. A Tömeges művelet a művelet végrehajtása alapján beírt műveletek tömbje. A lehetőségek a következők: Létrehozás, Felolvasás, Olvasás, Csere és Törlés Használati példa:
|
change |
|
change |
példa Olvasás a változáscsatorna elejétől.
|
change |
|
change |
|
create<T>(T, Request |
Hozzon létre egy elemet. A megadott típusokat (T) az SDK nem feltétlenül kényszeríti ki. Előfordulhat, hogy több vagy kevesebb tulajdonságot kap, és a logikán múlik, hogy kikényszerítse azt. JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak. |
get |
Egy iterátort ad vissza a módosítások oldalainak iterálásához. A visszaadott iterátor egy partíciókulcs, adatcsatornatartomány vagy egy teljes tároló módosításainak beolvasására használható. |
query(string | Sql |
Az összes elemet lekérdezi. példa Olvassa el az összes elemet a tömbben.
|
query<T>(string | Sql |
Az összes elemet lekérdezi. példa Olvassa el az összes elemet a tömbben.
|
read |
Olvassa el az összes elemet. JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak. példa Olvassa el az összes elemet a tömbben.
|
read |
Olvassa el az összes elemet. A megadott típusokat (T) az SDK nem feltétlenül kényszeríti ki. Előfordulhat, hogy több vagy kevesebb tulajdonságot kap, és a logikán múlik, hogy kikényszerítse azt. JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak. példa Olvassa el az összes elemet a tömbben.
|
read |
|
read |
példa Olvasás a változáscsatorna elejétől.
|
read |
|
read |
|
upsert(unknown, Request |
Elem beszúrása. JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak. |
upsert<T>(T, Request |
Elem beszúrása. A megadott típusokat (T) az SDK nem feltétlenül kényszeríti ki. Előfordulhat, hogy több vagy kevesebb tulajdonságot kap, és a logikán múlik, hogy kikényszerítse azt. JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak. |
Tulajdonság adatai
container
Metódus adatai
batch(OperationInput[], PartitionKey, RequestOptions)
Tranzakciós kötegműveletek végrehajtása elemeken.
A Batch egy művelettömböt vesz fel, amely a művelet működése alapján van begépelve. A Batch tranzakciós, és minden műveletet visszaállít, ha az egyik sikertelen. A lehetőségek a következők: Létrehozás, Felolvasás, Olvasás, Csere és Törlés
Használati példa:
// 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[]>>
Paraméterek
- operations
Műveletek listája. Korlát 100
- partitionKey
- PartitionKey
- options
- RequestOptions
A kérelem módosítására szolgál
Válaszok
Promise<Response_2<OperationResponse[]>>
bulk(OperationInput[], BulkOptions, RequestOptions)
Tömeges műveletek végrehajtása elemeken.
A Tömeges művelet a művelet végrehajtása alapján beírt műveletek tömbje. A lehetőségek a következők: Létrehozás, Felolvasás, Olvasás, Csere és Törlés
Használati példa:
// 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>
Paraméterek
- operations
Műveletek listája. Korlát 100
- bulkOptions
- BulkOptions
A választható beállítások objektuma a tömeges viselkedés módosításához. {continueOnError: false} passzával leállítja a műveletek végrehajtását, ha az egyik sikertelen. (Alapértelmezett érték: igaz)
- options
- RequestOptions
A kérés módosítására szolgál.
Válaszok
Promise<BulkOperationResponse>
changeFeed(ChangeFeedOptions)
ChangeFeedIterator
létrehozása a módosítások oldalainak iterálásához
function changeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>
Paraméterek
- changeFeedOptions
- ChangeFeedOptions
Válaszok
ChangeFeedIterator<any>
changeFeed(PartitionKey, ChangeFeedOptions)
ChangeFeedIterator
létrehozása a módosítások oldalainak iterálásához
példa
Olvasás a változáscsatorna elejétől.
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>
Paraméterek
- partitionKey
- PartitionKey
- changeFeedOptions
- ChangeFeedOptions
Válaszok
ChangeFeedIterator<any>
changeFeed<T>(ChangeFeedOptions)
ChangeFeedIterator
létrehozása a módosítások oldalainak iterálásához
function changeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>
Paraméterek
- changeFeedOptions
- ChangeFeedOptions
Válaszok
changeFeed<T>(PartitionKey, ChangeFeedOptions)
ChangeFeedIterator
létrehozása a módosítások oldalainak iterálásához
function changeFeed<T>(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>
Paraméterek
- partitionKey
- PartitionKey
- changeFeedOptions
- ChangeFeedOptions
Válaszok
create<T>(T, RequestOptions)
Hozzon létre egy elemet.
A megadott típusokat (T) az SDK nem feltétlenül kényszeríti ki. Előfordulhat, hogy több vagy kevesebb tulajdonságot kap, és a logikán múlik, hogy kikényszerítse azt.
JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.
function create<T>(body: T, options?: RequestOptions): Promise<ItemResponse<T>>
Paraméterek
- body
-
T
Az elem törzsét jelöli. Tetszőleges számú felhasználó által definiált tulajdonságot tartalmazhat.
- options
- RequestOptions
A kérés módosítására szolgál (például a partíciókulcs megadására).
Válaszok
Promise<ItemResponse<T>>
getChangeFeedIterator<T>(ChangeFeedIteratorOptions)
Egy iterátort ad vissza a módosítások oldalainak iterálásához. A visszaadott iterátor egy partíciókulcs, adatcsatornatartomány vagy egy teljes tároló módosításainak beolvasására használható.
function getChangeFeedIterator<T>(changeFeedIteratorOptions?: ChangeFeedIteratorOptions): ChangeFeedPullModelIterator<T>
Paraméterek
- changeFeedIteratorOptions
- ChangeFeedIteratorOptions
Válaszok
query(string | SqlQuerySpec, FeedOptions)
Az összes elemet lekérdezi.
példa
Olvassa el az összes elemet a tömbben.
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>
Paraméterek
- query
-
string | SqlQuerySpec
Lekérdezéskonfiguráció a művelethez. A lekérdezés konfigurálásáról további információt SqlQuerySpec talál.
- options
- FeedOptions
A kérés módosítására szolgál (például a partíciókulcs megadására).
Válaszok
QueryIterator<any>
query<T>(string | SqlQuerySpec, FeedOptions)
Az összes elemet lekérdezi.
példa
Olvassa el az összes elemet a tömbben.
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>
Paraméterek
- query
-
string | SqlQuerySpec
Lekérdezéskonfiguráció a művelethez. A lekérdezés konfigurálásáról további információt SqlQuerySpec talál.
- options
- FeedOptions
A kérés módosítására szolgál (például a partíciókulcs megadására).
Válaszok
readAll(FeedOptions)
Olvassa el az összes elemet.
JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.
példa
Olvassa el az összes elemet a tömbben.
const {body: containerList} = await items.readAll().fetchAll();
function readAll(options?: FeedOptions): QueryIterator<ItemDefinition>
Paraméterek
- options
- FeedOptions
A kérés módosítására szolgál (például a partíciókulcs megadására).
Válaszok
readAll<T>(FeedOptions)
Olvassa el az összes elemet.
A megadott típusokat (T) az SDK nem feltétlenül kényszeríti ki. Előfordulhat, hogy több vagy kevesebb tulajdonságot kap, és a logikán múlik, hogy kikényszerítse azt.
JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.
példa
Olvassa el az összes elemet a tömbben.
const {body: containerList} = await items.readAll().fetchAll();
function readAll<T>(options?: FeedOptions): QueryIterator<T>
Paraméterek
- options
- FeedOptions
A kérés módosítására szolgál (például a partíciókulcs megadására).
Válaszok
readChangeFeed(ChangeFeedOptions)
Figyelmeztetés
Ez az API már elavult.
Use changeFeed
instead.
ChangeFeedIterator
létrehozása a módosítások oldalainak iterálásához
function readChangeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>
Paraméterek
- changeFeedOptions
- ChangeFeedOptions
Válaszok
ChangeFeedIterator<any>
readChangeFeed(PartitionKey, ChangeFeedOptions)
Figyelmeztetés
Ez az API már elavult.
Use changeFeed
instead.
ChangeFeedIterator
létrehozása a módosítások oldalainak iterálásához
példa
Olvasás a változáscsatorna elejétől.
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>
Paraméterek
- partitionKey
- PartitionKey
- changeFeedOptions
- ChangeFeedOptions
Válaszok
ChangeFeedIterator<any>
readChangeFeed<T>(ChangeFeedOptions)
Figyelmeztetés
Ez az API már elavult.
Use changeFeed
instead.
ChangeFeedIterator
létrehozása a módosítások oldalainak iterálásához
function readChangeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>
Paraméterek
- changeFeedOptions
- ChangeFeedOptions
Válaszok
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)
Figyelmeztetés
Ez az API már elavult.
Use changeFeed
instead.
ChangeFeedIterator
létrehozása a módosítások oldalainak iterálásához
function readChangeFeed<T>(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>
Paraméterek
- partitionKey
- PartitionKey
- changeFeedOptions
- ChangeFeedOptions
Válaszok
upsert(unknown, RequestOptions)
Elem beszúrása.
JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.
function upsert(body: unknown, options?: RequestOptions): Promise<ItemResponse<ItemDefinition>>
Paraméterek
- body
-
unknown
Az elem törzsét jelöli. Tetszőleges számú felhasználó által definiált tulajdonságot tartalmazhat.
- options
- RequestOptions
A kérés módosítására szolgál (például a partíciókulcs megadására).
Válaszok
Promise<ItemResponse<ItemDefinition>>
upsert<T>(T, RequestOptions)
Elem beszúrása.
A megadott típusokat (T) az SDK nem feltétlenül kényszeríti ki. Előfordulhat, hogy több vagy kevesebb tulajdonságot kap, és a logikán múlik, hogy kikényszerítse azt.
JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.
function upsert<T>(body: T, options?: RequestOptions): Promise<ItemResponse<T>>
Paraméterek
- body
-
T
Az elem törzsét jelöli. Tetszőleges számú felhasználó által definiált tulajdonságot tartalmazhat.
- options
- RequestOptions
A kérés módosítására szolgál (például a partíciókulcs megadására).
Válaszok
Promise<ItemResponse<T>>