SDK de .NET V3 de Azure Cosmos DB (Microsoft.Azure.Cosmos) para la SQL APIAzure Cosmos DB.NET V3 SDK (Microsoft.Azure.Cosmos) examples for the SQL API

SE APLICA A: SQL API

El repositorio azure-cosmos-dotnet-v3 de GitHub incluye ejemplos de las soluciones .NET más recientes que realizan operaciones CRUD y otras operaciones comunes en recursos de Azure Cosmos DB.The azure-cosmos-dotnet-v3 GitHub repository includes the latest .NET sample solutions to perform CRUD and other common operations on Azure Cosmos DB resources. Si ya está familiarizado con la versión anterior del SDK de .NET, puede que esté acostumbrado a los términos "colección" y "documento".If you're familiar with the previous version of the .NET SDK, you may be used to the terms collection and document. Dado que Azure Cosmos DB admite varios modelos de API, la versión 3.0 del SDK de .NET usa los términos genéricos "contenedor" y "elemento".Because Azure Cosmos DB supports multiple API models, version 3.0 of the .NET SDK uses the generic terms "container" and "item". Un contenedor puede ser una colección, un grafo o una tabla.A container can be a collection, graph, or table. Un elemento puede ser un documento, un vértice o borde, o una fila, y es el contenido que hay en un contenedor.An item can be a document, edge/vertex, or row, and is the content inside a container. Este artículo ofrece:This article provides:

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

PrerrequisitosPrerequisites

Visual Studio 2019 con el flujo de trabajo de desarrollo de Azure instaladoVisual Studio 2019 with the Azure development workflow installed

Una suscripción a Azure o una cuenta de evaluación gratuita de Cosmos DBAn Azure subscription or free Cosmos DB trial account

Nota

Los ejemplos son independientes y se configuran y limpian por sí solos después.The samples are self-contained, and set up and clean up after themselves. Con cada repetición se factura una hora de uso en su suscripción en el nivel de rendimiento del contenedor.Each occurrence bills your subscription for one hour of usage in your container's performance tier.

Ejemplos de base de datosDatabase examples

El método RunDatabaseDemo del ejemplo del proyecto DatabaseManagement muestra cómo realizar las tareas siguientes.The RunDatabaseDemo method of the sample DatabaseManagement project shows how to do the following tasks. Para más información sobre las bases de datos de Azure Cosmos antes de ejecutar los siguientes ejemplos, consulte Uso de bases de datos, contenedores y elementos.To learn about Azure Cosmos databases before you run the following samples, see Work with databases, containers, and items.

TareaTask Referencia de APIAPI reference
Creación de una base de datosCreate a database CosmosClient.CreateDatabaseIfNotExistsAsyncCosmosClient.CreateDatabaseIfNotExistsAsync
Lectura de una base de datos por identificadorRead a database by ID Database.ReadAsyncDatabase.ReadAsync
Lectura de todas las bases de datos de una cuentaRead all the databases for an account CosmosClient.GetDatabaseQueryIteratorCosmosClient.GetDatabaseQueryIterator
Eliminación de una base de datosDelete a database Database.DeleteAsyncDatabase.DeleteAsync

Ejemplos de contenedorContainer examples

El método RunContainerDemo del proyecto ContainerManagement de ejemplo muestra cómo realizar las tareas siguientes.The RunContainerDemo method of the sample ContainerManagement project shows how to do the following tasks. Para más información sobre los contenedores de Azure Cosmos antes de ejecutar los siguientes ejemplos, consulte Uso de bases de datos, contenedores y elementos.To learn about Azure Cosmos containers before you run the following samples, see Work with databases, containers, and items.

TareaTask Referencia de APIAPI reference
Creación de un contenedorCreate a container Database.CreateContainerIfNotExistsAsyncDatabase.CreateContainerIfNotExistsAsync
Creación de un contenedor con una directiva de índice personalizadaCreate a container with custom index policy Database.CreateContainerIfNotExistsAsyncDatabase.CreateContainerIfNotExistsAsync
Cambio del rendimiento configurado de un contenedorChange configured performance of a container Container.ReplaceThroughputAsyncContainer.ReplaceThroughputAsync
Obtención de un contenedor por el identificadorGet a container by ID Container.ReadContainerAsyncContainer.ReadContainerAsync
Lectura de todos los contenedores de una base de datosRead all the containers in a database Database.GetContainerQueryIteratorDatabase.GetContainerQueryIterator
Eliminación de un contenedorDelete a container Container.DeleteContainerAsyncContainer.DeleteContainerAsync

Ejemplos de elementosItem examples

El método RunItemsDemo del proyecto ItemManagement de ejemplo muestra cómo realizar las siguientes tareas.The RunItemsDemo method of the sample ItemManagement project shows how to do the following tasks. Para conocer más sobre los elementos de Azure Cosmos antes de ejecutar los siguientes ejemplos, consulte Uso de bases de datos, contenedores y elementos.To learn about Azure Cosmos items before you run the following samples, see Work with databases, containers, and items.

TareaTask Referencia de APIAPI reference
Creación de un elementoCreate an item Container.CreateItemAsyncContainer.CreateItemAsync
Lectura de un elemento por identificadorRead an item by ID container.ReadItemAsynccontainer.ReadItemAsync
Consulta de elementosQuery for items container.GetItemQueryIteratorcontainer.GetItemQueryIterator
Reemplazo de un elementoReplace an item container.ReplaceItemAsynccontainer.ReplaceItemAsync
Realización de una operación upsert en un elementoUpsert an item container.UpsertItemAsynccontainer.UpsertItemAsync
Eliminación de un elementoDelete an item container.DeleteItemAsynccontainer.DeleteItemAsync
Reemplazo de un elemento por la comprobación de ETag condicionalReplace an item with conditional ETag check RequestOptions.IfMatchEtagRequestOptions.IfMatchEtag

Ejemplos de indizaciónIndexing examples

El método RunIndexDemo del proyecto IndexManagement de ejemplo muestra cómo realizar las tareas siguientes.The RunIndexDemo method of the sample IndexManagement project shows how to do the following tasks. Para más información sobre la indexación en Azure Cosmos DB antes de ejecutar los ejemplos siguientes, consulte 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 you run the following samples, see index policies, index types, and index paths.

TareaTask Referencia de APIAPI reference
Exclusión de un elemento del índiceExclude an item from the index IndexingDirective.ExcludeIndexingDirective.Exclude
Uso de la indexación diferidaUse Lazy indexing IndexingPolicy.IndexingModeIndexingPolicy.IndexingMode
Exclusión de las rutas de acceso a elementos especificadas del índiceExclude specified item paths from the index IndexingPolicy.ExcludedPathsIndexingPolicy.ExcludedPaths

Ejemplos de consultasQuery examples

El método RunDemoAsync del proyecto de Queries de ejemplo muestra cómo realizar las siguientes tareas con la gramática de consultas SQL, el proveedor LINQ con consulta y Lambda.The RunDemoAsync method of the sample Queries project shows how to do the following tasks using the SQL query grammar, the LINQ provider with query, and Lambda. Para más información sobre la referencia de consultas SQL en Azure Cosmos DB antes de ejecutar los ejemplos siguientes, consulte los ejemplos de consultas SQL para Azure Cosmos DB.To learn about the SQL query reference in Azure Cosmos DB before you run the following samples, see SQL query examples for Azure Cosmos DB.

TareaTask Referencia de APIAPI reference
Consulta de elementos de una única particiónQuery items from single partition container.GetItemQueryIteratorcontainer.GetItemQueryIterator
Consulta de elementos de varias particionesQuery items from multiple partitions container.GetItemQueryIteratorcontainer.GetItemQueryIterator
Consulta mediante una instrucción SQLQuery using a SQL statement container.GetItemQueryIteratorcontainer.GetItemQueryIterator

Ejemplos de cambio de fuentesChange feed examples

El método RunBasicChangeFeed del proyecto ChangeFeed de ejemplo muestra cómo realizar las siguientes tareas.The RunBasicChangeFeed method of the sample ChangeFeed project shows how to do the following tasks. Para más información sobre la fuente de cambios de Azure Cosmos DB antes de ejecutar los ejemplos siguientes, consulte Lectura de la fuente de cambios de Azure Cosmos DB y Procesador de fuente de cambios.To learn about change feed in Azure Cosmos DB before you run the following samples, see Read Azure Cosmos DB change feed and Change feed processor.

TareaTask Referencia de APIAPI reference
Funcionalidad básica de fuente de cambiosBasic change feed functionality Container.GetChangeFeedProcessorBuilderContainer.GetChangeFeedProcessorBuilder
Lectura de la fuente de cambios a partir de un momento específicoRead change feed from a specific time Container.GetChangeFeedProcessorBuilderContainer.GetChangeFeedProcessorBuilder
Lectura de la fuente de cambios desde el principioRead change feed from the beginning ChangeFeedProcessorBuilder.WithStartTime(DateTime)ChangeFeedProcessorBuilder.WithStartTime(DateTime)
Migración del procesador de la fuente de cambios a la fuente de cambios en el SDK V3MIgrate from change feed processor to change feed in V3 SDK Container.GetChangeFeedProcessorBuilderContainer.GetChangeFeedProcessorBuilder

Ejemplos de programación en el servidorServer-side programming examples

El método RunDemoAsync del proyecto ServerSideScripts de ejemplo muestra cómo realizar las tareas siguientes.The RunDemoAsync method of the sample ServerSideScripts project shows how to do the following tasks. Para más información sobre la programación del lado servidor en Azure Cosmos DB antes de ejecutar los ejemplos siguientes, consulte Procedimientos almacenados, desencadenadores y funciones definidas por el usuario.To learn about server-side programming in Azure Cosmos DB before you run the following samples, see Stored procedures, triggers, and user-defined functions.

TareaTask Referencia de APIAPI reference
Creación de un procedimiento almacenadoCreate a stored procedure Scripts.CreateStoredProcedureAsyncScripts.CreateStoredProcedureAsync
Ejecución de un procedimiento almacenadoExecute a stored procedure Scripts.ExecuteStoredProcedureAsyncScripts.ExecuteStoredProcedureAsync
Eliminación de un procedimiento almacenadoDelete a stored procedure Scripts.DeleteStoredProcedureAsyncScripts.DeleteStoredProcedureAsync