NAME

SQL::Builder::Order - Represent an expression in SQL ORDER BY clauses

SYNOPSIS

This class can represent the following SQL:

        anything [ASC|DESC|USING anything|anything]

which basically turns into

        foo ASC
        foo DESC
        foo USING >
        foo USING <
        foo bar

Here's how to use it:

        my $expr = SQL::Builder::Order->new(expr => "foo - bar");

        $expr->asc;
        
        # foo - bar ASC
        print $expr->sql;

        $expr->desc;

        # foo - bar DESC
        print $expr->sql;

        $expr->order(undef);

        # foo - bar
        print $expr->sql;

        $expr->using(">");

        # foo - bar USING >
        print $expr->sql;

        $expr->order("ASC");

        # foo - bar ASC
        print $expr->sql;

DESCRIPTION

This class inherits from SQL::Builder::Base(3)

METHODS

ASC()

Returns the string "ASC"

DESC()

Rerturns the string "DESC"

asc()

Passes the value of ASC() to order()

desc()

Passes the value of DESC() to order()

expr([$expr])

Called with an argument sets the expression and returns the current object. Otherwise it returns the current value. This is the expression that is to be ordered in the ORDER BY clause

order([$by])

Called with an argument sets the value and returns the current object. Otherwise it returns the current value. This is the value that is typically used to specify sort order. For example, order("ASC") will result in sql() returning something like "foo ASC"

sql()

Returns the SQL serialization of the object. The values of expr(), order(), and using() are all passed through SQL::Builder::Base::dosql() before being processed. An empty string is returned if $expr is undefined. If $order is defined and has a length, "$expr $order" is returned. Otherwise, if $using is defined and has a length, "$expr USING $using" is returned. All other cases will return $expr

using([$using])

Called with arguments, the value is set and the current object is returned. Otherwise, the current value is returned. This method gets/sets the value to be used with USING, if your DBMS supports it. using(">") will result in sql() returning something like "foo USING >"

children()

Return a SQL::Builder::Iterator to iterate over the values of expr(), order(), and using()

SEE ALSO

SQL::Builder::GroupBy(3) SQL::Builder::Base(3) SQL::Builder(3)

cpanm SQL::Builder

perl -MCPAN -e shell
install SQL::Builder