Share via

Items class

  • Ссылка
Пакет:
@azure/cosmos

Операции по созданию новых элементов, чтению и выполнению запросов ко всем элементам

См . раздел Item для чтения, замены или удаления существующего контейнера; используйте .item(id).

Свойства

container

Методы

batch(OperationInput[], PartitionKey, RequestOptions)

Выполнение транзакционных пакетных операций с элементами.

Пакетная служба принимает массив операций, типизированных в зависимости от того, что выполняет операция. Пакетная служба является транзакционной и будет откатывать все операции в случае сбоя. Доступны следующие варианты: Create, Upsert, Read, Replace и Delete.

Пример использования

// partitionKey is required as a second argument to batch, but defaults to the default partition key
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.batch(operations)
bulk(OperationInput[], BulkOptions, RequestOptions)

Выполнение массовых операций с элементами.

Массовая операция принимает массив операций, типизированный в зависимости от того, что делает операция. Доступны следующие варианты: Create, Upsert, Read, Replace и Delete.

Пример использования

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

Создание ChangeFeedIterator для итерации по страницам изменений
changeFeed(PartitionKey, ChangeFeedOptions)

Создание ChangeFeedIterator для итерации по страницам изменений

Пример

Чтение с начала канала изменений.

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

Создание ChangeFeedIterator для итерации по страницам изменений
changeFeed<T>(PartitionKey, ChangeFeedOptions)

Создание ChangeFeedIterator для итерации по страницам изменений
create<T>(T, RequestOptions)

Создайте элемент.

Любой указанный тип T не обязательно применяется пакетом SDK. Вы можете получить более или менее свойств, и ваша логика должна применять их.

Нет заданной схемы для элементов JSON. Они могут содержать любое количество настраиваемых свойств.
getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Возвращает итератор для итерации по страницам изменений. Возвращаемый итератор можно использовать для получения изменений для одного ключа секции, диапазона канала или всего контейнера.
query(string | SqlQuerySpec, FeedOptions)

Запрашивает все элементы.

Пример

Чтение всех элементов массива.

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)

Запрашивает все элементы.

Пример

Чтение всех элементов массива.

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)

Чтение всех элементов.

Нет заданной схемы для элементов JSON. Они могут содержать любое количество настраиваемых свойств.

Пример

Чтение всех элементов массива.

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

Чтение всех элементов.

Любой указанный тип T не обязательно применяется пакетом SDK. Вы можете получить более или менее свойств, и ваша логика должна применять их.

Нет заданной схемы для элементов JSON. Они могут содержать любое количество настраиваемых свойств.

Пример

Чтение всех элементов массива.

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

Создание ChangeFeedIterator для итерации по страницам изменений
readChangeFeed(PartitionKey, ChangeFeedOptions)

Создание ChangeFeedIterator для итерации по страницам изменений

Пример

Чтение с начала канала изменений.

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

Создание ChangeFeedIterator для итерации по страницам изменений
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Создание ChangeFeedIterator для итерации по страницам изменений
upsert(unknown, RequestOptions)

Upsert для элемента.

Нет заданной схемы для элементов JSON. Они могут содержать любое количество настраиваемых свойств.
upsert<T>(T, RequestOptions)

Upsert для элемента.

Любой указанный тип T не обязательно применяется пакетом SDK. Вы можете получить более или менее свойств, и ваша логика должна применять их.

Нет заданной схемы для элементов JSON. Они могут содержать любое количество настраиваемых свойств.

Сведения о свойстве

container 

container: Container

Значение свойства

Container

Сведения о методе

batch(OperationInput[], PartitionKey, RequestOptions)

Выполнение транзакционных пакетных операций с элементами.

Пакетная служба принимает массив операций, типизированных в зависимости от того, что выполняет операция. Пакетная служба является транзакционной и будет откатывать все операции в случае сбоя. Доступны следующие варианты: Create, Upsert, Read, Replace и Delete.

Пример использования

// partitionKey is required as a second argument to batch, but defaults to the default partition key
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.batch(operations)

function batch(operations: OperationInput[], partitionKey?: PartitionKey, options?: RequestOptions): Promise<Response_2<OperationResponse[]>>

Параметры

operations

OperationInput[]

Список операций. Ограничение 100

partitionKey
PartitionKey
options
RequestOptions

Используется для изменения запроса

Возвращаемое значение

Promise<Response_2<OperationResponse[]>>

bulk(OperationInput[], BulkOptions, RequestOptions)

Выполнение массовых операций с элементами.

Массовая операция принимает массив операций, типизированный в зависимости от того, что делает операция. Доступны следующие варианты: Create, Upsert, Read, Replace и Delete.

Пример использования

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

Параметры

operations

OperationInput[]

Список операций. Ограничение 100

bulkOptions
BulkOptions

Необязательный объект options для изменения массового поведения. Передайте { continueOnError: true } , чтобы продолжить выполнение операций при сбое. (по умолчанию — false) ** ПРИМЕЧАНИЕ. В ВЫПУСКЕ 4.0 ЗНАЧЕНИЕ ПО УМОЛЧАНИЮ БУДЕТ ИМЕТЬ ЗНАЧЕНИЕ TRUE.

options
RequestOptions

Используется для изменения запроса.

Возвращаемое значение

Promise<BulkOperationResponse>

changeFeed(ChangeFeedOptions)

Создание ChangeFeedIterator для итерации по страницам изменений

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

Параметры

changeFeedOptions
ChangeFeedOptions

Возвращаемое значение

ChangeFeedIterator<any>

changeFeed(PartitionKey, ChangeFeedOptions)

Создание ChangeFeedIterator для итерации по страницам изменений

Пример

Чтение с начала канала изменений.

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>

Параметры

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Возвращаемое значение

ChangeFeedIterator<any>

changeFeed<T>(ChangeFeedOptions)

Создание ChangeFeedIterator для итерации по страницам изменений

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

Параметры

changeFeedOptions
ChangeFeedOptions

Возвращаемое значение

ChangeFeedIterator<T>

changeFeed<T>(PartitionKey, ChangeFeedOptions)

Создание ChangeFeedIterator для итерации по страницам изменений

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

Параметры

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Возвращаемое значение

ChangeFeedIterator<T>

create<T>(T, RequestOptions)

Создайте элемент.

Любой указанный тип T не обязательно применяется пакетом SDK. Вы можете получить более или менее свойств, и ваша логика должна применять их.

Нет заданной схемы для элементов JSON. Они могут содержать любое количество настраиваемых свойств.

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

Параметры

body

T

Представляет текст элемента. Может содержать любое количество определяемых пользователем свойств.

options
RequestOptions

Используется для изменения запроса (например, указания ключа секции).

Возвращаемое значение

Promise<ItemResponse<T>>

getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

Возвращает итератор для итерации по страницам изменений. Возвращаемый итератор можно использовать для получения изменений для одного ключа секции, диапазона канала или всего контейнера.

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

Параметры

changeFeedIteratorOptions
ChangeFeedIteratorOptions

Возвращаемое значение

ChangeFeedPullModelIterator<T>

query(string | SqlQuerySpec, FeedOptions)

Запрашивает все элементы.

Пример

Чтение всех элементов массива.

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>

Параметры

query

string | SqlQuerySpec

Конфигурация запроса для операции. Дополнительные сведения о настройке запроса см. в статье SqlQuerySpec .

options
FeedOptions

Используется для изменения запроса (например, указания ключа секции).

Возвращаемое значение

QueryIterator<any>

query<T>(string | SqlQuerySpec, FeedOptions)

Запрашивает все элементы.

Пример

Чтение всех элементов массива.

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>

Параметры

query

string | SqlQuerySpec

Конфигурация запроса для операции. Дополнительные сведения о настройке запроса см. в статье SqlQuerySpec .

options
FeedOptions

Используется для изменения запроса (например, указания ключа секции).

Возвращаемое значение

QueryIterator<T>

readAll(FeedOptions)

Чтение всех элементов.

Нет заданной схемы для элементов JSON. Они могут содержать любое количество настраиваемых свойств.

Пример

Чтение всех элементов массива.

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

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

Параметры

options
FeedOptions

Используется для изменения запроса (например, указания ключа секции).

Возвращаемое значение

QueryIterator<ItemDefinition>

readAll<T>(FeedOptions)

Чтение всех элементов.

Любой указанный тип T не обязательно применяется пакетом SDK. Вы можете получить более или менее свойств, и ваша логика должна применять их.

Нет заданной схемы для элементов JSON. Они могут содержать любое количество настраиваемых свойств.

Пример

Чтение всех элементов массива.

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

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

Параметры

options
FeedOptions

Используется для изменения запроса (например, указания ключа секции).

Возвращаемое значение

QueryIterator<T>

readChangeFeed(ChangeFeedOptions)

Предупреждение

Теперь этот API является нерекомендуемым.

Use changeFeed instead.

Создание ChangeFeedIterator для итерации по страницам изменений

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

Параметры

changeFeedOptions
ChangeFeedOptions

Возвращаемое значение

ChangeFeedIterator<any>

readChangeFeed(PartitionKey, ChangeFeedOptions)

Предупреждение

Теперь этот API является нерекомендуемым.

Use changeFeed instead.

Создание ChangeFeedIterator для итерации по страницам изменений

Пример

Чтение с начала канала изменений.

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>

Параметры

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Возвращаемое значение

ChangeFeedIterator<any>

readChangeFeed<T>(ChangeFeedOptions)

Предупреждение

Теперь этот API является нерекомендуемым.

Use changeFeed instead.

Создание ChangeFeedIterator для итерации по страницам изменений

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

Параметры

changeFeedOptions
ChangeFeedOptions

Возвращаемое значение

ChangeFeedIterator<T>

readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

Предупреждение

Теперь этот API является нерекомендуемым.

Use changeFeed instead.

Создание ChangeFeedIterator для итерации по страницам изменений

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

Параметры

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

Возвращаемое значение

ChangeFeedIterator<T>

upsert(unknown, RequestOptions)

Upsert для элемента.

Нет заданной схемы для элементов JSON. Они могут содержать любое количество настраиваемых свойств.

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

Параметры

body

unknown

Представляет текст элемента. Может содержать любое количество определяемых пользователем свойств.

options
RequestOptions

Используется для изменения запроса (например, указания ключа секции).

Возвращаемое значение

Promise<ItemResponse<ItemDefinition>>

upsert<T>(T, RequestOptions)

Upsert для элемента.

Любой указанный тип T не обязательно применяется пакетом SDK. Вы можете получить более или менее свойств, и ваша логика должна применять их.

Нет заданной схемы для элементов JSON. Они могут содержать любое количество настраиваемых свойств.

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

Параметры

body

T

Представляет текст элемента. Может содержать любое количество определяемых пользователем свойств.

options
RequestOptions

Используется для изменения запроса (например, указания ключа секции).

Возвращаемое значение

Promise<ItemResponse<T>>