Поделиться через


Items class

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

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

Свойства

container

Методы

batch(OperationInput[], PartitionKey, RequestOptions)

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

Пакет принимает массив операций, типизированных на основе операций. Пакет является транзакционной и откатит все операции при сбое. Варианты: Create, Upsert, Read, Replace и Delete

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

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

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

Массовая операция принимает массив операций, типизированных на основе операций. Варианты: 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

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

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

batch(OperationInput[], PartitionKey, RequestOptions)

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

Пакет принимает массив операций, типизированных на основе операций. Пакет является транзакционной и откатит все операции при сбое. Варианты: Create, Upsert, Read, Replace и Delete

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

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

Параметры

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

Необязательный объект параметров для изменения массового поведения. Передайте { continueOnError: false } для остановки выполнения операций при сбое. (Значение по умолчанию — true)

options
RequestOptions

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

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

changeFeed(ChangeFeedOptions)

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

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

Параметры

changeFeedOptions
ChangeFeedOptions

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

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

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

changeFeed<T>(ChangeFeedOptions)

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

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

Параметры

changeFeedOptions
ChangeFeedOptions

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

changeFeed<T>(PartitionKey, ChangeFeedOptions)

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

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

Параметры

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

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

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

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

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

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

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

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

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

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

readAll(FeedOptions)

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

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

пример

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

const {body: containerList} = await items.readAll().fetchAll();
function readAll(options?: FeedOptions): QueryIterator<ItemDefinition>

Параметры

options
FeedOptions

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

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

readAll<T>(FeedOptions)

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

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

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

пример

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

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

Параметры

options
FeedOptions

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

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

readChangeFeed(ChangeFeedOptions)

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

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

Use changeFeed instead.

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

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

Параметры

changeFeedOptions
ChangeFeedOptions

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

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

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

readChangeFeed<T>(ChangeFeedOptions)

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

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

Use changeFeed instead.

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

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

Параметры

changeFeedOptions
ChangeFeedOptions

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

readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

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

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

Use changeFeed instead.

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

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

Параметры

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

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

upsert(unknown, RequestOptions)

Upsert элемент.

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

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

Параметры

body

unknown

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

options
RequestOptions

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

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

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