org.mule.api.annotations
Annotation Type Query


@Target(value=PARAMETER)
@Retention(value=SOURCE)
@Documented
public @interface Query

This annotation is meant to be applied to support easy query building by using DataSense Query Language, DSQL. This annotation must be defined within your @Connector scope.

The parameter annotated with @Query can be either String or org.mule.common.query.DsqlQuery. The latter is not recommended as it can break your connector compatibility.

When an String parameter is annotated, you can assume your query has been translated to your connector native query language by @QueryTranslator. ie, the @QueryTranslator is required.

On the other hand when an org.mule.common.query.DsqlQuery is annotated, you must do the translation within your processor.


Optional Element Summary
 QueryOperator[] disabledOperators
          Specify operators disabled in the displayed DSQL language.
 boolean limit
          Limit feature is enabled or disabled
 boolean offset
          Offset feature is enabled or disabled
 boolean orderBy
          OrderBy feature is enabled or disabled
 

disabledOperators

public abstract QueryOperator[] disabledOperators
Specify operators disabled in the displayed DSQL language. This might be useful when your native language is smaller than DSQL.

Default:
{}

limit

public abstract boolean limit
Limit feature is enabled or disabled

Default:
true

offset

public abstract boolean offset
Offset feature is enabled or disabled

Default:
true

orderBy

public abstract boolean orderBy
OrderBy feature is enabled or disabled

Default:
true


Copyright © 2010–2015 MuleSoft, Inc.. All rights reserved.