ISqlJoinOnBuilder.On(ISqlJoinCondition condition) Method

.NET Standard 2.x

Creates an ON clause and adds a search condition to it using an ISqlJoinCondition object.

Namespace: SnapObjects.Data

Assembly: SnapObjects.Data.dll

Syntax

  ISqlJoinOnAndOr On(ISqlJoinCondition condition);

Parameters

condition SnapObjects.Data.ISqlJoinCondition

An ISqlJoinCondition which represents a search condition in the ON Clause.

This object can be created by using the SqlBuilder.On method and so on.

Returns

SnapObjects.Data.ISqlJoinOnAndOr

Returns the ISqlJoinOnAndOr object which can be used to add more search conditions to the current ON clause.

Examples

The following code example uses the On method to set Sets the condition to join one table with another.

using SnapObjects.Data;
using System;

namespace Appeon.ApiDoc.ISqlJoinOnBuilderExamples
{
    public class OnExample
    {
        private readonly SchoolContext _context;

        public OnExample(SchoolContext dataContext)
        {
            // Sets data context.
            _context = dataContext;
        }

        public void Example7()
        {
            var sqlQueryBuilder = new SqlQueryBuilder();

            // Defines a JOIN condition.
            var join =
                SqlBuilder.EmbeddedOnRaw("Department.DepartmentID = " +
                                         "Course.DepartmentID");

            // Gets DepartmentID values and Name values from the "Department" table, 
            // and the Title values from the "Course" table.
            // Sets the condition to join the "Department" and "Course" tables: 
            // the JOIN condition defined above ("Department.DepartmentID = 1").                           
            sqlQueryBuilder
                .Select("Department.DepartmentID")
                .Select("Department.Name")
                .Select("Course.Title")
                .From("Department")
                .Join("Course")
                .On(join);

            // Converts to raw SQL for the database corresponding to the data context.
            string sql = sqlQueryBuilder.ToSqlString(_context);

            Console.WriteLine(sql);
            
            /*This code example produces the following output:           
              SELECT
                [Department].[DepartmentID],
                [Department].[Name],
                [Course].[Title]
              FROM [Department] JOIN [Course]
              ON ([Department].[DepartmentID] = [Course].[DepartmentID])
            */
        }
    }
}

Applies to

.NET Standard

2.x