Ejemplos de Python para Azure Cosmos DBAzure Cosmos DB Python examples

SE APLICA A: SQL API

En el repositorio de GitHub azure-documentdb-python se incluyen soluciones de ejemplo que realizan operaciones CRUD y otras operaciones comunes sobre recursos de Azure Cosmos DB.Sample solutions that do CRUD operations and other common operations on Azure Cosmos DB resources are included in the azure-documentdb-python GitHub repository. Este artículo ofrece:This article provides:

  • Vínculos a las tareas de cada uno de los archivos de proyecto de ejemplo de Python.Links to the tasks in each of the Python example project files.
  • Vínculos al contenido de referencia de la API relacionada.Links to the related API reference content.

Requisitos previosPrerequisites

Ejemplos de base de datosDatabase examples

En el ejemplo database_management.py de Python, se muestra cómo realizar las siguientes tareas.The database_management.py Python sample shows how to do the following tasks. Para información sobre las bases de datos de Azure Cosmos antes de ejecutar los siguientes ejemplos, consulte el artículo conceptual Uso de bases de datos, contenedores y elementos.To learn about the Azure Cosmos databases before running the following samples, see Working with databases, containers, and items conceptual article.

TareaTask Referencia de APIAPI reference
Creación de una base de datosCreate a database CosmosClient.create_databaseCosmosClient.create_database
Lectura de una base de datos por identificadorRead a database by ID CosmosClient.get_database_clientCosmosClient.get_database_client
Enumeración de las bases de datosQuery the databases CosmosClient.query_databasesCosmosClient.query_databases
Enumeración de las bases de datos de una cuentaList databases for an account CosmosClient.list_databasesCosmosClient.list_databases
Eliminación de una base de datosDelete a database CosmosClient.delete_databaseCosmosClient.delete_database

Ejemplos de contenedorContainer examples

En el ejemplo container_management.py de Python, se muestra cómo realizar las siguientes tareas.The container_management.py Python sample shows how to do the following tasks. Para información sobre las colecciones de Azure Cosmos antes de ejecutar los siguientes ejemplos, consulte el artículo conceptual Uso de bases de datos, contenedores y elementos.To learn about the Azure Cosmos collections before running the following samples, see Working with databases, containers, and items conceptual article.

TareaTask Referencia de APIAPI reference
Búsqueda de un contenedorQuery for a container database.query_containersdatabase.query_containers
Creación de un contenedorCreate a container database.create_containerdatabase.create_container
Lectura de todos los contenedores de una base de datosList all the containers in a database database.list_containersdatabase.list_containers
Obtención de un contenedor por su identificadorGet a container by its ID database.get_container_clientdatabase.get_container_client
Administración del rendimiento aprovisionado del contenedorManage container's provisioned throughput container.read_offer, container.replace_throughputcontainer.read_offer, container.replace_throughput
Eliminación de un contenedorDelete a container database.delete_containerdatabase.delete_container

Ejemplos de elementosItem examples

En el ejemplo item_management.py de Python, se muestra cómo realizar las siguientes tareas.The item_management.py Python sample shows how to do the following tasks. Para información sobre los documentos de Azure Cosmos antes de ejecutar los ejemplos siguientes, consulte el artículo conceptual Uso de bases de datos, contenedores y elementos.To learn about the Azure Cosmos documents before running the following samples, see Working with databases, containers, and items conceptual article.

TareaTask Referencia de APIAPI reference
Creación de los elementos de un contenedorCreate items in a container container.create_itemcontainer.create_item
Lectura de un elemento por su identificadorRead an item by its ID container.read_itemcontainer.read_item
Lectura de todos los elementos de un contenedorRead all the items in a container container.read_all_itemscontainer.read_all_items
Consulta de un elemento por su identificadorQuery an item by its ID container.query_itemscontainer.query_items
Reemplazo de un elementoReplace an item container.replace_itemscontainer.replace_items
Realización de una operación upsert en un elementoUpsert an item container.upsert_itemcontainer.upsert_item
Eliminación de un elementoDelete an item container.delete_itemcontainer.delete_item
Obtención de la fuente de cambios de los elementos de un contenedorGet the change feed of items in a container container.query_items_change_feedcontainer.query_items_change_feed

Ejemplos de indizaciónIndexing examples

En el ejemplo index_management.py de Python, se muestra cómo realizar las siguientes tareas.The index_management.py Python sample shows how to do the following tasks. Para información sobre la indexación en Azure Cosmos DB antes de ejecutar los ejemplos siguientes, consulte los artículos conceptuales sobre las directivas de indexación, los tipos de indexación y las rutas de acceso de indexación.To learn about indexing in Azure Cosmos DB before running the following samples, see indexing policies, indexing types, and indexing paths conceptual articles.

TareaTask Referencia de APIAPI reference
Exclusión de un elemento determinado para la indexaciónExclude a specific item from indexing documents.IndexingDirective.Excludedocuments.IndexingDirective.Exclude
Indexación manual con elementos específicos indexadosUse manual indexing with specific items indexed documents.IndexingDirective.Includedocuments.IndexingDirective.Include
Exclusión de rutas de acceso de la indexaciónExclude paths from indexing Definición de las rutas de acceso que se van a excluir en la propiedad IndexingPolicyDefine paths to exclude in IndexingPolicy property
Uso de índices de intervalo en cadenasUse range indexes on strings Defina la directiva de indexación con índices de intervalo en el tipo de datos de cadena.Define indexing policy with range indexes on string data type. 'kind': documents.IndexKind.Range, 'dataType': documents.DataType.String'kind': documents.IndexKind.Range, 'dataType': documents.DataType.String
Realización de una transformación de índicesPerform an index transformation database.replace_container (use la directiva de indexación actualizada)database.replace_container (use the updated indexing policy)
Uso de exámenes cuando solo existe un índice de hash en la ruta de accesoUse scans when only hash index exists on the path Establecimiento de enable_scan_in_query=True y enable_cross_partition_query=True al consultar los elementosset the enable_scan_in_query=True and enable_cross_partition_query=True when querying the items