1. SuiteCloud Platform
  2. SuiteScript
  3. SuiteScript 2.x API Reference
  4. SuiteScript 2.x Modules
  5. N/query Module
  6. query.Query
  7. Query.createCondition(options)

Query.createCondition(options)

Method Description

Creates a condition (query filter) based on the query.Query object.

A condition narrows the query results. The query.Condition object acts in the same capacity as the search.Filter object in the N/search Module. The primary difference is that query.Condition objects can contain other query.Condition objects.

To create conditions:

  • Use Query.createCondition(options) to create conditions on the initial query definition created with query.create(options). Use this method in one of two ways:

    • Pass in arguments for the parameters options.fieldId, options.operator, and options.values. The combination of these arguments translates to <filter column><operator><field value> (for example, ‘city’ equals ‘Boston’).

    • Pass in an argument for the parameter options.formula. If you use this option, you can also use the optional parameter options.type.

  • If needed, use Component.createCondition(options) to create conditions on the join relationships created with Query.autoJoin(options) and Component.autoJoin(options).

  • If you have multiple conditions, use them to create a new nested condition with the methods Query.and(conditions), Query.or(conditions), and Query.not(condition).

  • Assign your simple or nested condition to Query.condition. For an example, see Syntax.

Note:

This method is a shortcut for the chained Query.root and Component.createCondition(options): Query.root.createCondition(options). The Query.root property references the root component, which is a query.Component object.

Returns

query.Condition

Supported Script Types

Client and server scripts

For more information, see SuiteScript 2.x Script Types.

Governance

None

Module

N/query Module

Parent Object

query.Query

Sibling Object Members

Query Object Members

Since

2018.1

Parameters

Note:

The options parameter is a JavaScript object.

Parameter

Type

Required / Optional

Description

options.fieldId

string

required if options.operator and options.values are used

The field that the condition applies to. This value sets the Condition.fieldId property.

Obtain this value from the Records Catalog. The Records Catalog lists every record type and field that is available using SuiteAnalytics Workbook and the N/query module. For more information, see Records Catalog Overview.

options.operator

string

required

The operator used by the condition. This value sets the Condition.operator parameter.

Use the appropriate query.Operator enum value to pass in your argument. This enum holds all the supported values for this parameter.

options.values

string[] | number[] | [] | Date[] | query.RelativeDate[] | query.Period[]

required if options.fieldId and options.operator are used, and options.operator does not have a value of query.Operator.EMPTY or query.Operator.EMPTY_NOT

An of values to use for the condition. This value sets the Condition.values property.

options.formula

string

required if options.fieldId is not used

The formula used to create the condition. This value sets the Condition.formula property.

For more information about formulas, see Formulas in Searches and SQL Expressions.

options.type

string

required if options.formula is used

If you use the options.formula parameter, use this parameter to explicitly define the formula’s return type. This value sets the Condition.type property.

Use the appropriate query.ReturnType enum value to pass in your argument. This enum holds all the supported values for this parameter.

options.aggregate

string

optional

Use this parameter to run an aggregate function on a condition. An aggregate function performs a calculation on the condition values and returns a single value. This value sets the Condition.aggregate property.

Use the appropriate query.Aggregate enum value to pass in your argument. This enum holds all the supported values for this parameter.

options.caseSensitive

boolean

optional

Use this parameter to specify the case of filtered text. This parameter is only valid for text fields. You may encounter script errors if this parameter is set with numbers or date values. You can use this parameter to improve the performance of the final query. By default, this value is set to false.

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/query Module Script Samples.

            // Add additional code
...
    var myCustomerQuery = query.create({
        type: query.Type.CUSTOMER
    });

        var mySalesRepJoin = myCustomerQuery.autoJoin({
        fieldId: 'salesrep'
    });

        var myLocationJoin = mySalesRepJoin.autoJoin({
        fieldId: 'location'
    });

    
    var myCondition = myCustomerQuery.createCondition({
        fieldId: 'entityid',
        operator: query.Operator.ANY_OF,
        values: ['UK Cust USD','EU Cust'],
        caseSensitive: true
    });
    

      myCustomerQuery.condition = myCustomerQuery.and(
        myCondition
    );

   
    myCustomerQuery.columns = [
        myCustomerQuery.createColumn({
            fieldId: 'entityid'
        }),
        myCustomerQuery.createColumn({
            fieldId: 'id'
        }),
        mySalesRepJoin.createColumn({
            fieldId: 'entityid'
        }),
        mySalesRepJoin.createColumn({
            fieldId: 'email'
        }),
        mySalesRepJoin.createColumn({
            fieldId: 'hiredate'
        }),
        myLocationJoin.createColumn({
            fieldId: 'name'
        })
    ];

    
    myCustomerQuery.sort = [
        myCustomerQuery.createSort({
            column: myCustomerQuery.columns[3]
        }),
        myCustomerQuery.createSort({
            column: myCustomerQuery.columns[0],
            ascending: false
        })
    ];

    
    var resultSet = myCustomerQuery.run()
...
// Add additional code

Related Topics

General Notices