com.datastax.driver.mapping.annotations.QueryParameters Maven / Gradle / Ivy
/*
* Copyright DataStax, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.datastax.driver.mapping.annotations;
import com.datastax.driver.core.Configuration;
import com.datastax.driver.core.QueryOptions;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Query parameters to use in the (generated) implementation of a method of an {@link Accessor}
* interface.
*
* All the parameters of this annotation are optional, and when not provided default to whatever
* default the {@code Cluster} instance used underneath are (those set in {@link
* Configuration#getQueryOptions}).
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface QueryParameters {
/**
* The consistency level to use for the operation.
*
* @return the consistency level to use for the operation.
*/
String consistency() default "";
/**
* The fetch size to use for paging the result of this operation.
*
* @return the fetch size to use for the operation.
*/
int fetchSize() default -1;
/**
* Whether tracing should be enabled for this operation.
*
* @return whether tracing should be enabled for this operation.
*/
boolean tracing() default false;
/**
* Whether the operation is idempotent or not.
*
*
When this attribute is set to {@code true} the operation is assumed idempotent; when set to
* {@code false}, it is assumed that it is not.
*
*
If a value of {@code true} or {@code false} is provided, the underlying {@link
* com.datastax.driver.core.Statement} will have its {@link
* com.datastax.driver.core.Statement#setIdempotent(boolean) idempotent flag} set accordingly.
*
*
When this attribute is set to its default (an empty array), it means that the statement's
* idempotent flag will not be set, and its idempotence will be inferred from {@link
* QueryOptions#getDefaultIdempotence()}.
*
*
This attribute is declared as a boolean array to allow for "unset" values, but it can only
* contain at most one element.
*
* @return {@code true} if the operation is idempotent, {@code false} otherwise.
*/
boolean[] idempotent() default {};
}