IDocumentClient.ReadDatabaseAsync Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Surcharges
| ReadDatabaseAsync(String, RequestOptions) |
Lit un Database à partir du service Azure Cosmos DB en tant qu’opération asynchrone. |
| ReadDatabaseAsync(Uri, RequestOptions) |
Lit un Database en tant qu’opération asynchrone à partir du service Azure Cosmos DB. |
ReadDatabaseAsync(String, RequestOptions)
Lit un Database à partir du service Azure Cosmos DB en tant qu’opération asynchrone.
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Database>> ReadDatabaseAsync (string databaseLink, Microsoft.Azure.Documents.Client.RequestOptions options = default);abstract member ReadDatabaseAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Database>>Public Function ReadDatabaseAsync (databaseLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of Database))Paramètres
- databaseLink
- String
Lien de la ressource de base de données à lire.
- options
- RequestOptions
(Facultatif) Options de demande pour la demande.
Retours
System.Threading.Tasks contenant un ResourceResponse<TResource> qui encapsule un Database contenant l’enregistrement de ressource de lecture.
Exceptions
Si databaseLink n’est pas défini.
Cette exception peut encapsuler de nombreux types d’erreurs différents. Pour déterminer l’erreur spécifique, examinez toujours la propriété StatusCode. Voici quelques codes courants que vous pouvez obtenir lors de la création d’un document :
| StatusCode | Raison de l’exception |
|---|---|
| 404 | NotFound : cela signifie que la ressource que vous avez essayé de lire n’existait pas. |
| 429 | TooManyRequests : cela signifie que vous avez dépassé le nombre d’unités de requête par seconde. Consultez la valeur DocumentClientException.RetryAfter pour voir combien de temps vous devez attendre avant de réessayer cette opération. |
Exemples
//Reads a Database resource where
// - database_id is the ID property of the Database resource you wish to read.
var dbLink = "/dbs/database_id";
Database database = await client.ReadDatabaseAsync(dbLink);
Remarques
La lecture d’une ressource est le moyen le plus efficace d’obtenir une ressource à partir de la base de données. Si vous connaissez l’ID de la ressource, effectuez une lecture au lieu d’une requête par ID.
L’exemple ci-dessous utilise des liens basés sur l’ID, où le lien est composé des propriétés d’ID utilisées lors de la création des ressources. Vous pouvez toujours utiliser la SelfLink propriété de la base de données si vous préférez. Un lien automatique est un URI pour une ressource constituée d’identificateurs de ressource (ou des propriétés _rid). Les liens basés sur l’ID et SelfLink fonctionnent tous deux. Le format pour databaseLink est toujours « /dbs/{db identifier} » uniquement les valeurs dans la modification en fonction de la {} méthode que vous souhaitez utiliser pour traiter la ressource.
Voir aussi
S’applique à
ReadDatabaseAsync(Uri, RequestOptions)
Lit un Database en tant qu’opération asynchrone à partir du service Azure Cosmos DB.
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Database>> ReadDatabaseAsync (Uri databaseUri, Microsoft.Azure.Documents.Client.RequestOptions options = default);abstract member ReadDatabaseAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Database>>Public Function ReadDatabaseAsync (databaseUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of Database))Paramètres
- databaseUri
- Uri
URI de la ressource de base de données à lire.
- options
- RequestOptions
Options de demande pour la demande.
Retours
System.Threading.Tasks contenant un ResourceResponse<TResource> qui encapsule un Database contenant l’enregistrement de ressource de lecture.
Exceptions
Si databaseUri n’est pas défini.
Cette exception peut encapsuler de nombreux types d’erreurs différents. Pour déterminer l’erreur spécifique, examinez toujours la propriété StatusCode. Voici quelques codes courants que vous pouvez obtenir lors de la création d’un document :
| StatusCode | Raison de l’exception |
|---|---|
| 404 | NotFound : cela signifie que la ressource que vous avez essayé de lire n’existait pas. |
| 429 | TooManyRequests : cela signifie que vous avez dépassé le nombre d’unités de requête par seconde. Consultez la valeur DocumentClientException.RetryAfter pour voir combien de temps vous devez attendre avant de réessayer cette opération. |
Exemples
//Reads a Database resource where
// - db_id is the ID property of the Database you wish to read.
var dbLink = UriFactory.CreateDatabaseUri("db_id");
Database database = await client.ReadDatabaseAsync(dbLink);
Remarques
La lecture d’une ressource est le moyen le plus efficace d’obtenir une ressource à partir du service. Si vous connaissez l’ID de la ressource, effectuez une lecture au lieu d’une requête par ID.
Voir aussi
S’applique à
Azure SDK for .NET