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


CosmosClient class

Предоставляет логическое представление учетной записи базы данных 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 получения сведений о базе данных после получения объекта Database .

Пример

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

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

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

offers

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

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

offers: Offers

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

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

database(string)

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

При этом не выполняется сетевой вызов. Используйте для .read получения сведений о базе данных после получения объекта Database .

Пример

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

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

Пример

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

await client.database("<id here>").delete();
function database(id: string): Database

Параметры

id

string

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

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

dispose()

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

function dispose()

getDatabaseAccount(RequestOptions)

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

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

Параметры

options
RequestOptions

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

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

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

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