ISqlOrderBuilder.OrderByDescending(params string[] orderExpressions) Method

.NET Standard 2.x

Creates an ORDER BY clause and specifies one or more sort criteria in descending order.

Namespace: SnapObjects.Data

Assembly: SnapObjects.Data.dll

Syntax

  ISqlOrderThenBuilder OrderByDescending(params string[] orderExpressions);

Parameters

orderExpressions System.String[]

(Optional) An array of expressions which specify a column or an expression on which to sort the query result set.

Returns

SnapObjects.Data.ISqlOrderThenBuilder

Returns an ISqlOrderThenBuilder object which can be used to add more sort criteria to the current ORDER BY clause.

Examples

The following code example demonstrates how to use the OrderByDescending() method to retrieve all the records from the "Department" department and sort the records by budget in descending order.

using SnapObjects.Data;
using System;

namespace Appeon.ApiDoc.ISqlOrderBuilderExamples
{
    public class OrderByDescendingExample
    {
        private SchoolContext _context;

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

        public void Example()
        {
            // Declares SqlQueryBuilder.
            var sqlbuilder = new SqlQueryBuilder();

            // Defines a SQL statement, retrieves all the records from the "Department" table, 
            // and sorts the records by budget in descending order.
            sqlbuilder.Select("*")
                .From("Department", "dept")
                .OrderByDescending("budget");

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

            Console.WriteLine(sql);
            
            /*This code produces the following output:
            
            SELECT
            *
            FROM [Department] AS [dept]
            ORDER BY
            [budget] DESC
            */
        }
    }
}

Applies to

.NET Standard

2.x