deprecate legacy finds; introduce new find to replace them

This commit is contained in:
Stefano Lottini committed 2026-09-28 10:30:21 +02:00
1 parent 3c317a4dbb
commit 66f628905c
8 files changed
+127 -19

No files matched your search

@@ -42,6 +42,10 @@ public class DataApiOpMapper implements OpMapper<DataApiBaseOp,DataApiSpace> {
// db-admin ops:
// in-database ops:
// in-collection ops:
DEPRECATED_OP_TYPES.put(DataApiOpType.find, DataApiOpType.collection_find);
DEPRECATED_OP_TYPES.put(DataApiOpType.find_vector, DataApiOpType.collection_find);
DEPRECATED_OP_TYPES.put(DataApiOpType.find_vector_filter, DataApiOpType.collection_find);
DEPRECATED_OP_TYPES.put(DataApiOpType.find_by_id, null);
DEPRECATED_OP_TYPES.put(DataApiOpType.find_distinct, null);
DEPRECATED_OP_TYPES.put(DataApiOpType.find_one, DataApiOpType.collection_find_one);
DEPRECATED_OP_TYPES.put(DataApiOpType.find_one_and_update, DataApiOpType.collection_find_one_and_update);
@@ -122,6 +126,7 @@ public class DataApiOpMapper implements OpMapper<DataApiBaseOp,DataApiSpace> {
case find_one_and_update -> new DataApiCollectionLegacyFindOneAndUpdateOpDispenser(adapter, op, typeAndTarget.targetFunction);
// NEW-STYLE OPS
case collection_find -> new DataApiCollectionFindOpDispenser(adapter, op, typeAndTarget.targetFunction);
case collection_find_one -> new DataApiCollectionFindOneOpDispenser(adapter, op, typeAndTarget.targetFunction);
case collection_find_one_and_update -> new DataApiCollectionFindOneAndUpdateOpDispenser(adapter, op, typeAndTarget.targetFunction);
};
@@ -28,6 +28,7 @@ import io.nosqlbench.adapters.api.templating.ParsedOp;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import java.util.Optional;
import java.util.function.LongFunction;
public class DataApiCollectionFindOneOpDispenser extends DataApiOpDispenser {
@@ -62,12 +63,9 @@ public class DataApiCollectionFindOneOpDispenser extends DataApiOpDispenser {
if (projection != null) {
options = options.projection(projection);
}
Boolean includeSimilarity = getIncludeSimilarityFromOp(op, l);
if (includeSimilarity != null) {
options.includeSimilarity(includeSimilarity);
} else {
// defaulting to true
options.includeSimilarity(true);
Optional<Boolean> includeSimilarity = getIncludeSimilarityFromOp(op, l);
if (includeSimilarity.isPresent()) {
options.includeSimilarity(includeSimilarity.get());
}
return options;
}
@@ -0,0 +1,85 @@
/*
* Copyright (c) nosqlbench
*
* 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 io.nosqlbench.adapter.dataapi.opdispensers;
import com.datastax.astra.client.databases.Database;
import com.datastax.astra.client.core.query.Filter;
import com.datastax.astra.client.collections.commands.options.CollectionFindOptions;
import com.datastax.astra.client.core.query.Projection;
import com.datastax.astra.client.core.query.Sort;
import io.nosqlbench.adapter.dataapi.DataApiDriverAdapter;
import io.nosqlbench.adapter.dataapi.ops.DataApiBaseOp;
import io.nosqlbench.adapter.dataapi.ops.DataApiCollectionFindOp;
import io.nosqlbench.adapters.api.templating.ParsedOp;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import java.util.Optional;
import java.util.function.LongFunction;
public class DataApiCollectionFindOpDispenser extends DataApiOpDispenser {
private static final Logger logger = LogManager.getLogger(DataApiCollectionFindOpDispenser.class);
private final LongFunction<DataApiCollectionFindOp> opFunction;
public DataApiCollectionFindOpDispenser(DataApiDriverAdapter adapter, ParsedOp op, LongFunction<String> targetFunction) {
super(adapter, op, targetFunction);
this.opFunction = createOpFunction(op);
}
private LongFunction<DataApiCollectionFindOp> createOpFunction(ParsedOp op) {
return (l) -> {
Database db = spaceFunction.apply(l).getDatabase();
Filter filter = getFilterFromOp(op, l);
CollectionFindOptions options = getCollectionFindOptions(op, l);
return new DataApiCollectionFindOp(
db,
db.getCollection(targetFunction.apply(l)),
filter,
options
);
};
}
private CollectionFindOptions getCollectionFindOptions(ParsedOp op, long l) {
CollectionFindOptions options = new CollectionFindOptions();
Sort sort = getSortFromOp(op, l);
if (sort != null) {
options = options.sort(sort);
}
Projection[] projection = getProjectionFromOp(op, l);
if (projection != null) {
options = options.projection(projection);
}
Optional<Integer> limit = getLimitFromOp(op, l);
if (limit.isPresent()) {
options = options.limit(limit.get());
}
Optional<Integer> skip = getSkipFromOp(op, l);
if (skip.isPresent()) {
options = options.skip(skip.get());
}
Optional<Boolean> includeSimilarity = getIncludeSimilarityFromOp(op, l);
if (includeSimilarity.isPresent()) {
options.includeSimilarity(includeSimilarity.get());
}
return options;
}
@Override
public DataApiBaseOp getOp(long cycle) {
return opFunction.apply(cycle);
}
}
@@ -28,6 +28,7 @@ import io.nosqlbench.adapters.api.templating.ParsedOp;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import java.util.Optional;
import java.util.function.LongFunction;
public class DataApiCollectionLegacyFindOneOpDispenser extends DataApiOpDispenser {
@@ -62,11 +63,11 @@ public class DataApiCollectionLegacyFindOneOpDispenser extends DataApiOpDispense
if (projection != null) {
options = options.projection(projection);
}
Boolean includeSimilarity = getIncludeSimilarityFromOp(op, l);
if (includeSimilarity != null) {
options.includeSimilarity(includeSimilarity);
Optional<Boolean> includeSimilarity = getIncludeSimilarityFromOp(op, l);
if (includeSimilarity.isPresent()) {
options.includeSimilarity(includeSimilarity.get());
} else {
// defaulting to true
// defaulting to true (backward-compatibility)
options.includeSimilarity(true);
}
return options;
@@ -23,7 +23,7 @@ import com.datastax.astra.client.core.query.Projection;
import com.datastax.astra.client.core.query.Sort;
import io.nosqlbench.adapter.dataapi.DataApiDriverAdapter;
import io.nosqlbench.adapter.dataapi.ops.DataApiBaseOp;
import io.nosqlbench.adapter.dataapi.ops.DataApiCollectionLegacyFindOp;
import io.nosqlbench.adapter.dataapi.ops.DataApiCollectionFindOp;
import io.nosqlbench.adapters.api.templating.ParsedOp;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
@@ -33,18 +33,18 @@ import java.util.function.LongFunction;
public class DataApiCollectionLegacyFindOpDispenser extends DataApiOpDispenser {
private static final Logger logger = LogManager.getLogger(DataApiCollectionLegacyFindOpDispenser.class);
private final LongFunction<DataApiCollectionLegacyFindOp> opFunction;
private final LongFunction<DataApiCollectionFindOp> opFunction;
public DataApiCollectionLegacyFindOpDispenser(DataApiDriverAdapter adapter, ParsedOp op, LongFunction<String> targetFunction) {
super(adapter, op, targetFunction);
this.opFunction = createOpFunction(op);
}
private LongFunction<DataApiCollectionLegacyFindOp> createOpFunction(ParsedOp op) {
private LongFunction<DataApiCollectionFindOp> createOpFunction(ParsedOp op) {
return (l) -> {
Database db = spaceFunction.apply(l).getDatabase();
Filter filter = getLegacyFilterFromOp(op, l);
CollectionFindOptions options = getCollectionFindOptions(op, l);
return new DataApiCollectionLegacyFindOp(
return new DataApiCollectionFindOp(
db,
db.getCollection(targetFunction.apply(l)),
filter,
@@ -207,13 +207,31 @@ public abstract class DataApiOpDispenser extends BaseOpDispenser<DataApiBaseOp,
return null;
}
protected Boolean getIncludeSimilarityFromOp(ParsedOp op, long l) {
protected Optional<Boolean> getIncludeSimilarityFromOp(ParsedOp op, long l) {
Optional<LongFunction<Boolean>> includeSimFunction = op.getAsOptionalFunction("include_similarity", Boolean.class);
if (includeSimFunction.isPresent()) {
LongFunction<Boolean> uf = includeSimFunction.get();
return uf.apply(l);
return Optional.of(uf.apply(l));
}
return null;
return Optional.empty();
}
protected Optional<Integer> getLimitFromOp(ParsedOp op, long l) {
Optional<LongFunction<Integer>> limitFunction = op.getAsOptionalFunction("limit", Integer.class);
if (limitFunction.isPresent()) {
LongFunction<Integer> lf = limitFunction.get();
return Optional.of(lf.apply(l));
}
return Optional.empty();
}
protected Optional<Integer> getSkipFromOp(ParsedOp op, long l) {
Optional<LongFunction<Integer>> skipFunction = op.getAsOptionalFunction("skip", Integer.class);
if (skipFunction.isPresent()) {
LongFunction<Integer> sf = skipFunction.get();
return Optional.of(sf.apply(l));
}
return Optional.empty();
}
@SuppressWarnings("unchecked")
@@ -25,12 +25,12 @@ import com.datastax.astra.client.collections.commands.cursor.CollectionFindCurso
import java.util.List;
public class DataApiCollectionLegacyFindOp extends DataApiBaseOp {
public class DataApiCollectionFindOp extends DataApiBaseOp {
private final Collection<Document> collection;
private final Filter filter;
private final CollectionFindOptions options;
public DataApiCollectionLegacyFindOp(Database db, Collection<Document> collection, Filter filter, CollectionFindOptions options) {
public DataApiCollectionFindOp(Database db, Collection<Document> collection, Filter filter, CollectionFindOptions options) {
super(db);
this.collection = collection;
this.filter = filter;
@@ -67,6 +67,7 @@ public enum DataApiOpType {
// db-admin ops:
// in-database ops:
// in-collection ops:
collection_find,
collection_find_one,
collection_find_one_and_update,
}