Skip navigation links
4.3.1.11 Interface Results »
Section Navigation      [Toggle]

4.3.1.10. Interface Query

[+/-]

4.3.1.10.1. Synopsis
4.3.1.10.2. execute(Map<String, ?>)
4.3.1.10.3. execute(Object...)
4.3.1.10.4. execute(Object)
4.3.1.10.5. explain()
4.3.1.10.6. getResultList()
4.3.1.10.7. setParameter(String, Object)

A Query instance represents a specific query with bound parameters. The instance is created by the method com.mysql.clusterj.Session.createQuery.

4.3.1.10.1. Synopsis
 public interface com.mysql.clusterj.Query<E> {
// Public Methods  public com.­mysql.­clusterj.­Results<E> execute(java.lang.Object parameter);
  public com.­mysql.­clusterj.­Results<E> execute(java.lang.Object[] parameters);
  public com.­mysql.­clusterj.­Results<E> execute(java.util.Map<java.­lang.­String, ?> parameters);
  public java.­util.­Map<java.­­lang.­­String, java.­­lang.­­Object> explain();
  public java.­util.­List<E> getResultList();
  public void setParameter(java.lang.String parameterName,
                           java.lang.Object value);
}
4.3.1.10.2. execute(Map<String, ?>)
public com.­mysql.­clusterj.­Results<E> execute(java.util.Map<java.­lang.­String, ?> parameters);

Execute the query with one or more named parameters. Parameters are resolved by name.

Parameters

parameters

the parameters

return

the result

4.3.1.10.3. execute(Object...)
public com.­mysql.­clusterj.­Results<E> execute(java.lang.Object[] parameters);

Execute the query with one or more parameters. Parameters are resolved in the order they were declared in the query.

Parameters

parameters

the parameters

return

the result

4.3.1.10.4. execute(Object)
public com.­mysql.­clusterj.­Results<E> execute(java.lang.Object parameter);

Execute the query with exactly one parameter.

Parameters

parameter

the parameter

return

the result

4.3.1.10.5. explain()
public java.­util.­Map<java.­­lang.­­String, java.­­lang.­­Object> explain();

Explain how this query was executed, after execution. If called before executing the query, returns null. Returns a collection of key:value pairs that explain how the query was executed.

Parameters

return

the data about the execution of this query

4.3.1.10.6. getResultList()
public java.­util.­List<E> getResultList();

Get the results as a list.

Parameters

return

the result

4.3.1.10.7. setParameter(String, Object)
public void setParameter(java.lang.String parameterName,
                         java.lang.Object value);

Set the value of a parameter.

Parameters

parameterName

the name of the parameter

value

the value for the parameter