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

Databases class

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

Операции по созданию новых баз данных и чтению и запросу всех баз данных

Сведения о чтении или удалении существующей базы данных см. в базы данных; используйте client.database(id).

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

Свойства

client

Методы

create(DatabaseRequest, RequestOptions)

Отправьте запрос на создание базы данных.

База данных управляет пользователями, разрешениями и набором контейнеров. Каждая учетная запись базы данных Azure Cosmos DB может поддерживать несколько независимых именованных баз данных, при этом база данных является логическим контейнером для данных.

Каждая база данных состоит из одного или нескольких контейнеров, каждый из которых, в свою очередь, содержит один или несколько документов. Так как базы данных являются административным ресурсом, главный ключ службы будет необходим для доступа и успешного выполнения любых действий с помощью API-интерфейсов пользователей.
createIfNotExists(DatabaseRequest, RequestOptions)

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

База данных управляет пользователями, разрешениями и набором контейнеров. Каждая учетная запись базы данных Azure Cosmos DB может поддерживать несколько независимых именованных баз данных, при этом база данных является логическим контейнером для данных.

Каждая база данных состоит из одного или нескольких контейнеров, каждый из которых, в свою очередь, содержит один или несколько документов. Так как базы данных являются административным ресурсом, главный ключ службы потребуется для доступа и успешного выполнения любых действий с помощью API-интерфейсов пользователей.
query(string | SqlQuerySpec, FeedOptions)

Запрашивает все базы данных.

пример

Чтение всех баз данных для массива. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); *

query<T>(string | SqlQuerySpec, FeedOptions)

Запрашивает все базы данных.

пример

Чтение всех баз данных для массива. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); *

readAll(FeedOptions)

Считывает все базы данных.

пример

Чтение всех баз данных для массива. * typescript * const {body: databaseList} = await client.databases.readAll().fetchAll(); *

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

client 

client: CosmosClient

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

CosmosClient

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

create(DatabaseRequest, RequestOptions)

Отправьте запрос на создание базы данных.

База данных управляет пользователями, разрешениями и набором контейнеров. Каждая учетная запись базы данных Azure Cosmos DB может поддерживать несколько независимых именованных баз данных, при этом база данных является логическим контейнером для данных.

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

function create(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>

Параметры

body
DatabaseRequest

DatabaseDefinition, представляющий созданный базы данных.

options
RequestOptions

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

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

Promise<DatabaseResponse>

createIfNotExists(DatabaseRequest, RequestOptions)

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

База данных управляет пользователями, разрешениями и набором контейнеров. Каждая учетная запись базы данных Azure Cosmos DB может поддерживать несколько независимых именованных баз данных, при этом база данных является логическим контейнером для данных.

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

function createIfNotExists(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>

Параметры

body
DatabaseRequest

DatabaseDefinition, представляющий созданный базы данных.

options
RequestOptions

Дополнительные параметры запроса

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

Promise<DatabaseResponse>

query(string | SqlQuerySpec, FeedOptions)

Запрашивает все базы данных.

пример

Чтение всех баз данных для массива. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); * 

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

Параметры

query

string | SqlQuerySpec

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

options
FeedOptions

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

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

QueryIterator<any>

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

query<T>(string | SqlQuerySpec, FeedOptions)

Запрашивает все базы данных.

пример

Чтение всех баз данных для массива. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); * 

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

Параметры

query

string | SqlQuerySpec

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

options
FeedOptions

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

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

QueryIterator<T>

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

readAll(FeedOptions)

Считывает все базы данных.

пример

Чтение всех баз данных для массива. * typescript * const {body: databaseList} = await client.databases.readAll().fetchAll(); * 

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

Параметры

options
FeedOptions

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

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

QueryIterator<DatabaseDefinition & Resource>

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