cosmos Пакет

Пакеты

aio

Модули

auth

Вспомогательные функции авторизации в службе базы данных Azure Cosmos.

container

Создание, чтение, обновление и удаление элементов в службе API SQL Azure Cosmos DB.

cosmos_client

Создание, чтение и удаление баз данных в службе API SQL Azure Cosmos DB.

database

Взаимодействие с базами данных в службе API SQL Azure Cosmos DB.

diagnostics

Средства диагностики для операций службы базы данных Azure Cosmos.

documents

Классы и перечисления для документов в службе базы данных Azure Cosmos.

errors

Исключения для конкретной службы в службе базы данных Azure Cosmos.

.. предупреждение. Этот модуль не рекомендуется. Взамен рекомендуется использовать azure.cosmos.exceptions.

exceptions

Исключения для конкретной службы в службе базы данных Azure Cosmos.

http_constants

Константы HTTP в службе базы данных Azure Cosmos.

offer

Создайте свойства пропускной способности в службе API SQL Для Azure Cosmos DB.

partition_key

Создание ключей секций в службе API SQL Azure Cosmos DB.

permission

Создание разрешений в службе API SQL Azure Cosmos DB.

scripts

Создание, чтение, обновление, удаление и выполнение скриптов в службе API SQL Azure Cosmos DB.

user

Создание, чтение, обновление и удаление пользователей в службе API SQL Azure Cosmos DB.

Классы

ConnectionRetryPolicy
ConsistencyLevel

Представляет уровни согласованности, поддерживаемые для клиентских операций Azure Cosmos.

Запрошенный consistencyLevel должен соответствовать или быть слабее, чем подготовленная для учетной записи базы данных. Уровни согласованности.

Уровни согласованности по порядку прочности: Strong, BoundedStaleness, Session, ConsistentPrefix и Eventual.

ContainerProxy

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

Экземпляр этого класса не следует создавать напрямую. Вместо этого используйте get_container_client метод , чтобы получить существующий контейнер, или create_container метод для создания нового контейнера.

Контейнер в базе данных API SQL Azure Cosmos DB — это коллекция документов, каждый из которых представлен в виде элемента.

CosmosClient

Логическое представление учетной записи Azure Cosmos DB на стороне клиента.

Используйте этот клиент для настройки и выполнения запросов к службе Azure Cosmos DB.

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

Инициализация CosmosClient — это тяжелая операция. Не используйте инициализацию экземпляров CosmosClient в качестве учетных данных или проверки сетевого подключения.

Создайте экземпляр нового CosmosClient.

DataType

Указывает тип данных спецификаций индекса.

DatabaseAccount

Учетная запись базы данных.

DatabaseAccount — это контейнер для баз данных.

DatabaseProxy

Интерфейс для взаимодействия с определенной базой данных.

Экземпляр этого класса не следует создавать напрямую. Вместо этого используйте get_database_client метод .

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

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

База данных API SQL Azure Cosmos DB имеет следующие системные свойства. Эти свойства доступны только для чтения:

  • _rid: идентификатор ресурса.

  • _ts: время последнего обновления ресурса. Значение — метка времени.

  • _self: уникальный адресируемый URI для ресурса.

  • _etag: тег ресурса, необходимый для управления оптимистическим параллелизмом.

  • _colls: адресуемый путь к ресурсу коллекций.

  • _users: адресный путь к ресурсу users.

IndexKind

Указывает тип индекса спецификаций индекса.

IndexingMode

Задает поддерживаемые режимы индексирования.

PartitionKey

Ключ, используемый для секционирования контейнера на логические секции.

Сведения о выборе ключей секций см https://docs.microsoft.com/azure/cosmos-db/partitioning-overview#choose-partitionkey . в этой статье.

Permission

Представляет объект Permission в службе API SQL Azure Cosmos DB.

PermissionMode

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

ProxyConfiguration

Конфигурация для прокси-сервера.

SSLConfiguration

Конфигурация ssl-подключений.

Подробнее см. в разделе https://requests.readthedocs.io/en/master/user/advanced/#ssl-cert-verification.

ScriptsProxy

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

Экземпляр этого класса не следует создавать напрямую. Вместо этого используйте scripts атрибут .

ThroughputProperties

Представляет свойства пропускной способности в контейнере API SQL Для Azure Cosmos DB.

Для чтения и обновления свойств пропускной способности используйте связанные методы в <xref:Container>. При настройке автоматического масштабирования необходимо задать auto_scale_max_throughput и auto_scale_increment_percent также можно задать вместе с ним. Значение offer_throughput не будет разрешено задавать в сочетании с параметрами автомасштабирования.

TriggerOperation

Указывает операции, для которых должен выполняться триггер.

TriggerType

Указывает тип триггера.

UserProxy

Интерфейс для взаимодействия с конкретным пользователем.

Экземпляр этого класса не следует создавать напрямую. Вместо этого используйте get_user_client метод .