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


Containers class

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

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

Примечание. Все эти операции выполняют вызовы к фиксированному бюджету. Вы должны спроектировать систему таким образом, чтобы эти вызовы масштабироваться подстрока с приложением. Например, не вызывайте containers.readAll() перед каждым вызовом item.read() , чтобы убедиться, что контейнер существует. Это можно сделать один раз при запуске приложения.

Конструкторы

Containers(Database, ClientContext)

Свойства

database

Методы

create(ContainerRequest, RequestOptions)

Создает контейнер.

Контейнер — это именованный логический контейнер для элементов.

База данных может содержать ноль или несколько именованных контейнеров, а каждый контейнер состоит из нуля или нескольких элементов JSON.

Элементы в контейнере не должны совместно использовать одну и ту же структуру или поля.

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

createIfNotExists(ContainerRequest, RequestOptions)

Проверяет, существует ли контейнер, и в противном случае создает его. При этом будет выполнена операция чтения на основе идентификатора bodyв , а затем, если он не найден, операция создания. Убедитесь, что выходные данные соответствуют переданному тексту для свойств, отличных от стандартных (например, политики индексирования и т. д.).

Контейнер — это именованный логический контейнер для элементов.

База данных может содержать ноль или несколько именованных контейнеров, а каждый контейнер состоит из нуля или нескольких элементов JSON.

Элементы в контейнере не должны совместно использовать одну и ту же структуру или поля.

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

query(SqlQuerySpec, FeedOptions)

Запрашивает все контейнеры.

Пример

Чтение всех контейнеров для массива. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *

query<T>(SqlQuerySpec, FeedOptions)

Запрашивает все контейнеры.

Пример

Чтение всех контейнеров для массива. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *

readAll(FeedOptions)

Чтение всех контейнеров.

Пример

Чтение всех контейнеров для массива. * typescript * const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll(); *

Сведения о конструкторе

Containers(Database, ClientContext)

new Containers(database: Database, clientContext: ClientContext)

Параметры

database
Database
clientContext

ClientContext

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

database

database: Database

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

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

create(ContainerRequest, RequestOptions)

Создает контейнер.

Контейнер — это именованный логический контейнер для элементов.

База данных может содержать ноль или несколько именованных контейнеров, а каждый контейнер состоит из нуля или нескольких элементов JSON.

Элементы в контейнере не должны совместно использовать одну и ту же структуру или поля.

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

function create(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>

Параметры

body
ContainerRequest

Представляет текст контейнера.

options
RequestOptions

Используется для задания таких параметров, как размер страницы ответа, маркеры продолжения и т. д.

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

createIfNotExists(ContainerRequest, RequestOptions)

Проверяет, существует ли контейнер, и в противном случае создает его. При этом будет выполнена операция чтения на основе идентификатора bodyв , а затем, если он не найден, операция создания. Убедитесь, что выходные данные соответствуют переданному тексту для свойств, отличных от стандартных (например, политики индексирования и т. д.).

Контейнер — это именованный логический контейнер для элементов.

База данных может содержать ноль или несколько именованных контейнеров, а каждый контейнер состоит из нуля или нескольких элементов JSON.

Элементы в контейнере не должны совместно использовать одну и ту же структуру или поля.

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

function createIfNotExists(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>

Параметры

body
ContainerRequest

Представляет текст контейнера.

options
RequestOptions

Используется для задания таких параметров, как размер страницы ответа, маркеры продолжения и т. д.

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

query(SqlQuerySpec, FeedOptions)

Запрашивает все контейнеры.

Пример

Чтение всех контейнеров для массива. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *

function query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>

Параметры

query
SqlQuerySpec

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

options
FeedOptions

Используется для задания таких параметров, как размер страницы ответа, маркеры продолжения и т. д.

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

QueryIterator Позволяет возвращать определенные контейнеры в массиве или выполнять итерацию по одному за раз. *

query<T>(SqlQuerySpec, FeedOptions)

Запрашивает все контейнеры.

Пример

Чтение всех контейнеров для массива. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *

function query<T>(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

Параметры

query
SqlQuerySpec

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

options
FeedOptions

Используется для задания таких параметров, как размер страницы ответа, маркеры продолжения и т. д.

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

QueryIterator Позволяет возвращать определенные контейнеры в массиве или выполнять итерацию по одному за раз. *

readAll(FeedOptions)

Чтение всех контейнеров.

Пример

Чтение всех контейнеров для массива. * typescript * const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll(); *

function readAll(options?: FeedOptions): QueryIterator<ContainerDefinition & Resource>

Параметры

options
FeedOptions

Используется для задания таких параметров, как размер страницы ответа, маркеры продолжения и т. д.

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

QueryIterator Позволяет возвращать все контейнеры в массиве или выполнять итерацию по одному. *