ISqlJoinOnBuilder.On(string left, ISqlParameter parameter) Method

.NET Standard 2.x

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

Namespace: SnapObjects.Data

Assembly: SnapObjects.Data.dll

Syntax

  ISqlJoinOnAndOr On(string left, ISqlParameter parameter);

Parameters

left System.String

A SQL expression on the left of the operator.

parameters SnapObjects.Data.ISqlParameter

An ISqlParameter object which represents a SQL parameter.

It can be created by calling the SqlBuilder.Parameter method.

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 Example3()
        {
            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 equal to an input argument.                        
            sqlQueryBuilder
                .Select("Department.DepartmentID")
                .Select("Department.Name")
                .Select("Course.Title")
                .From("Department")
                .Join("Course")
                .On("Department.DepartmentID",
                    SqlBuilder.Parameter<int>("departmentid"));


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

            Console.WriteLine(sql);

            // Executes the SQL statement, and specifies the value for the input argument.
            var departments = _context.SqlExecutor.Select<DynamicModel>(sql, 1);

            /*This code example produces the following output:           
              SELECT
                [Department].[DepartmentID],
                [Department].[Name],
                [Course].[Title]
               FROM [Department] JOIN [Course]
               ON [Department].[DepartmentID] = @departmentid
            */
        }
    }
}

Applies to

.NET Standard

2.x