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 Позволяет возвращать все базы данных в массиве или выполнять итерацию по одной за раз. *