ILoadable.IncludeAllAsync(bool cascade = false, CancellationToken cancellationToken = default) Method

.NET Standard 2.x

Asynchronously loads all the embedded properties in TModel for all rows.

If the ModelEmbedded attribute is applied in the property, the property will use the SQL query (defined in the detail model class specified by the ModelType property of the ModelEmbedded attribute) to retrieve data from database. The cascade parameter can be used to decide whether to retrieve data for the embedded properties in the detail model or the granddetail model.

Namespace: SnapObjects.Data

Assembly: SnapObjects.Data.dll

Syntax

Task<ILoadable<TModel>> IncludeAllAsync(bool cascade = false, CancellationToken cancellationToken = default);

Parameters

cascade System.Boolean

(Optional) Only when the ModelEmbedded attribute is applied in the property, the cascade parameter can be used to decide whether to retrieve data for the embedded properties in the detail model or the granddetail model. See master-detail-granddetail for more info.

The default value is false.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ILoadable<TModel>>

Returns a task that represents the asynchronous operation.

Examples

The following code example demonstrates how to load the details about the Poetry course asynchronously.

using Appeon.ApiDoc.Models.School;
using System;

namespace Appeon.ApiDoc.ILoadableExamples
{
    public class IncludeAllAsyncExample
    {
        private SchoolContext _context;
        
        public IncludeAllAsyncExample(SchoolContext dataContext)
        {
            // Sets the data context.
            _context = dataContext;
        }

        public async void Example1()
        {
            var mapper = _context.SqlModelMapper;
            
            // Asynchronous loads students, instructor, online flag for the Poetry course 
            // (CourseID = 2030).
            var course = (await (await mapper.LoadByKeyAsync<CourseInfo>(2030))
                                .IncludeAllAsync())
                                .FirstOrDefault();
                                
            Console.WriteLine("Courses: {0}", course.Title);
            
            // Students of the Poetry course. 
            Console.WriteLine();
            Console.WriteLine("Student IDs:");
            foreach (CourseStudentInfo student in course.Students)
            {
                Console.WriteLine(student.StudentID);
            }
            
            // Instructors of the Poetry course. 
            Console.WriteLine();
            Console.WriteLine("Instructor ID(s):");
            
            foreach (CourseInstructorInfo instructor in course.Instructors)
            {
                Console.WriteLine(instructor.PersonID);
            }
            
            /* This code produces the following output:
            
                Courses: Poetry
                
                Student IDs:
                2
                3
                
                Instructor ID(s):
                4
            */
        }
    }
}

Example Refer To

Model Classes: CourseInfo CourseStudentInfo CourseInstructorInfo

Applies to

.NET Standard

2.x