org.springframework.data.cassandra.core.CassandraOperationsExtensions.kt 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 2018-2024 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
import com.datastax.oss.driver.api.core.CqlIdentifier
import com.datastax.oss.driver.api.core.cql.Statement
import org.springframework.data.cassandra.core.query.Query
import org.springframework.data.cassandra.core.query.Update
import org.springframework.data.domain.Slice
import java.util.stream.Stream
import kotlin.reflect.KClass
/**
* Extensions for [CassandraOperations].
*
* @author Mark Paluch
* @since 2.1
*/
/**
* Extension for [CassandraOperations.getTableName] providing a [KClass] based variant.
*/
@Deprecated("Since 2.2, use the reified variant", replaceWith = ReplaceWith("getTableName()"))
fun CassandraOperations.getTableName(entityClass: KClass): CqlIdentifier =
getTableName(entityClass.java)
/**
* Extension for [CassandraOperations.getTableName] leveraging reified type parameters.
*/
inline fun CassandraOperations.getTableName(): CqlIdentifier =
getTableName(T::class.java)
// -------------------------------------------------------------------------
// Methods dealing with static CQL
// -------------------------------------------------------------------------
/**
* Extension for [CassandraOperations.select] providing a [KClass] based variant.
*/
@Deprecated("Since 2.2, use the reified variant", replaceWith = ReplaceWith("select(cql)"))
fun CassandraOperations.select(cql: String, entityClass: KClass): List =
select(cql, entityClass.java)
/**
* Extension for [CassandraOperations.select] leveraging reified type parameters.
*/
inline fun CassandraOperations.select(cql: String): List =
select(cql, T::class.java)
/**
* Extension for [CassandraOperations.stream] providing a [KClass] based variant.
*/
@Deprecated("Since 2.2, use the reified variant", replaceWith = ReplaceWith("stream(cql)"))
fun CassandraOperations.stream(cql: String, entityClass: KClass): Stream =
stream(cql, entityClass.java)
/**
* Extension for [CassandraOperations.stream] leveraging reified type parameters.
*/
inline fun CassandraOperations.stream(cql: String): Stream =
stream(cql, T::class.java)
/**
* Extension for [CassandraOperations.selectOne] providing a [KClass] based variant.
*/
@Deprecated("Since 2.2, use the reified variant", replaceWith = ReplaceWith("selectOne(cql)"))
fun CassandraOperations.selectOne(cql: String, entityClass: KClass): T? =
selectOne(cql, entityClass.java)
/**
* Extension for [CassandraOperations.selectOne] leveraging reified type parameters.
*/
inline fun CassandraOperations.selectOne(cql: String): T? =
selectOne(cql, T::class.java)
// -------------------------------------------------------------------------
// Methods dealing with com.datastax.oss.driver.api.core.cql.Statement
// -------------------------------------------------------------------------
/**
* Extension for [CassandraOperations.select] providing a [KClass] based variant.
*/
@Deprecated("Since 2.2, use the reified variant", replaceWith = ReplaceWith("select(statement)"))
fun CassandraOperations.select(statement: Statement<*>, entityClass: KClass): List =
select(statement, entityClass.java)
/**
* Extension for [CassandraOperations.select] leveraging reified type parameters.
*/
inline fun CassandraOperations.select(statement: Statement<*>): List =
select(statement, T::class.java)
/**
* Extension for [CassandraOperations.slice] providing a [KClass] based variant.
*/
@Deprecated("Since 2.2, use the reified variant", replaceWith = ReplaceWith("slice(statement)"))
fun CassandraOperations.slice(statement: Statement<*>, entityClass: KClass): Slice =
slice(statement, entityClass.java)
/**
* Extension for [CassandraOperations.slice] leveraging reified type parameters.
*/
inline fun CassandraOperations.slice(statement: Statement<*>): Slice =
slice(statement, T::class.java)
/**
* Extension for [CassandraOperations.stream] providing a [KClass] based variant.
*/
@Deprecated("Since 2.2, use the reified variant", replaceWith = ReplaceWith("stream(statement)"))
fun CassandraOperations.stream(statement: Statement<*>, entityClass: KClass): Stream =
stream(statement, entityClass.java)
/**
* Extension for [CassandraOperations.stream] leveraging reified type parameters.
*/
inline fun CassandraOperations.stream(statement: Statement<*>): Stream =
stream(statement, T::class.java)
/**
* Extension for [CassandraOperations.selectOne] providing a [KClass] based variant.
*/
@Deprecated("Since 2.2, use the reified variant", replaceWith = ReplaceWith("selectOne(statement)"))
fun CassandraOperations.selectOne(statement: Statement<*>, entityClass: KClass): T? =
selectOne(statement, entityClass.java)
/**
* Extension for [CassandraOperations.selectOne] leveraging reified type parameters.
*/
inline fun CassandraOperations.selectOne(statement: Statement<*>): T? =
selectOne(statement, T::class.java)
// -------------------------------------------------------------------------
// Methods dealing with org.springframework.data.cassandra.core.query.Query
// -------------------------------------------------------------------------
/**
* Extension for [CassandraOperations.select] providing a [KClass] based variant.
*/
@Deprecated("Since 2.2, use the reified variant", replaceWith = ReplaceWith("select(query)"))
fun CassandraOperations.select(query: Query, entityClass: KClass): List =
select(query, entityClass.java)
/**
* Extension for [CassandraOperations.select] leveraging reified type parameters.
*/
inline fun CassandraOperations.select(query: Query): List =
select(query, T::class.java)
/**
* Extension for [CassandraOperations.slice] providing a [KClass] based variant.
*/
@Deprecated("Since 2.2, use the reified variant", replaceWith = ReplaceWith("slice(query)"))
fun CassandraOperations.slice(query: Query, entityClass: KClass): Slice =
slice(query, entityClass.java)
/**
* Extension for [CassandraOperations.slice] leveraging reified type parameters.
*/
inline fun CassandraOperations.slice(query: Query): Slice =
slice(query, T::class.java)
/**
* Extension for [CassandraOperations.stream] providing a [KClass] based variant.
*/
@Deprecated("Since 2.2, use the reified variant", replaceWith = ReplaceWith("stream(query)"))
fun CassandraOperations.stream(query: Query, entityClass: KClass): Stream =
stream(query, entityClass.java)
/**
* Extension for [CassandraOperations.stream] leveraging reified type parameters.
*/
inline fun CassandraOperations.stream(query: Query): Stream =
stream(query, T::class.java)
/**
* Extension for [CassandraOperations.selectOne] providing a [KClass] based variant.
*/
@Deprecated("Since 2.2, use the reified variant", replaceWith = ReplaceWith("selectOne(query)"))
fun CassandraOperations.selectOne(query: Query, entityClass: KClass): T? =
selectOne(query, entityClass.java)
/**
* Extension for [CassandraOperations.selectOne] leveraging reified type parameters.
*/
inline fun CassandraOperations.selectOne(query: Query): T? =
selectOne(query, T::class.java)
/**
* Extension for [CassandraOperations.update] providing a [KClass] based variant.
*/
@Deprecated("Since 2.2, use the reified variant", replaceWith = ReplaceWith("update(query, update)"))
fun CassandraOperations.update(query: Query, update: Update, entityClass: KClass): Boolean =
update(query, update, entityClass.java)
/**
* Extension for [CassandraOperations.update] leveraging reified type parameters.
*/
inline fun CassandraOperations.update(query: Query, update: Update): Boolean =
update(query, update, T::class.java)
/**
* Extension for [CassandraOperations.delete] providing a [KClass] based variant.
*/
@Deprecated("Since 2.2, use the reified variant", replaceWith = ReplaceWith("delete(query)"))
fun CassandraOperations.delete(query: Query, entityClass: KClass): Boolean =
delete(query, entityClass.java)
/**
* Extension for [CassandraOperations.delete] leveraging reified type parameters.
*/
@Suppress("EXTENSION_SHADOWED_BY_MEMBER")
inline fun CassandraOperations.delete(query: Query): Boolean =
delete(query, T::class.java)
// -------------------------------------------------------------------------
// Methods dealing with entities
// -------------------------------------------------------------------------
/**
* Extension for [CassandraOperations.count] providing a [KClass] based variant.
*/
@Deprecated("Since 2.2, use the reified variant", replaceWith = ReplaceWith("count()"))
fun CassandraOperations.count(entityClass: KClass): Long =
count(entityClass.java)
/**
* Extension for [CassandraOperations.count] leveraging reified type parameters.
*/
inline fun CassandraOperations.count(): Long =
count(T::class.java)
/**
* Extension for [CassandraOperations.count] providing a [KClass] based variant.
*/
@Deprecated("Since 2.2, use the reified variant", replaceWith = ReplaceWith("count(query)"))
fun CassandraOperations.count(query: Query, entityClass: KClass): Long =
count(query, entityClass.java)
/**
* Extension for [CassandraOperations.count] leveraging reified type parameters.
*/
inline fun CassandraOperations.count(query: Query): Long =
count(query, T::class.java)
/**
* Extension for [CassandraOperations.exists] providing a [KClass] based variant.
*/
@Deprecated("Since 2.2, use the reified variant", replaceWith = ReplaceWith("exists(id)"))
fun CassandraOperations.exists(id: Any, entityClass: KClass): Boolean =
exists(id, entityClass.java)
/**
* Extension for [CassandraOperations.exists] leveraging reified type parameters.
*/
inline fun CassandraOperations.exists(id: Any): Boolean =
exists(id, T::class.java)
/**
* Extension for [CassandraOperations.count] providing a [KClass] based variant.
*/
@Deprecated("Since 2.2, use the reified variant", replaceWith = ReplaceWith("exists(query)"))
fun CassandraOperations.exists(query: Query, entityClass: KClass): Boolean =
exists(query, entityClass.java)
/**
* Extension for [CassandraOperations.count] leveraging reified type parameters.
*/
inline fun CassandraOperations.exists(query: Query): Boolean =
exists(query, T::class.java)
/**
* Extension for [CassandraOperations.selectOneById] providing a [KClass] based variant.
*/
@Deprecated("Since 2.2, use the reified variant", replaceWith = ReplaceWith("selectOneById(id)"))
fun CassandraOperations.selectOneById(id: Any, entityClass: KClass): T? =
selectOneById(id, entityClass.java)
/**
* Extension for [CassandraOperations.selectOneById] leveraging reified type parameters.
*/
inline fun CassandraOperations.selectOneById(id: Any): T? =
selectOneById(id, T::class.java)
/**
* Extension for [CassandraOperations.deleteById] providing a [KClass] based variant.
*/
@Deprecated("Since 2.2, use the reified variant", replaceWith = ReplaceWith("deleteById(id)"))
fun CassandraOperations.deleteById(id: Any, entityClass: KClass): Boolean =
deleteById(id, entityClass.java)
/**
* Extension for [CassandraOperations.deleteById] leveraging reified type parameters.
*/
inline fun CassandraOperations.deleteById(id: Any): Boolean =
deleteById(id, T::class.java)
/**
* Extension for [CassandraOperations.truncate] providing a [KClass] based variant.
*/
@Deprecated("Since 2.2, use the reified variant", replaceWith = ReplaceWith("truncate()"))
fun CassandraOperations.truncate(entityClass: KClass): Unit =
truncate(entityClass.java)
/**
* Extension for [CassandraOperations.truncate] leveraging reified type parameters.
*/
inline fun CassandraOperations.truncate(): Unit =
truncate(T::class.java)