DocumentClient.ExecuteStoredProcedureAsync Methode

Referenz

Definition

Namespace:: Microsoft.Azure.Documents.Client

Assemblys:: Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Pakete:: Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Überlädt

ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, CancellationToken, Object[])	Führt eine gespeicherte Prozedur für eine partitionierte Sammlung im Azure Cosmos DB-Dienst als asynchronen Vorgang aus, wobei eine Zielpartition angegeben wird.
ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, Object[])	Führt eine gespeicherte Prozedur für eine Sammlung als asynchronen Vorgang aus dem Azure Cosmos DB-Dienst aus.
ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, CancellationToken, Object[])	Führt eine gespeicherte Prozedur für eine Sammlung als asynchronen Vorgang aus dem Azure Cosmos DB-Dienst aus.
ExecuteStoredProcedureAsync<TValue>(Uri, Object[])	Führt eine gespeicherte Prozedur für eine Sammlung als asynchronen Vorgang aus dem Azure Cosmos DB-Dienst aus.
ExecuteStoredProcedureAsync<TValue>(String, Object[])	Führt eine gespeicherte Prozedur für eine Sammlung als asynchronen Vorgang im Azure Cosmos DB-Dienst aus.
ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, Object[])	Führt eine gespeicherte Prozedur für eine partitionierte Sammlung im Azure Cosmos DB-Dienst als asynchronen Vorgang aus, wobei eine Zielpartition angegeben wird.

ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, CancellationToken, Object[])

Führt eine gespeicherte Prozedur für eine partitionierte Sammlung im Azure Cosmos DB-Dienst als asynchronen Vorgang aus, wobei eine Zielpartition angegeben wird.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<TValue>> ExecuteStoredProcedureAsync<TValue> (string storedProcedureLink, Microsoft.Azure.Documents.Client.RequestOptions options, System.Threading.CancellationToken cancellationToken, params object[] procedureParams);

abstract member ExecuteStoredProcedureAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>
override this.ExecuteStoredProcedureAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>

Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureLink As String, options As RequestOptions, cancellationToken As CancellationToken, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))

Typparameter

TValue

Der Typ des Rückgabewerts der gespeicherten Prozedur.

Parameter

storedProcedureLink: String

Der Link zur auszuführenden gespeicherten Prozedur.

options: RequestOptions

(Optional) Die Anforderungsoptionen für die Anforderung.

cancellationToken: CancellationToken

(Optional) Eine CancellationToken , die von anderen Objekten oder Threads verwendet werden kann, um eine Kündigungsbenachrichtigung zu erhalten.

procedureParams: Object[]

(Optional) Ein Array dynamischer Objekte, die die Parameter für die gespeicherte Prozedur darstellen.

Gibt zurück

Task<StoredProcedureResponse<TValue>>

Das Taskobjekt, das die Dienstantwort für den asynchronen Vorgang darstellt, der einen beliebigen Antwortsatz in der gespeicherten Prozedur enthalten würde.

Implementiert

ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, CancellationToken, Object[])

Ausnahmen

ArgumentNullException

Wenn storedProcedureLink nicht festgelegt ist.

Beispiele

//Execute a StoredProcedure with ResourceId of "sproc_rid" that takes two "Player" documents, does some stuff, and returns a bool
StoredProcedureResponse<bool> sprocResponse = await client.ExecuteStoredProcedureAsync<bool>(
                                                        "/dbs/db_rid/colls/col_rid/sprocs/sproc_rid/",
                                                        new RequestOptions { PartitionKey = new PartitionKey(1) },
                                                        new Player { id="1", name="joe" } ,
                                                        new Player { id="2", name="john" }
                                                    );

if (sprocResponse.Response) Console.WriteLine("Congrats, the stored procedure did some stuff");

Weitere Informationen

Gilt für:

ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, Object[])

Führt eine gespeicherte Prozedur für eine Sammlung als asynchronen Vorgang aus dem Azure Cosmos DB-Dienst aus.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<TValue>> ExecuteStoredProcedureAsync<TValue> (Uri storedProcedureUri, Microsoft.Azure.Documents.Client.RequestOptions options, params object[] procedureParams);

abstract member ExecuteStoredProcedureAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>
override this.ExecuteStoredProcedureAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>

Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureUri As Uri, options As RequestOptions, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))

Typparameter

TValue

der Typ des Rückgabewerts der gespeicherten Prozedur.

Parameter

storedProcedureUri: Uri

der URI der auszuführenden gespeicherten Prozedur.

options: RequestOptions

Die Anforderungsoptionen für die Anforderung.

procedureParams: Object[]

die Parameter für die Ausführung der gespeicherten Prozedur.

Gibt zurück

Task<StoredProcedureResponse<TValue>>

Das Taskobjekt, das die Dienstantwort für den asynchronen Vorgang darstellt.

Implementiert

ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, Object[])

Gilt für:

ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, CancellationToken, Object[])

Führt eine gespeicherte Prozedur für eine Sammlung als asynchronen Vorgang aus dem Azure Cosmos DB-Dienst aus.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<TValue>> ExecuteStoredProcedureAsync<TValue> (Uri storedProcedureUri, Microsoft.Azure.Documents.Client.RequestOptions options, System.Threading.CancellationToken cancellationToken = default, params object[] procedureParams);

abstract member ExecuteStoredProcedureAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>
override this.ExecuteStoredProcedureAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>

Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureUri As Uri, options As RequestOptions, Optional cancellationToken As CancellationToken = Nothing, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))

Typparameter

TValue

der Typ des Rückgabewerts der gespeicherten Prozedur.

Parameter

storedProcedureUri: Uri

der URI der auszuführenden gespeicherten Prozedur.

options: RequestOptions

Die Anforderungsoptionen für die Anforderung.

cancellationToken: CancellationToken

(Optional) CancellationToken stellt die Anforderungsabbruch dar.

procedureParams: Object[]

die Parameter für die Ausführung der gespeicherten Prozedur.

Gibt zurück

Task<StoredProcedureResponse<TValue>>

Das Taskobjekt, das die Dienstantwort für den asynchronen Vorgang darstellt.

Implementiert

ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, CancellationToken, Object[])

Gilt für:

ExecuteStoredProcedureAsync<TValue>(Uri, Object[])

Führt eine gespeicherte Prozedur für eine Sammlung als asynchronen Vorgang aus dem Azure Cosmos DB-Dienst aus.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<TValue>> ExecuteStoredProcedureAsync<TValue> (Uri storedProcedureUri, params object[] procedureParams);

abstract member ExecuteStoredProcedureAsync : Uri * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>
override this.ExecuteStoredProcedureAsync : Uri * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>

Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureUri As Uri, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))

Typparameter

TValue

der Typ des Rückgabewerts der gespeicherten Prozedur.

Parameter

storedProcedureUri: Uri

der URI der auszuführenden gespeicherten Prozedur.

procedureParams: Object[]

die Parameter für die Ausführung der gespeicherten Prozedur.

Gibt zurück

Task<StoredProcedureResponse<TValue>>

Das Taskobjekt, das die Dienstantwort für den asynchronen Vorgang darstellt.

Implementiert

ExecuteStoredProcedureAsync<TValue>(Uri, Object[])

Gilt für:

ExecuteStoredProcedureAsync<TValue>(String, Object[])

Führt eine gespeicherte Prozedur für eine Sammlung als asynchronen Vorgang im Azure Cosmos DB-Dienst aus.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<TValue>> ExecuteStoredProcedureAsync<TValue> (string storedProcedureLink, params object[] procedureParams);

abstract member ExecuteStoredProcedureAsync : string * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>
override this.ExecuteStoredProcedureAsync : string * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>

Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureLink As String, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))

Typparameter

TValue

Der Typ des Rückgabewerts der gespeicherten Prozedur.

Parameter

storedProcedureLink: String

Der Link zur auszuführenden gespeicherten Prozedur.

procedureParams: Object[]

(Optional) Ein Array dynamischer Objekte, die die Parameter für die gespeicherte Prozedur darstellen.

Gibt zurück

Task<StoredProcedureResponse<TValue>>

Das Taskobjekt, das die Dienstantwort für den asynchronen Vorgang darstellt, der einen beliebigen Antwortsatz in der gespeicherten Prozedur enthalten würde.

Implementiert

ExecuteStoredProcedureAsync<TValue>(String, Object[])

Ausnahmen

ArgumentNullException

Wenn storedProcedureLink nicht festgelegt ist.

Beispiele

//Execute a StoredProcedure with ResourceId of "sproc_rid" that takes two "Player" documents, does some stuff, and returns a bool
StoredProcedureResponse<bool> sprocResponse = await client.ExecuteStoredProcedureAsync<bool>(
                                                        "/dbs/db_rid/colls/col_rid/sprocs/sproc_rid/",
                                                        new Player { id="1", name="joe" } ,
                                                        new Player { id="2", name="john" }
                                                    );

if (sprocResponse.Response) Console.WriteLine("Congrats, the stored procedure did some stuff");

Weitere Informationen

Gilt für:

ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, Object[])

Führt eine gespeicherte Prozedur für eine partitionierte Sammlung im Azure Cosmos DB-Dienst als asynchronen Vorgang aus, wobei eine Zielpartition angegeben wird.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<TValue>> ExecuteStoredProcedureAsync<TValue> (string storedProcedureLink, Microsoft.Azure.Documents.Client.RequestOptions options, params object[] procedureParams);

abstract member ExecuteStoredProcedureAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>
override this.ExecuteStoredProcedureAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>

Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureLink As String, options As RequestOptions, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))

Typparameter

TValue

Der Typ des Rückgabewerts der gespeicherten Prozedur.

Parameter

storedProcedureLink: String

Der Link zur auszuführenden gespeicherten Prozedur.

options: RequestOptions

(Optional) Die Anforderungsoptionen für die Anforderung.

procedureParams: Object[]

(Optional) Ein Array dynamischer Objekte, die die Parameter für die gespeicherte Prozedur darstellen.

Gibt zurück

Task<StoredProcedureResponse<TValue>>

Das Taskobjekt, das die Dienstantwort für den asynchronen Vorgang darstellt, der einen beliebigen Antwortsatz in der gespeicherten Prozedur enthalten würde.

Implementiert

ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, Object[])

Ausnahmen

ArgumentNullException

Wenn storedProcedureLink nicht festgelegt ist.

Beispiele

//Execute a StoredProcedure with ResourceId of "sproc_rid" that takes two "Player" documents, does some stuff, and returns a bool
StoredProcedureResponse<bool> sprocResponse = await client.ExecuteStoredProcedureAsync<bool>(
                                                        "/dbs/db_rid/colls/col_rid/sprocs/sproc_rid/",
                                                        new RequestOptions { PartitionKey = new PartitionKey(1) },
                                                        new Player { id="1", name="joe" } ,
                                                        new Player { id="2", name="john" }
                                                    );

if (sprocResponse.Response) Console.WriteLine("Congrats, the stored procedure did some stuff");

Weitere Informationen

Gilt für:

Freigeben über

DocumentClient.ExecuteStoredProcedureAsync Methode

Definition

Überlädt

ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, CancellationToken, Object[])

Typparameter

Parameter

Gibt zurück

Implementiert

Ausnahmen

Beispiele

Weitere Informationen

Gilt für:

ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, Object[])

Typparameter

Parameter

Gibt zurück

Implementiert

Gilt für:

ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, CancellationToken, Object[])

Typparameter

Parameter

Gibt zurück

Implementiert

Gilt für:

ExecuteStoredProcedureAsync<TValue>(Uri, Object[])

Typparameter

Parameter

Gibt zurück

Implementiert

Gilt für:

ExecuteStoredProcedureAsync<TValue>(String, Object[])

Typparameter

Parameter

Gibt zurück

Implementiert

Ausnahmen

Beispiele

Weitere Informationen

Gilt für:

ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, Object[])

Typparameter

Parameter

Gibt zurück

Implementiert

Ausnahmen

Beispiele

Weitere Informationen

Gilt für:

Zusätzliche Ressourcen