Udostępnij za pośrednictwem

Items class

  • Odwołanie
Pakiet:
@azure/cosmos

Operacje tworzenia nowych elementów i odczytywania/wykonywania zapytań dotyczących wszystkich elementów

Zobacz Item w celu odczytywania, zastępowania lub usuwania istniejącego kontenera; użyj .item(id).

Właściwości

container

Metody

batch(OperationInput[], PartitionKey, RequestOptions)

Wykonywanie transakcyjnych operacji wsadowych na elementach.

Usługa Batch przyjmuje tablicę operacji, które są typizowane na podstawie operacji. Usługa Batch jest transakcyjna i wycofa wszystkie operacje, jeśli zakończy się niepowodzeniem. Dostępne opcje to: Tworzenie, upsert, odczyt, zastępowanie i usuwanie

Przykład użycia:

// 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")
bulk(OperationInput[], BulkOptions, RequestOptions)

Wykonywanie operacji zbiorczych na elementach.

Zbiorczo przyjmuje tablicę operacji, które są wpisywane na podstawie tego, co robi operacja. Dostępne opcje to: Tworzenie, upsert, odczyt, zastępowanie i usuwanie

Przykład użycia:

// 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)
changeFeed(ChangeFeedOptions)

Tworzenie ChangeFeedIterator w celu iterowania stron zmian
changeFeed(PartitionKey, ChangeFeedOptions)

Tworzenie ChangeFeedIterator w celu iterowania stron zmian

Przykład

Odczytaj od początku zestawienia zmian.

const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();
changeFeed<T>(ChangeFeedOptions)

Tworzenie ChangeFeedIterator w celu iterowania stron zmian
changeFeed<T>(PartitionKey, ChangeFeedOptions)

Tworzenie ChangeFeedIterator w celu iterowania stron zmian
create<T>(T, RequestOptions)

Utwórz element.

Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.
getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Zwraca iterator do iteracji na stronach zmian. Zwrócony iterator może służyć do pobierania zmian dla pojedynczego klucza partycji, zakresu kanału informacyjnego lub całego kontenera.
query(string | SqlQuerySpec, FeedOptions)

Wykonuje zapytanie o wszystkie elementy.

Przykład

Odczytaj wszystkie elementy do tablicy.

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();
query<T>(string | SqlQuerySpec, FeedOptions)

Wykonuje zapytanie o wszystkie elementy.

Przykład

Odczytaj wszystkie elementy do tablicy.

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();
readAll(FeedOptions)

Odczytaj wszystkie elementy.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.

Przykład

Odczytaj wszystkie elementy do tablicy.

const {body: containerList} = await items.readAll().fetchAll();
readAll<T>(FeedOptions)

Odczytaj wszystkie elementy.

Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.

Przykład

Odczytaj wszystkie elementy do tablicy.

const {body: containerList} = await items.readAll().fetchAll();
readChangeFeed(ChangeFeedOptions)

Tworzenie ChangeFeedIterator w celu iterowania stron zmian
readChangeFeed(PartitionKey, ChangeFeedOptions)

Tworzenie ChangeFeedIterator w celu iterowania stron zmian

Przykład

Odczytaj od początku zestawienia zmian.

const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();
readChangeFeed<T>(ChangeFeedOptions)

Tworzenie ChangeFeedIterator w celu iterowania stron zmian
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Tworzenie ChangeFeedIterator w celu iterowania stron zmian
upsert(unknown, RequestOptions)

Upsert elementu.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.
upsert<T>(T, RequestOptions)

Upsert elementu.

Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.

Szczegóły właściwości

container 

container: Container

Wartość właściwości

Container

Szczegóły metody

batch(OperationInput[], PartitionKey, RequestOptions)

Wykonywanie transakcyjnych operacji wsadowych na elementach.

Usługa Batch przyjmuje tablicę operacji, które są typizowane na podstawie operacji. Usługa Batch jest transakcyjna i wycofa wszystkie operacje, jeśli zakończy się niepowodzeniem. Dostępne opcje to: Tworzenie, upsert, odczyt, zastępowanie i usuwanie

Przykład użycia:

// 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[]>>

Parametry

operations

OperationInput[]

Lista operacji. Limit 100

partitionKey
PartitionKey
options
RequestOptions

Służy do modyfikowania żądania

Zwraca

Promise<Response_2<OperationResponse[]>>

bulk(OperationInput[], BulkOptions, RequestOptions)

Wykonywanie operacji zbiorczych na elementach.

Zbiorczo przyjmuje tablicę operacji, które są wpisywane na podstawie tego, co robi operacja. Dostępne opcje to: Tworzenie, upsert, odczyt, zastępowanie i usuwanie

Przykład użycia:

// 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>

Parametry

operations

OperationInput[]

Lista operacji. Limit 100

bulkOptions
BulkOptions

Opcjonalny obiekt opcji, aby zmodyfikować zachowanie zbiorcze. Przekaż { continueOnError: false } , aby zatrzymać wykonywanie operacji w przypadku niepowodzenia. (Wartości domyślne to true)

options
RequestOptions

Służy do modyfikowania żądania.

Zwraca

Promise<BulkOperationResponse>

changeFeed(ChangeFeedOptions)

Tworzenie ChangeFeedIterator w celu iterowania stron zmian

function changeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>

Parametry

changeFeedOptions
ChangeFeedOptions

Zwraca

ChangeFeedIterator<any>

changeFeed(PartitionKey, ChangeFeedOptions)

Tworzenie ChangeFeedIterator w celu iterowania stron zmian

Przykład

Odczytaj od początku zestawienia zmian.

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>

Parametry

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Zwraca

ChangeFeedIterator<any>

changeFeed<T>(ChangeFeedOptions)

Tworzenie ChangeFeedIterator w celu iterowania stron zmian

function changeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>

Parametry

changeFeedOptions
ChangeFeedOptions

Zwraca

ChangeFeedIterator<T>

changeFeed<T>(PartitionKey, ChangeFeedOptions)

Tworzenie ChangeFeedIterator w celu iterowania stron zmian

function changeFeed<T>(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>

Parametry

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Zwraca

ChangeFeedIterator<T>

create<T>(T, RequestOptions)

Utwórz element.

Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.

function create<T>(body: T, options?: RequestOptions): Promise<ItemResponse<T>>

Parametry

body

T

Reprezentuje treść elementu. Może zawierać dowolną liczbę właściwości zdefiniowanych przez użytkownika.

options
RequestOptions

Służy do modyfikowania żądania (na przykład określania klucza partycji).

Zwraca

Promise<ItemResponse<T>>

getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Zwraca iterator do iteracji na stronach zmian. Zwrócony iterator może służyć do pobierania zmian dla pojedynczego klucza partycji, zakresu kanału informacyjnego lub całego kontenera.

function getChangeFeedIterator<T>(changeFeedIteratorOptions?: ChangeFeedIteratorOptions): ChangeFeedPullModelIterator<T>

Parametry

changeFeedIteratorOptions
ChangeFeedIteratorOptions

Zwraca

ChangeFeedPullModelIterator<T>

query(string | SqlQuerySpec, FeedOptions)

Wykonuje zapytanie o wszystkie elementy.

Przykład

Odczytaj wszystkie elementy do tablicy.

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>

Parametry

query

string | SqlQuerySpec

Wykonywanie zapytań o konfigurację operacji. Aby uzyskać więcej informacji na temat konfigurowania zapytania, zobacz SqlQuerySpec.

options
FeedOptions

Służy do modyfikowania żądania (na przykład określania klucza partycji).

Zwraca

QueryIterator<any>

query<T>(string | SqlQuerySpec, FeedOptions)

Wykonuje zapytanie o wszystkie elementy.

Przykład

Odczytaj wszystkie elementy do tablicy.

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>

Parametry

query

string | SqlQuerySpec

Wykonywanie zapytań o konfigurację operacji. Aby uzyskać więcej informacji na temat konfigurowania zapytania, zobacz SqlQuerySpec.

options
FeedOptions

Służy do modyfikowania żądania (na przykład określania klucza partycji).

Zwraca

QueryIterator<T>

readAll(FeedOptions)

Odczytaj wszystkie elementy.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.

Przykład

Odczytaj wszystkie elementy do tablicy.

const {body: containerList} = await items.readAll().fetchAll();

function readAll(options?: FeedOptions): QueryIterator<ItemDefinition>

Parametry

options
FeedOptions

Służy do modyfikowania żądania (na przykład określania klucza partycji).

Zwraca

QueryIterator<ItemDefinition>

readAll<T>(FeedOptions)

Odczytaj wszystkie elementy.

Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.

Przykład

Odczytaj wszystkie elementy do tablicy.

const {body: containerList} = await items.readAll().fetchAll();

function readAll<T>(options?: FeedOptions): QueryIterator<T>

Parametry

options
FeedOptions

Służy do modyfikowania żądania (na przykład określania klucza partycji).

Zwraca

QueryIterator<T>

readChangeFeed(ChangeFeedOptions)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use changeFeed instead.

Tworzenie ChangeFeedIterator w celu iterowania stron zmian

function readChangeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>

Parametry

changeFeedOptions
ChangeFeedOptions

Zwraca

ChangeFeedIterator<any>

readChangeFeed(PartitionKey, ChangeFeedOptions)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use changeFeed instead.

Tworzenie ChangeFeedIterator w celu iterowania stron zmian

Przykład

Odczytaj od początku zestawienia zmian.

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>

Parametry

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Zwraca

ChangeFeedIterator<any>

readChangeFeed<T>(ChangeFeedOptions)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use changeFeed instead.

Tworzenie ChangeFeedIterator w celu iterowania stron zmian

function readChangeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>

Parametry

changeFeedOptions
ChangeFeedOptions

Zwraca

ChangeFeedIterator<T>

readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use changeFeed instead.

Tworzenie ChangeFeedIterator w celu iterowania stron zmian

function readChangeFeed<T>(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>

Parametry

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Zwraca

ChangeFeedIterator<T>

upsert(unknown, RequestOptions)

Upsert elementu.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.

function upsert(body: unknown, options?: RequestOptions): Promise<ItemResponse<ItemDefinition>>

Parametry

body

unknown

Reprezentuje treść elementu. Może zawierać dowolną liczbę właściwości zdefiniowanych przez użytkownika.

options
RequestOptions

Służy do modyfikowania żądania (na przykład określania klucza partycji).

Zwraca

Promise<ItemResponse<ItemDefinition>>

upsert<T>(T, RequestOptions)

Upsert elementu.

Każdy podany typ T nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to logika, aby ją wymusić.

Brak ustawionego schematu dla elementów JSON. Mogą zawierać dowolną liczbę właściwości niestandardowych.

function upsert<T>(body: T, options?: RequestOptions): Promise<ItemResponse<T>>

Parametry

body

T

Reprezentuje treść elementu. Może zawierać dowolną liczbę właściwości zdefiniowanych przez użytkownika.

options
RequestOptions

Służy do modyfikowania żądania (na przykład określania klucza partycji).

Zwraca

Promise<ItemResponse<T>>