Database class

Пакет:

@azure/cosmos

Операции чтения или удаления существующей базы данных.

См. Databases сведения о создании новых баз данных, чтении и запросе всех баз данных; используйте client.databases.

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

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

Database(CosmosClient, string, ClientContext)

Возвращает новый экземпляр Database. Примечание. Цель состоит в том, чтобы получить этот объект с CosmosClient помощью client.database(id), а не для создания его экземпляра самостоятельно.

Свойства

client
containers	Используется для создания новых контейнеров или выполнения запросов и чтения всех контейнеров. Используется .database(id) для чтения, замены или удаления определенного существующего Database по идентификатору. Пример Создает контейнер. const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});
id
url	Возвращает URL-адрес ссылки на ресурс. Используется для связывания в разрешениях.
users	Используется для создания новых пользователей или выполнения запросов и чтения всех пользователей. Используется .user(id) для чтения, замены или удаления определенного существующего User по идентификатору.

Методы

container(string)	Используется для чтения, замены или удаления определенного существующего Database по идентификатору. Используйте создание .containers новых контейнеров или запрос или чтение всех контейнеров. Пример Удаление контейнера await client.database("<db id>").container("<container id>").delete();
delete(RequestOptions)	Удалите указанную базу данных.
read(RequestOptions)	Чтение определения данной базы данных.
readOffer(RequestOptions)	Возвращает предложение в базе данных. Если его нет, возвращается значение OfferResponse с неопределенным значением.
user(string)	Используется для чтения, замены или удаления определенного существующего User по идентификатору. Используется .users для создания новых пользователей, а также для запросов и чтения всех пользователей.

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

Database(CosmosClient, string, ClientContext)

Возвращает новый экземпляр Database. Примечание. Цель состоит в том, чтобы получить этот объект с CosmosClient помощью client.database(id), а не для создания его экземпляра самостоятельно.

new Database(client: CosmosClient, id: string, clientContext: ClientContext)

Параметры

client

CosmosClient

id

string

clientContext

ClientContext

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

client

client: CosmosClient

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

CosmosClient

containers

Используется для создания новых контейнеров или выполнения запросов и чтения всех контейнеров. Используется .database(id) для чтения, замены или удаления определенного существующего Database по идентификатору.

Пример

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

const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});

containers: Containers

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

Containers

id

id: string

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

string

url

Возвращает URL-адрес ссылки на ресурс. Используется для связывания в разрешениях.

string url

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

string

users

Используется для создания новых пользователей или выполнения запросов и чтения всех пользователей. Используется .user(id) для чтения, замены или удаления определенного существующего User по идентификатору.

users: Users

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

Users

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

container(string)

Используется для чтения, замены или удаления определенного существующего Database по идентификатору. Используйте создание .containers новых контейнеров или запрос или чтение всех контейнеров.

Пример

Удаление контейнера

await client.database("<db id>").container("<container id>").delete();

function container(id: string): Container

Параметры

id

string

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

Container

delete(RequestOptions)

Удалите указанную базу данных.

function delete(options?: RequestOptions): Promise<DatabaseResponse>

Параметры

options

RequestOptions

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

Promise<DatabaseResponse>

read(RequestOptions)

Чтение определения данной базы данных.

function read(options?: RequestOptions): Promise<DatabaseResponse>

Параметры

options

RequestOptions

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

Promise<DatabaseResponse>

readOffer(RequestOptions)

Возвращает предложение в базе данных. Если его нет, возвращается значение OfferResponse с неопределенным значением.

function readOffer(options?: RequestOptions): Promise<OfferResponse>

Параметры

options

RequestOptions

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

Promise<OfferResponse>

user(string)

Используется для чтения, замены или удаления определенного существующего User по идентификатору. Используется .users для создания новых пользователей, а также для запросов и чтения всех пользователей.

function user(id: string): User

Параметры

id

string

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

User