kotlin-client/com.couchbase.client.kotlin.query/QueryParameters/Companion/named

named

fun named(paramSetterBlock: NamedParametersBuilder.() -> Unit): QueryParameters

Values to plug into named placeholders in the query statement.

parameters = QueryParameters.named {
    param("type", "airline")
    param("limit", 3)
}
Content copied to clipboard

Samples

import com.couchbase.client.kotlin.Cluster
import com.couchbase.client.kotlin.query.QueryMetadata
import com.couchbase.client.kotlin.query.QueryParameters
import com.couchbase.client.kotlin.query.QueryResult
import com.couchbase.client.kotlin.query.execute
import kotlinx.serialization.Serializable

fun main() { 
   //sampleStart 
   // Query with named parameters
val result: QueryResult = cluster
    .query(
        "select * from `travel-sample` where type = @type limit @limit",
        parameters = QueryParameters.named {
            param("type", "airline")
            param("limit", 3)
        }
    )
    .execute()

result.rows.forEach { println(it) } 
   //sampleEnd
}
fun named(values: Map<String, Any?>): QueryParameters
fun named(vararg values: Pair<String, Any?>): QueryParameters

Deprecated

Not compatible with JsonSerializer implementations that require type information, like kotlinx.serialization. Please use the overload that takes a parameter builder lambda.