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

CosmosClient class

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

Предоставляет логическое представление учетной записи базы данных Azure Cosmos DB на стороне клиента. Этот клиент используется для настройки и выполнения запросов в службе базы данных Azure Cosmos DB.

пример

Создание экземпляра клиента и создание новой базы данных

const client = new CosmosClient({endpoint: "<URL HERE>", key: "<KEY HERE>"});
await client.databases.create({id: "<database name here>"});

пример

Создание экземпляра клиента с помощью настраиваемой политики подключения

const client = new CosmosClient({
   endpoint: "<URL HERE>",
   key: "<KEY HERE>",
   connectionPolicy: {
    requestTimeout: 10000,
   },
});

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

CosmosClient(CosmosClientOptions)

Создает новый объект CosmosClient. Дополнительные сведения об используемых параметрах см. в CosmosClientOptions.
CosmosClient(string)

Создает новый объект CosmosClient из строки подключения. Строку подключения к базе данных можно найти на портале Azure

Свойства

databases

Используется для создания новых баз данных или запроса и чтения всех баз данных.

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

пример

Создание базы данных

const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});
offers

Используется для запроса & чтения всех предложений.

Используйте .offer(id) для чтения или замены существующих предложений.

Методы

database(string)

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

Это не делает сетевой вызов. Используйте .read, чтобы получить сведения о базе данных после получения объекта базы данных.

пример

Создание контейнера из существующей базы данных

const container = client.database("<database id>").containers.create("<container id>");

пример

Удаление существующей базы данных

await client.database("<id here>").delete();
dispose()

Очищает средство обновления фоновой конечной точки. Используйте client.dispose() при уничтожении CosmosClient в другом процессе.
getDatabaseAccount(RequestOptions)

Получение сведений о текущей DatabaseAccount (включая поддерживаемые регионы и т. д.)
getReadEndpoint()

Возвращает используемую в настоящее время конечную точку чтения. Полезно для устранения неполадок.

URL-адрес может содержать суффикс региона (например, "-eastus"), если мы используем определенные конечные точки расположения.
getReadEndpoints()

Возвращает используемую в настоящее время конечную точку чтения. Полезно для устранения неполадок.

URL-адрес может содержать суффикс региона (например, "-eastus"), если мы используем определенные конечные точки расположения.
getWriteEndpoint()

Возвращает url-адрес конечной точки записи, используемой в настоящее время. Полезно для устранения неполадок.

URL-адрес может содержать суффикс региона (например, "-eastus"), если мы используем определенные конечные точки расположения.
getWriteEndpoints()

Возвращает известные конечные точки записи. Полезно для устранения неполадок.

URL-адреса могут содержать суффикс региона (например, "-eastus"), если мы используем определенные конечные точки расположения.
offer(string)

Используется для чтения или обновления существующего предложения по идентификатору.

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

CosmosClient(CosmosClientOptions)

Создает новый объект CosmosClient. Дополнительные сведения об используемых параметрах см. в CosmosClientOptions.

new CosmosClient(options: CosmosClientOptions)

Параметры

options
CosmosClientOptions

мешок параметров; Требуется настроить по крайней мере конечную точку и проверку подлинности.

CosmosClient(string)

Создает новый объект CosmosClient из строки подключения. Строку подключения к базе данных можно найти на портале Azure

new CosmosClient(connectionString: string)

Параметры

connectionString

string

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

databases

Используется для создания новых баз данных или запроса и чтения всех баз данных.

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

пример

Создание базы данных

const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});

databases: Databases

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

Databases

offers

Используется для запроса & чтения всех предложений.

Используйте .offer(id) для чтения или замены существующих предложений.

offers: Offers

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

Offers

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

database(string)

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

Это не делает сетевой вызов. Используйте .read, чтобы получить сведения о базе данных после получения объекта базы данных.

пример

Создание контейнера из существующей базы данных

const container = client.database("<database id>").containers.create("<container id>");

пример

Удаление существующей базы данных

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

function database(id: string): Database

Параметры

id

string

Идентификатор базы данных.

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

Database

dispose()

Очищает средство обновления фоновой конечной точки. Используйте client.dispose() при уничтожении CosmosClient в другом процессе.

function dispose()

getDatabaseAccount(RequestOptions)

Получение сведений о текущей DatabaseAccount (включая поддерживаемые регионы и т. д.)

function getDatabaseAccount(options?: RequestOptions): Promise<ResourceResponse<DatabaseAccount>>

Параметры

options
RequestOptions

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

Promise<ResourceResponse<DatabaseAccount>>

getReadEndpoint()

Возвращает используемую в настоящее время конечную точку чтения. Полезно для устранения неполадок.

URL-адрес может содержать суффикс региона (например, "-eastus"), если мы используем определенные конечные точки расположения.

function getReadEndpoint(): Promise<string>

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

Promise<string>

getReadEndpoints()

Возвращает используемую в настоящее время конечную точку чтения. Полезно для устранения неполадок.

URL-адрес может содержать суффикс региона (например, "-eastus"), если мы используем определенные конечные точки расположения.

function getReadEndpoints(): Promise<readonly string[]>

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

Promise<readonly string[]>

getWriteEndpoint()

Возвращает url-адрес конечной точки записи, используемой в настоящее время. Полезно для устранения неполадок.

URL-адрес может содержать суффикс региона (например, "-eastus"), если мы используем определенные конечные точки расположения.

function getWriteEndpoint(): Promise<string>

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

Promise<string>

getWriteEndpoints()

Возвращает известные конечные точки записи. Полезно для устранения неполадок.

URL-адреса могут содержать суффикс региона (например, "-eastus"), если мы используем определенные конечные точки расположения.

function getWriteEndpoints(): Promise<readonly string[]>

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

Promise<readonly string[]>

offer(string)

Используется для чтения или обновления существующего предложения по идентификатору.

function offer(id: string): Offer

Параметры

id

string

Идентификатор предложения.

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

Offer