org.springframework.data.cassandra.core.cql.WriteOptions Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-data-cassandra Show documentation
Show all versions of spring-data-cassandra Show documentation
Cassandra support for Spring Data
/*
* Copyright 2013-2020 the original author or authors.
*
* 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
*
* https://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 org.springframework.data.cassandra.core.cql;
import lombok.EqualsAndHashCode;
import java.time.Duration;
import java.time.Instant;
import java.util.concurrent.TimeUnit;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import com.datastax.driver.core.ConsistencyLevel;
import com.datastax.driver.core.policies.RetryPolicy;
/**
* Cassandra Write Options are an extension to {@link QueryOptions} for write operations. {@link WriteOptions}allow
* tuning of various query options on a per-request level. Only options that are set are applied to queries.
*
* @author David Webb
* @author Mark Paluch
* @author Lukasz Antoniak
* @see QueryOptions
*/
@EqualsAndHashCode(callSuper = true)
public class WriteOptions extends QueryOptions {
private static final WriteOptions EMPTY = new WriteOptionsBuilder().build();
private final Duration ttl;
private final @Nullable Long timestamp;
/**
* Creates new {@link WriteOptions} for the given {@link ConsistencyLevel} and {@link RetryPolicy}.
*
* @param consistencyLevel the consistency level, may be {@literal null}.
* @param retryPolicy the retry policy, may be {@literal null}.
* @deprecated since 2.0, use {@link #builder()} or {@link #empty()}.
*/
@Deprecated
public WriteOptions(@Nullable ConsistencyLevel consistencyLevel, @Nullable RetryPolicy retryPolicy) {
this(consistencyLevel, retryPolicy, null);
}
/**
* Creates new {@link WriteOptions} for the given {@link ConsistencyLevel}, {@link RetryPolicy} and {@code ttl}.
*
* @param consistencyLevel the consistency level, may be {@literal null}.
* @param retryPolicy the retry policy, may be {@literal null}.
* @param ttl the ttl, may be {@literal null}.
* @deprecated since 2.0, use {@link #builder()}.
*/
@Deprecated
public WriteOptions(@Nullable ConsistencyLevel consistencyLevel, @Nullable RetryPolicy retryPolicy,
@Nullable Integer ttl) {
super(consistencyLevel, retryPolicy);
this.ttl = ttl == null ? Duration.ofMillis(-1) : Duration.ofSeconds(ttl);
this.timestamp = null;
}
protected WriteOptions(@Nullable ConsistencyLevel consistencyLevel, @Nullable RetryPolicy retryPolicy,
@Nullable Boolean tracing, @Nullable Integer fetchSize, Duration readTimeout, Duration ttl,
@Nullable Long timestamp) {
super(consistencyLevel, retryPolicy, tracing, fetchSize, readTimeout);
this.ttl = ttl;
this.timestamp = timestamp;
}
/**
* Create default {@link WriteOptions}.
*
* @return default {@link WriteOptions}.
* @since 2.0
*/
public static WriteOptions empty() {
return EMPTY;
}
/**
* Create a new {@link WriteOptionsBuilder}.
*
* @return a new {@link WriteOptionsBuilder}.
* @since 1.5
*/
public static WriteOptionsBuilder builder() {
return new WriteOptionsBuilder();
}
/**
* Create a new {@link WriteOptionsBuilder} to mutate properties of this {@link WriteOptions}.
*
* @return a new {@link WriteOptionsBuilder} initialized with this {@link WriteOptions}.
* @since 2.0
*/
@Override
public WriteOptionsBuilder mutate() {
return new WriteOptionsBuilder(this);
}
/**
* @return the time to live, if set.
*/
public Duration getTtl() {
return this.ttl;
}
/**
* @return mutation timestamp in microseconds.
* @since 2.1
*/
@Nullable
public Long getTimestamp() {
return this.timestamp;
}
/**
* Builder for {@link WriteOptions}.
*
* @author Mark Paluch
* @author Lukasz Antoniak
* @since 1.5
*/
public static class WriteOptionsBuilder extends QueryOptionsBuilder {
protected Duration ttl = Duration.ofMillis(-1);
protected Long timestamp = null;
protected WriteOptionsBuilder() {}
protected WriteOptionsBuilder(WriteOptions writeOptions) {
super(writeOptions);
this.ttl = writeOptions.ttl;
this.timestamp = writeOptions.timestamp;
}
/* (non-Javadoc)
* @see org.springframework.data.cassandra.core.cql.QueryOptions.QueryOptionsBuilder#consistencyLevel(com.datastax.driver.core.ConsistencyLevel)
*/
@Override
public WriteOptionsBuilder consistencyLevel(com.datastax.driver.core.ConsistencyLevel consistencyLevel) {
super.consistencyLevel(consistencyLevel);
return this;
}
/* (non-Javadoc)
* @see org.springframework.data.cassandra.core.cql.QueryOptions.QueryOptionsBuilder#retryPolicy(org.springframework.data.cassandra.core.cql.RetryPolicy)
*/
@Override
public WriteOptionsBuilder retryPolicy(com.datastax.driver.core.policies.RetryPolicy driverRetryPolicy) {
super.retryPolicy(driverRetryPolicy);
return this;
}
/* (non-Javadoc)
* @see org.springframework.data.cassandra.core.cql.QueryOptions.QueryOptionsBuilder#fetchSize(int)
*/
@Override
public WriteOptionsBuilder fetchSize(int fetchSize) {
super.fetchSize(fetchSize);
return this;
}
/* (non-Javadoc)
* @see org.springframework.data.cassandra.core.cql.QueryOptions.QueryOptionsBuilder#readTimeout(long)
*/
@Override
public WriteOptionsBuilder readTimeout(long readTimeout) {
super.readTimeout(readTimeout);
return this;
}
/* (non-Javadoc)
* @see org.springframework.data.cassandra.core.cql.QueryOptions.QueryOptionsBuilder#readTimeout(long, java.util.concurrent.TimeUnit)
*/
@Override
@Deprecated
public WriteOptionsBuilder readTimeout(long readTimeout, TimeUnit timeUnit) {
super.readTimeout(readTimeout, timeUnit);
return this;
}
/* (non-Javadoc)
* @see org.springframework.data.cassandra.core.cql.QueryOptions.QueryOptionsBuilder#readTimeout(java.time.Duration)
*/
@Override
public WriteOptionsBuilder readTimeout(Duration readTimeout) {
super.readTimeout(readTimeout);
return this;
}
/* (non-Javadoc)
* @see org.springframework.data.cassandra.core.cql.QueryOptions.QueryOptionsBuilder#tracing(boolean)
*/
@Override
public WriteOptionsBuilder tracing(boolean tracing) {
super.tracing(tracing);
return this;
}
/* (non-Javadoc)
* @see org.springframework.data.cassandra.core.cql.QueryOptions.QueryOptionsBuilder#withTracing()
*/
@Override
public WriteOptionsBuilder withTracing() {
super.withTracing();
return this;
}
/**
* Sets the time to live in seconds for write operations.
*
* @param ttl the time to live.
* @return {@code this} {@link WriteOptionsBuilder}
*/
public WriteOptionsBuilder ttl(int ttl) {
Assert.isTrue(ttl >= 0, "TTL must be greater than equal to zero");
this.ttl = Duration.ofSeconds(ttl);
return this;
}
/**
* Sets the time to live in seconds for write operations.
*
* @param ttl the time to live.
* @return {@code this} {@link WriteOptionsBuilder}
* @since 2.0
*/
public WriteOptionsBuilder ttl(Duration ttl) {
Assert.notNull(ttl, "TTL must not be null");
Assert.isTrue(!ttl.isNegative(), "TTL must be greater than equal to zero");
this.ttl = ttl;
return this;
}
/**
* Sets the timestamp of write operations.
*
* @param timestamp mutation timestamp in microseconds.
* @return {@code this} {@link WriteOptionsBuilder}
* @since 2.1
* @see TimeUnit#MICROSECONDS
*/
public WriteOptionsBuilder timestamp(long timestamp) {
Assert.isTrue(timestamp >= 0, "Timestamp must be greater than equal to zero");
this.timestamp = timestamp;
return this;
}
/**
* Sets the timestamp of write operations.
*
* @param timestamp mutation date time.
* @return {@code this} {@link WriteOptionsBuilder}
* @since 2.1
*/
public WriteOptionsBuilder timestamp(Instant timestamp) {
Assert.notNull(timestamp, "Timestamp must not be null");
this.timestamp = TimeUnit.MILLISECONDS.toMicros(timestamp.toEpochMilli());
return this;
}
/**
* Builds a new {@link WriteOptions} with the configured values.
*
* @return a new {@link WriteOptions} with the configured values
*/
public WriteOptions build() {
return new WriteOptions(this.consistencyLevel, this.retryPolicy, this.tracing, this.fetchSize, this.readTimeout,
this.ttl, this.timestamp);
}
}
}