SqlBuilder.EmbeddedOnRaw(string clause, params ISqlParameter[] parameters) Method

.NET Standard 2.x

Creates an ISqlJoinCondition object which represents a search condition that can be used (enclosed in parentheses) when building the ON clause. This search condition is specified by a raw SQL string.

Namespace: SnapObjects.Data

Assembly: SnapObjects.Data.dll

Syntax

 public static ISqlJoinCondition EmbeddedOnRaw(string clause, params ISqlParameter[] parameters);

Parameters

clause System.String

A string of raw SQL to be added to the ON clause.

parameters SnapObjects.Data.ISqlParameter[]

(Optional) An array of ISqlParameter objects which defines the SQL parameters used in the raw SQL.

Returns

SnapObjects.Data.ISqlJoinCondition

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

Remarks

The newly created search condition is enclosed in parentheses. If the returned ISqlJoinCondition object is used to add another search condition, both of these search conditions will be enclosed in the same pair of parentheses.

Examples

The following code example demonstrates how to use the EmbeddedOnRaw method to set the condition to join one table with another.

using SnapObjects.Data;
using System;

namespace Appeon.ApiDoc.SqlBuilderExamples
{
    public class EmbeddedOnRawExample
    {
        private SchoolContext _context;

        public EmbeddedOnRawExample(SchoolContext dataContext)
        {
            // Sets Data Context.
            _context = dataContext;
        }

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

            // Defines an embedded JOIN condition.
            var join = SqlBuilder
                .EmbeddedOnRaw("Department.DepartmentID = Course.DepartmentID " +
                               "and Course.DepartmentID > @dept", 
                               SqlBuilder.Parameter<int>("dept"));

            // Creates a SQL statement.
            var query = 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 = query.ToSqlString(_context);

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

Applies to

.NET Standard

2.x