ISqlJoinOnBuilder.On(string left, string right) Method

.NET Standard 2.x

Creates an ON clause and adds a search condition to it. Specifies SQL expressions on both the left and right of the operator. The operator is '='.

Namespace: SnapObjects.Data

Assembly: SnapObjects.Data.dll

Syntax

  ISqlJoinOnAndOr On(string left, string right);

Parameters

left System.String

A SQL expression on the left of the operator.

right System.String

A SQL expression on the right of the operator.

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 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 Example1()
        {
            var sqlQueryBuilder = new SqlQueryBuilder();

            // 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: Department.DepartmentID = Course.DepartmentID.
            sqlQueryBuilder
                .Select("Department.DepartmentID")
                .Select("Department.Name")
                .Select("Course.Title")
                .From("Department")
                .Join("Course")
                .On("Department.DepartmentID", "Course.DepartmentID");

            // 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