Session.GetObjectsByKeyFromSproc(XPClassInfo, Boolean, String, OperandValue[]) Method

Returns reloaded persistent objects from a data store, with key property values obtained via the specified stored procedure.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v21.1.dll

NuGet Package: DevExpress.Xpo

Declaration

C#

public ICollection GetObjectsByKeyFromSproc(
    XPClassInfo classInfo,
    bool alwaysGetFromDataStore,
    string sprocName,
    params OperandValue[] parameters
)

VB.NET

Public Function GetObjectsByKeyFromSproc(
    classInfo As XPClassInfo,
    alwaysGetFromDataStore As Boolean,
    sprocName As String,
    ParamArray parameters As OperandValue()
) As ICollection

Parameters

Name	Type	Description
classInfo	XPClassInfo	An XPClassInfo object which contains the metadata information of the persistent objects that are retrieved based on the stored procedure’s results.
alwaysGetFromDataStore	Boolean	true to reload persistent objects from storage, if they are found in memory; otherwise, false.
sprocName	String	A String value that specifies the stored procedure’s name.
parameters	OperandValue[]	An array of parameters to pass to the stored procedure.

Returns

Type	Description
ICollection	A collection of persistent objects with specified key property values.

Remarks

The GetObjectsByKeyFromSproc method works as follows:

1. Executes the specified stored procedure with parameters and retrieves key property values into a result set.
2. Searches in memory for persistent objects with retrieved key property values. If such objects are found, they are not reloaded. To get the up-to-date objects from storage, set the alwaysGetFromDb parameter to true.

The GetObjectsByKeyFromSproc method may throw the InvalidCastException if the key value type does not match the key property type. Select key values from a column of a type mapped to a key property type to avoid this error. The following article describes how XPO maps a CLR type to a database type: Data Types Supported by XPO.

ADO.NET data readers may use different mappings between CLR and database types. XPO mappings are actual for the following key property types: Int32, Int64, Guid. When working with other key property types, ensure that the corresponding ADO.NET data reader returns values of an appropriate type. Use the ExecuteSproc and GetObjectsByKey methods instead of GetObjectsByKeyFromSproc when the type conversion is required.

Note

The GetObjectsByKeyFromSproc method does not find objects until they are saved to a data store.

For more informatioon about executing stored procedures in XPO, refer to Stored Procedures.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetObjectsByKeyFromSproc(XPClassInfo, Boolean, String, OperandValue[]) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

VB.NET

XPO_how-to-add-support-for-direct-sql-queries-and-stored-procedures-to-xpo-service-e2787/VB/Client/Default.aspx.vb#L17

    Dim customerId As Integer = Convert.ToInt32(customersCombo.Value)
    ordersView.DataSource = session.GetObjectsByKeyFromSproc(session.GetClassInfo(Of Order)(), True, "CustomerOrders", New OperandValue(customerId))
End Sub